Merge tag 'arm-soc-5.14' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[platform/kernel/linux-rpi.git] / drivers / md / bcache / request.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Main bcache entry point - handle a read or a write request and decide what to
4  * do with it; the make_request functions are called by the block layer.
5  *
6  * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
7  * Copyright 2012 Google, Inc.
8  */
9
10 #include "bcache.h"
11 #include "btree.h"
12 #include "debug.h"
13 #include "request.h"
14 #include "writeback.h"
15
16 #include <linux/module.h>
17 #include <linux/hash.h>
18 #include <linux/random.h>
19 #include <linux/backing-dev.h>
20
21 #include <trace/events/bcache.h>
22
23 #define CUTOFF_CACHE_ADD        95
24 #define CUTOFF_CACHE_READA      90
25
26 struct kmem_cache *bch_search_cache;
27
28 static void bch_data_insert_start(struct closure *cl);
29
30 static unsigned int cache_mode(struct cached_dev *dc)
31 {
32         return BDEV_CACHE_MODE(&dc->sb);
33 }
34
35 static bool verify(struct cached_dev *dc)
36 {
37         return dc->verify;
38 }
39
40 static void bio_csum(struct bio *bio, struct bkey *k)
41 {
42         struct bio_vec bv;
43         struct bvec_iter iter;
44         uint64_t csum = 0;
45
46         bio_for_each_segment(bv, bio, iter) {
47                 void *d = kmap(bv.bv_page) + bv.bv_offset;
48
49                 csum = bch_crc64_update(csum, d, bv.bv_len);
50                 kunmap(bv.bv_page);
51         }
52
53         k->ptr[KEY_PTRS(k)] = csum & (~0ULL >> 1);
54 }
55
56 /* Insert data into cache */
57
58 static void bch_data_insert_keys(struct closure *cl)
59 {
60         struct data_insert_op *op = container_of(cl, struct data_insert_op, cl);
61         atomic_t *journal_ref = NULL;
62         struct bkey *replace_key = op->replace ? &op->replace_key : NULL;
63         int ret;
64
65         if (!op->replace)
66                 journal_ref = bch_journal(op->c, &op->insert_keys,
67                                           op->flush_journal ? cl : NULL);
68
69         ret = bch_btree_insert(op->c, &op->insert_keys,
70                                journal_ref, replace_key);
71         if (ret == -ESRCH) {
72                 op->replace_collision = true;
73         } else if (ret) {
74                 op->status              = BLK_STS_RESOURCE;
75                 op->insert_data_done    = true;
76         }
77
78         if (journal_ref)
79                 atomic_dec_bug(journal_ref);
80
81         if (!op->insert_data_done) {
82                 continue_at(cl, bch_data_insert_start, op->wq);
83                 return;
84         }
85
86         bch_keylist_free(&op->insert_keys);
87         closure_return(cl);
88 }
89
90 static int bch_keylist_realloc(struct keylist *l, unsigned int u64s,
91                                struct cache_set *c)
92 {
93         size_t oldsize = bch_keylist_nkeys(l);
94         size_t newsize = oldsize + u64s;
95
96         /*
97          * The journalling code doesn't handle the case where the keys to insert
98          * is bigger than an empty write: If we just return -ENOMEM here,
99          * bch_data_insert_keys() will insert the keys created so far
100          * and finish the rest when the keylist is empty.
101          */
102         if (newsize * sizeof(uint64_t) > block_bytes(c->cache) - sizeof(struct jset))
103                 return -ENOMEM;
104
105         return __bch_keylist_realloc(l, u64s);
106 }
107
108 static void bch_data_invalidate(struct closure *cl)
109 {
110         struct data_insert_op *op = container_of(cl, struct data_insert_op, cl);
111         struct bio *bio = op->bio;
112
113         pr_debug("invalidating %i sectors from %llu\n",
114                  bio_sectors(bio), (uint64_t) bio->bi_iter.bi_sector);
115
116         while (bio_sectors(bio)) {
117                 unsigned int sectors = min(bio_sectors(bio),
118                                        1U << (KEY_SIZE_BITS - 1));
119
120                 if (bch_keylist_realloc(&op->insert_keys, 2, op->c))
121                         goto out;
122
123                 bio->bi_iter.bi_sector  += sectors;
124                 bio->bi_iter.bi_size    -= sectors << 9;
125
126                 bch_keylist_add(&op->insert_keys,
127                                 &KEY(op->inode,
128                                      bio->bi_iter.bi_sector,
129                                      sectors));
130         }
131
132         op->insert_data_done = true;
133         /* get in bch_data_insert() */
134         bio_put(bio);
135 out:
136         continue_at(cl, bch_data_insert_keys, op->wq);
137 }
138
139 static void bch_data_insert_error(struct closure *cl)
140 {
141         struct data_insert_op *op = container_of(cl, struct data_insert_op, cl);
142
143         /*
144          * Our data write just errored, which means we've got a bunch of keys to
145          * insert that point to data that wasn't successfully written.
146          *
147          * We don't have to insert those keys but we still have to invalidate
148          * that region of the cache - so, if we just strip off all the pointers
149          * from the keys we'll accomplish just that.
150          */
151
152         struct bkey *src = op->insert_keys.keys, *dst = op->insert_keys.keys;
153
154         while (src != op->insert_keys.top) {
155                 struct bkey *n = bkey_next(src);
156
157                 SET_KEY_PTRS(src, 0);
158                 memmove(dst, src, bkey_bytes(src));
159
160                 dst = bkey_next(dst);
161                 src = n;
162         }
163
164         op->insert_keys.top = dst;
165
166         bch_data_insert_keys(cl);
167 }
168
169 static void bch_data_insert_endio(struct bio *bio)
170 {
171         struct closure *cl = bio->bi_private;
172         struct data_insert_op *op = container_of(cl, struct data_insert_op, cl);
173
174         if (bio->bi_status) {
175                 /* TODO: We could try to recover from this. */
176                 if (op->writeback)
177                         op->status = bio->bi_status;
178                 else if (!op->replace)
179                         set_closure_fn(cl, bch_data_insert_error, op->wq);
180                 else
181                         set_closure_fn(cl, NULL, NULL);
182         }
183
184         bch_bbio_endio(op->c, bio, bio->bi_status, "writing data to cache");
185 }
186
187 static void bch_data_insert_start(struct closure *cl)
188 {
189         struct data_insert_op *op = container_of(cl, struct data_insert_op, cl);
190         struct bio *bio = op->bio, *n;
191
192         if (op->bypass)
193                 return bch_data_invalidate(cl);
194
195         if (atomic_sub_return(bio_sectors(bio), &op->c->sectors_to_gc) < 0)
196                 wake_up_gc(op->c);
197
198         /*
199          * Journal writes are marked REQ_PREFLUSH; if the original write was a
200          * flush, it'll wait on the journal write.
201          */
202         bio->bi_opf &= ~(REQ_PREFLUSH|REQ_FUA);
203
204         do {
205                 unsigned int i;
206                 struct bkey *k;
207                 struct bio_set *split = &op->c->bio_split;
208
209                 /* 1 for the device pointer and 1 for the chksum */
210                 if (bch_keylist_realloc(&op->insert_keys,
211                                         3 + (op->csum ? 1 : 0),
212                                         op->c)) {
213                         continue_at(cl, bch_data_insert_keys, op->wq);
214                         return;
215                 }
216
217                 k = op->insert_keys.top;
218                 bkey_init(k);
219                 SET_KEY_INODE(k, op->inode);
220                 SET_KEY_OFFSET(k, bio->bi_iter.bi_sector);
221
222                 if (!bch_alloc_sectors(op->c, k, bio_sectors(bio),
223                                        op->write_point, op->write_prio,
224                                        op->writeback))
225                         goto err;
226
227                 n = bio_next_split(bio, KEY_SIZE(k), GFP_NOIO, split);
228
229                 n->bi_end_io    = bch_data_insert_endio;
230                 n->bi_private   = cl;
231
232                 if (op->writeback) {
233                         SET_KEY_DIRTY(k, true);
234
235                         for (i = 0; i < KEY_PTRS(k); i++)
236                                 SET_GC_MARK(PTR_BUCKET(op->c, k, i),
237                                             GC_MARK_DIRTY);
238                 }
239
240                 SET_KEY_CSUM(k, op->csum);
241                 if (KEY_CSUM(k))
242                         bio_csum(n, k);
243
244                 trace_bcache_cache_insert(k);
245                 bch_keylist_push(&op->insert_keys);
246
247                 bio_set_op_attrs(n, REQ_OP_WRITE, 0);
248                 bch_submit_bbio(n, op->c, k, 0);
249         } while (n != bio);
250
251         op->insert_data_done = true;
252         continue_at(cl, bch_data_insert_keys, op->wq);
253         return;
254 err:
255         /* bch_alloc_sectors() blocks if s->writeback = true */
256         BUG_ON(op->writeback);
257
258         /*
259          * But if it's not a writeback write we'd rather just bail out if
260          * there aren't any buckets ready to write to - it might take awhile and
261          * we might be starving btree writes for gc or something.
262          */
263
264         if (!op->replace) {
265                 /*
266                  * Writethrough write: We can't complete the write until we've
267                  * updated the index. But we don't want to delay the write while
268                  * we wait for buckets to be freed up, so just invalidate the
269                  * rest of the write.
270                  */
271                 op->bypass = true;
272                 return bch_data_invalidate(cl);
273         } else {
274                 /*
275                  * From a cache miss, we can just insert the keys for the data
276                  * we have written or bail out if we didn't do anything.
277                  */
278                 op->insert_data_done = true;
279                 bio_put(bio);
280
281                 if (!bch_keylist_empty(&op->insert_keys))
282                         continue_at(cl, bch_data_insert_keys, op->wq);
283                 else
284                         closure_return(cl);
285         }
286 }
287
288 /**
289  * bch_data_insert - stick some data in the cache
290  * @cl: closure pointer.
291  *
292  * This is the starting point for any data to end up in a cache device; it could
293  * be from a normal write, or a writeback write, or a write to a flash only
294  * volume - it's also used by the moving garbage collector to compact data in
295  * mostly empty buckets.
296  *
297  * It first writes the data to the cache, creating a list of keys to be inserted
298  * (if the data had to be fragmented there will be multiple keys); after the
299  * data is written it calls bch_journal, and after the keys have been added to
300  * the next journal write they're inserted into the btree.
301  *
302  * It inserts the data in op->bio; bi_sector is used for the key offset,
303  * and op->inode is used for the key inode.
304  *
305  * If op->bypass is true, instead of inserting the data it invalidates the
306  * region of the cache represented by op->bio and op->inode.
307  */
308 void bch_data_insert(struct closure *cl)
309 {
310         struct data_insert_op *op = container_of(cl, struct data_insert_op, cl);
311
312         trace_bcache_write(op->c, op->inode, op->bio,
313                            op->writeback, op->bypass);
314
315         bch_keylist_init(&op->insert_keys);
316         bio_get(op->bio);
317         bch_data_insert_start(cl);
318 }
319
320 /*
321  * Congested?  Return 0 (not congested) or the limit (in sectors)
322  * beyond which we should bypass the cache due to congestion.
323  */
324 unsigned int bch_get_congested(const struct cache_set *c)
325 {
326         int i;
327
328         if (!c->congested_read_threshold_us &&
329             !c->congested_write_threshold_us)
330                 return 0;
331
332         i = (local_clock_us() - c->congested_last_us) / 1024;
333         if (i < 0)
334                 return 0;
335
336         i += atomic_read(&c->congested);
337         if (i >= 0)
338                 return 0;
339
340         i += CONGESTED_MAX;
341
342         if (i > 0)
343                 i = fract_exp_two(i, 6);
344
345         i -= hweight32(get_random_u32());
346
347         return i > 0 ? i : 1;
348 }
349
350 static void add_sequential(struct task_struct *t)
351 {
352         ewma_add(t->sequential_io_avg,
353                  t->sequential_io, 8, 0);
354
355         t->sequential_io = 0;
356 }
357
358 static struct hlist_head *iohash(struct cached_dev *dc, uint64_t k)
359 {
360         return &dc->io_hash[hash_64(k, RECENT_IO_BITS)];
361 }
362
363 static bool check_should_bypass(struct cached_dev *dc, struct bio *bio)
364 {
365         struct cache_set *c = dc->disk.c;
366         unsigned int mode = cache_mode(dc);
367         unsigned int sectors, congested;
368         struct task_struct *task = current;
369         struct io *i;
370
371         if (test_bit(BCACHE_DEV_DETACHING, &dc->disk.flags) ||
372             c->gc_stats.in_use > CUTOFF_CACHE_ADD ||
373             (bio_op(bio) == REQ_OP_DISCARD))
374                 goto skip;
375
376         if (mode == CACHE_MODE_NONE ||
377             (mode == CACHE_MODE_WRITEAROUND &&
378              op_is_write(bio_op(bio))))
379                 goto skip;
380
381         /*
382          * If the bio is for read-ahead or background IO, bypass it or
383          * not depends on the following situations,
384          * - If the IO is for meta data, always cache it and no bypass
385          * - If the IO is not meta data, check dc->cache_reada_policy,
386          *      BCH_CACHE_READA_ALL: cache it and not bypass
387          *      BCH_CACHE_READA_META_ONLY: not cache it and bypass
388          * That is, read-ahead request for metadata always get cached
389          * (eg, for gfs2 or xfs).
390          */
391         if ((bio->bi_opf & (REQ_RAHEAD|REQ_BACKGROUND))) {
392                 if (!(bio->bi_opf & (REQ_META|REQ_PRIO)) &&
393                     (dc->cache_readahead_policy != BCH_CACHE_READA_ALL))
394                         goto skip;
395         }
396
397         if (bio->bi_iter.bi_sector & (c->cache->sb.block_size - 1) ||
398             bio_sectors(bio) & (c->cache->sb.block_size - 1)) {
399                 pr_debug("skipping unaligned io\n");
400                 goto skip;
401         }
402
403         if (bypass_torture_test(dc)) {
404                 if ((get_random_int() & 3) == 3)
405                         goto skip;
406                 else
407                         goto rescale;
408         }
409
410         congested = bch_get_congested(c);
411         if (!congested && !dc->sequential_cutoff)
412                 goto rescale;
413
414         spin_lock(&dc->io_lock);
415
416         hlist_for_each_entry(i, iohash(dc, bio->bi_iter.bi_sector), hash)
417                 if (i->last == bio->bi_iter.bi_sector &&
418                     time_before(jiffies, i->jiffies))
419                         goto found;
420
421         i = list_first_entry(&dc->io_lru, struct io, lru);
422
423         add_sequential(task);
424         i->sequential = 0;
425 found:
426         if (i->sequential + bio->bi_iter.bi_size > i->sequential)
427                 i->sequential   += bio->bi_iter.bi_size;
428
429         i->last                  = bio_end_sector(bio);
430         i->jiffies               = jiffies + msecs_to_jiffies(5000);
431         task->sequential_io      = i->sequential;
432
433         hlist_del(&i->hash);
434         hlist_add_head(&i->hash, iohash(dc, i->last));
435         list_move_tail(&i->lru, &dc->io_lru);
436
437         spin_unlock(&dc->io_lock);
438
439         sectors = max(task->sequential_io,
440                       task->sequential_io_avg) >> 9;
441
442         if (dc->sequential_cutoff &&
443             sectors >= dc->sequential_cutoff >> 9) {
444                 trace_bcache_bypass_sequential(bio);
445                 goto skip;
446         }
447
448         if (congested && sectors >= congested) {
449                 trace_bcache_bypass_congested(bio);
450                 goto skip;
451         }
452
453 rescale:
454         bch_rescale_priorities(c, bio_sectors(bio));
455         return false;
456 skip:
457         bch_mark_sectors_bypassed(c, dc, bio_sectors(bio));
458         return true;
459 }
460
461 /* Cache lookup */
462
463 struct search {
464         /* Stack frame for bio_complete */
465         struct closure          cl;
466
467         struct bbio             bio;
468         struct bio              *orig_bio;
469         struct bio              *cache_miss;
470         struct bcache_device    *d;
471
472         unsigned int            insert_bio_sectors;
473         unsigned int            recoverable:1;
474         unsigned int            write:1;
475         unsigned int            read_dirty_data:1;
476         unsigned int            cache_missed:1;
477
478         struct block_device     *orig_bdev;
479         unsigned long           start_time;
480
481         struct btree_op         op;
482         struct data_insert_op   iop;
483 };
484
485 static void bch_cache_read_endio(struct bio *bio)
486 {
487         struct bbio *b = container_of(bio, struct bbio, bio);
488         struct closure *cl = bio->bi_private;
489         struct search *s = container_of(cl, struct search, cl);
490
491         /*
492          * If the bucket was reused while our bio was in flight, we might have
493          * read the wrong data. Set s->error but not error so it doesn't get
494          * counted against the cache device, but we'll still reread the data
495          * from the backing device.
496          */
497
498         if (bio->bi_status)
499                 s->iop.status = bio->bi_status;
500         else if (!KEY_DIRTY(&b->key) &&
501                  ptr_stale(s->iop.c, &b->key, 0)) {
502                 atomic_long_inc(&s->iop.c->cache_read_races);
503                 s->iop.status = BLK_STS_IOERR;
504         }
505
506         bch_bbio_endio(s->iop.c, bio, bio->bi_status, "reading from cache");
507 }
508
509 /*
510  * Read from a single key, handling the initial cache miss if the key starts in
511  * the middle of the bio
512  */
513 static int cache_lookup_fn(struct btree_op *op, struct btree *b, struct bkey *k)
514 {
515         struct search *s = container_of(op, struct search, op);
516         struct bio *n, *bio = &s->bio.bio;
517         struct bkey *bio_key;
518         unsigned int ptr;
519
520         if (bkey_cmp(k, &KEY(s->iop.inode, bio->bi_iter.bi_sector, 0)) <= 0)
521                 return MAP_CONTINUE;
522
523         if (KEY_INODE(k) != s->iop.inode ||
524             KEY_START(k) > bio->bi_iter.bi_sector) {
525                 unsigned int bio_sectors = bio_sectors(bio);
526                 unsigned int sectors = KEY_INODE(k) == s->iop.inode
527                         ? min_t(uint64_t, INT_MAX,
528                                 KEY_START(k) - bio->bi_iter.bi_sector)
529                         : INT_MAX;
530                 int ret = s->d->cache_miss(b, s, bio, sectors);
531
532                 if (ret != MAP_CONTINUE)
533                         return ret;
534
535                 /* if this was a complete miss we shouldn't get here */
536                 BUG_ON(bio_sectors <= sectors);
537         }
538
539         if (!KEY_SIZE(k))
540                 return MAP_CONTINUE;
541
542         /* XXX: figure out best pointer - for multiple cache devices */
543         ptr = 0;
544
545         PTR_BUCKET(b->c, k, ptr)->prio = INITIAL_PRIO;
546
547         if (KEY_DIRTY(k))
548                 s->read_dirty_data = true;
549
550         n = bio_next_split(bio, min_t(uint64_t, INT_MAX,
551                                       KEY_OFFSET(k) - bio->bi_iter.bi_sector),
552                            GFP_NOIO, &s->d->bio_split);
553
554         bio_key = &container_of(n, struct bbio, bio)->key;
555         bch_bkey_copy_single_ptr(bio_key, k, ptr);
556
557         bch_cut_front(&KEY(s->iop.inode, n->bi_iter.bi_sector, 0), bio_key);
558         bch_cut_back(&KEY(s->iop.inode, bio_end_sector(n), 0), bio_key);
559
560         n->bi_end_io    = bch_cache_read_endio;
561         n->bi_private   = &s->cl;
562
563         /*
564          * The bucket we're reading from might be reused while our bio
565          * is in flight, and we could then end up reading the wrong
566          * data.
567          *
568          * We guard against this by checking (in cache_read_endio()) if
569          * the pointer is stale again; if so, we treat it as an error
570          * and reread from the backing device (but we don't pass that
571          * error up anywhere).
572          */
573
574         __bch_submit_bbio(n, b->c);
575         return n == bio ? MAP_DONE : MAP_CONTINUE;
576 }
577
578 static void cache_lookup(struct closure *cl)
579 {
580         struct search *s = container_of(cl, struct search, iop.cl);
581         struct bio *bio = &s->bio.bio;
582         struct cached_dev *dc;
583         int ret;
584
585         bch_btree_op_init(&s->op, -1);
586
587         ret = bch_btree_map_keys(&s->op, s->iop.c,
588                                  &KEY(s->iop.inode, bio->bi_iter.bi_sector, 0),
589                                  cache_lookup_fn, MAP_END_KEY);
590         if (ret == -EAGAIN) {
591                 continue_at(cl, cache_lookup, bcache_wq);
592                 return;
593         }
594
595         /*
596          * We might meet err when searching the btree, If that happens, we will
597          * get negative ret, in this scenario we should not recover data from
598          * backing device (when cache device is dirty) because we don't know
599          * whether bkeys the read request covered are all clean.
600          *
601          * And after that happened, s->iop.status is still its initial value
602          * before we submit s->bio.bio
603          */
604         if (ret < 0) {
605                 BUG_ON(ret == -EINTR);
606                 if (s->d && s->d->c &&
607                                 !UUID_FLASH_ONLY(&s->d->c->uuids[s->d->id])) {
608                         dc = container_of(s->d, struct cached_dev, disk);
609                         if (dc && atomic_read(&dc->has_dirty))
610                                 s->recoverable = false;
611                 }
612                 if (!s->iop.status)
613                         s->iop.status = BLK_STS_IOERR;
614         }
615
616         closure_return(cl);
617 }
618
619 /* Common code for the make_request functions */
620
621 static void request_endio(struct bio *bio)
622 {
623         struct closure *cl = bio->bi_private;
624
625         if (bio->bi_status) {
626                 struct search *s = container_of(cl, struct search, cl);
627
628                 s->iop.status = bio->bi_status;
629                 /* Only cache read errors are recoverable */
630                 s->recoverable = false;
631         }
632
633         bio_put(bio);
634         closure_put(cl);
635 }
636
637 static void backing_request_endio(struct bio *bio)
638 {
639         struct closure *cl = bio->bi_private;
640
641         if (bio->bi_status) {
642                 struct search *s = container_of(cl, struct search, cl);
643                 struct cached_dev *dc = container_of(s->d,
644                                                      struct cached_dev, disk);
645                 /*
646                  * If a bio has REQ_PREFLUSH for writeback mode, it is
647                  * speically assembled in cached_dev_write() for a non-zero
648                  * write request which has REQ_PREFLUSH. we don't set
649                  * s->iop.status by this failure, the status will be decided
650                  * by result of bch_data_insert() operation.
651                  */
652                 if (unlikely(s->iop.writeback &&
653                              bio->bi_opf & REQ_PREFLUSH)) {
654                         pr_err("Can't flush %s: returned bi_status %i\n",
655                                 dc->backing_dev_name, bio->bi_status);
656                 } else {
657                         /* set to orig_bio->bi_status in bio_complete() */
658                         s->iop.status = bio->bi_status;
659                 }
660                 s->recoverable = false;
661                 /* should count I/O error for backing device here */
662                 bch_count_backing_io_errors(dc, bio);
663         }
664
665         bio_put(bio);
666         closure_put(cl);
667 }
668
669 static void bio_complete(struct search *s)
670 {
671         if (s->orig_bio) {
672                 /* Count on bcache device */
673                 bio_end_io_acct_remapped(s->orig_bio, s->start_time,
674                                          s->orig_bdev);
675                 trace_bcache_request_end(s->d, s->orig_bio);
676                 s->orig_bio->bi_status = s->iop.status;
677                 bio_endio(s->orig_bio);
678                 s->orig_bio = NULL;
679         }
680 }
681
682 static void do_bio_hook(struct search *s,
683                         struct bio *orig_bio,
684                         bio_end_io_t *end_io_fn)
685 {
686         struct bio *bio = &s->bio.bio;
687
688         bio_init(bio, NULL, 0);
689         __bio_clone_fast(bio, orig_bio);
690         /*
691          * bi_end_io can be set separately somewhere else, e.g. the
692          * variants in,
693          * - cache_bio->bi_end_io from cached_dev_cache_miss()
694          * - n->bi_end_io from cache_lookup_fn()
695          */
696         bio->bi_end_io          = end_io_fn;
697         bio->bi_private         = &s->cl;
698
699         bio_cnt_set(bio, 3);
700 }
701
702 static void search_free(struct closure *cl)
703 {
704         struct search *s = container_of(cl, struct search, cl);
705
706         atomic_dec(&s->iop.c->search_inflight);
707
708         if (s->iop.bio)
709                 bio_put(s->iop.bio);
710
711         bio_complete(s);
712         closure_debug_destroy(cl);
713         mempool_free(s, &s->iop.c->search);
714 }
715
716 static inline struct search *search_alloc(struct bio *bio,
717                 struct bcache_device *d, struct block_device *orig_bdev,
718                 unsigned long start_time)
719 {
720         struct search *s;
721
722         s = mempool_alloc(&d->c->search, GFP_NOIO);
723
724         closure_init(&s->cl, NULL);
725         do_bio_hook(s, bio, request_endio);
726         atomic_inc(&d->c->search_inflight);
727
728         s->orig_bio             = bio;
729         s->cache_miss           = NULL;
730         s->cache_missed         = 0;
731         s->d                    = d;
732         s->recoverable          = 1;
733         s->write                = op_is_write(bio_op(bio));
734         s->read_dirty_data      = 0;
735         /* Count on the bcache device */
736         s->orig_bdev            = orig_bdev;
737         s->start_time           = start_time;
738         s->iop.c                = d->c;
739         s->iop.bio              = NULL;
740         s->iop.inode            = d->id;
741         s->iop.write_point      = hash_long((unsigned long) current, 16);
742         s->iop.write_prio       = 0;
743         s->iop.status           = 0;
744         s->iop.flags            = 0;
745         s->iop.flush_journal    = op_is_flush(bio->bi_opf);
746         s->iop.wq               = bcache_wq;
747
748         return s;
749 }
750
751 /* Cached devices */
752
753 static void cached_dev_bio_complete(struct closure *cl)
754 {
755         struct search *s = container_of(cl, struct search, cl);
756         struct cached_dev *dc = container_of(s->d, struct cached_dev, disk);
757
758         cached_dev_put(dc);
759         search_free(cl);
760 }
761
762 /* Process reads */
763
764 static void cached_dev_read_error_done(struct closure *cl)
765 {
766         struct search *s = container_of(cl, struct search, cl);
767
768         if (s->iop.replace_collision)
769                 bch_mark_cache_miss_collision(s->iop.c, s->d);
770
771         if (s->iop.bio)
772                 bio_free_pages(s->iop.bio);
773
774         cached_dev_bio_complete(cl);
775 }
776
777 static void cached_dev_read_error(struct closure *cl)
778 {
779         struct search *s = container_of(cl, struct search, cl);
780         struct bio *bio = &s->bio.bio;
781
782         /*
783          * If read request hit dirty data (s->read_dirty_data is true),
784          * then recovery a failed read request from cached device may
785          * get a stale data back. So read failure recovery is only
786          * permitted when read request hit clean data in cache device,
787          * or when cache read race happened.
788          */
789         if (s->recoverable && !s->read_dirty_data) {
790                 /* Retry from the backing device: */
791                 trace_bcache_read_retry(s->orig_bio);
792
793                 s->iop.status = 0;
794                 do_bio_hook(s, s->orig_bio, backing_request_endio);
795
796                 /* XXX: invalidate cache */
797
798                 /* I/O request sent to backing device */
799                 closure_bio_submit(s->iop.c, bio, cl);
800         }
801
802         continue_at(cl, cached_dev_read_error_done, NULL);
803 }
804
805 static void cached_dev_cache_miss_done(struct closure *cl)
806 {
807         struct search *s = container_of(cl, struct search, cl);
808         struct bcache_device *d = s->d;
809
810         if (s->iop.replace_collision)
811                 bch_mark_cache_miss_collision(s->iop.c, s->d);
812
813         if (s->iop.bio)
814                 bio_free_pages(s->iop.bio);
815
816         cached_dev_bio_complete(cl);
817         closure_put(&d->cl);
818 }
819
820 static void cached_dev_read_done(struct closure *cl)
821 {
822         struct search *s = container_of(cl, struct search, cl);
823         struct cached_dev *dc = container_of(s->d, struct cached_dev, disk);
824
825         /*
826          * We had a cache miss; cache_bio now contains data ready to be inserted
827          * into the cache.
828          *
829          * First, we copy the data we just read from cache_bio's bounce buffers
830          * to the buffers the original bio pointed to:
831          */
832
833         if (s->iop.bio) {
834                 bio_reset(s->iop.bio);
835                 s->iop.bio->bi_iter.bi_sector =
836                         s->cache_miss->bi_iter.bi_sector;
837                 bio_copy_dev(s->iop.bio, s->cache_miss);
838                 s->iop.bio->bi_iter.bi_size = s->insert_bio_sectors << 9;
839                 bch_bio_map(s->iop.bio, NULL);
840
841                 bio_copy_data(s->cache_miss, s->iop.bio);
842
843                 bio_put(s->cache_miss);
844                 s->cache_miss = NULL;
845         }
846
847         if (verify(dc) && s->recoverable && !s->read_dirty_data)
848                 bch_data_verify(dc, s->orig_bio);
849
850         closure_get(&dc->disk.cl);
851         bio_complete(s);
852
853         if (s->iop.bio &&
854             !test_bit(CACHE_SET_STOPPING, &s->iop.c->flags)) {
855                 BUG_ON(!s->iop.replace);
856                 closure_call(&s->iop.cl, bch_data_insert, NULL, cl);
857         }
858
859         continue_at(cl, cached_dev_cache_miss_done, NULL);
860 }
861
862 static void cached_dev_read_done_bh(struct closure *cl)
863 {
864         struct search *s = container_of(cl, struct search, cl);
865         struct cached_dev *dc = container_of(s->d, struct cached_dev, disk);
866
867         bch_mark_cache_accounting(s->iop.c, s->d,
868                                   !s->cache_missed, s->iop.bypass);
869         trace_bcache_read(s->orig_bio, !s->cache_missed, s->iop.bypass);
870
871         if (s->iop.status)
872                 continue_at_nobarrier(cl, cached_dev_read_error, bcache_wq);
873         else if (s->iop.bio || verify(dc))
874                 continue_at_nobarrier(cl, cached_dev_read_done, bcache_wq);
875         else
876                 continue_at_nobarrier(cl, cached_dev_bio_complete, NULL);
877 }
878
879 static int cached_dev_cache_miss(struct btree *b, struct search *s,
880                                  struct bio *bio, unsigned int sectors)
881 {
882         int ret = MAP_CONTINUE;
883         struct cached_dev *dc = container_of(s->d, struct cached_dev, disk);
884         struct bio *miss, *cache_bio;
885         unsigned int size_limit;
886
887         s->cache_missed = 1;
888
889         if (s->cache_miss || s->iop.bypass) {
890                 miss = bio_next_split(bio, sectors, GFP_NOIO, &s->d->bio_split);
891                 ret = miss == bio ? MAP_DONE : MAP_CONTINUE;
892                 goto out_submit;
893         }
894
895         /* Limitation for valid replace key size and cache_bio bvecs number */
896         size_limit = min_t(unsigned int, BIO_MAX_VECS * PAGE_SECTORS,
897                            (1 << KEY_SIZE_BITS) - 1);
898         s->insert_bio_sectors = min3(size_limit, sectors, bio_sectors(bio));
899
900         s->iop.replace_key = KEY(s->iop.inode,
901                                  bio->bi_iter.bi_sector + s->insert_bio_sectors,
902                                  s->insert_bio_sectors);
903
904         ret = bch_btree_insert_check_key(b, &s->op, &s->iop.replace_key);
905         if (ret)
906                 return ret;
907
908         s->iop.replace = true;
909
910         miss = bio_next_split(bio, s->insert_bio_sectors, GFP_NOIO,
911                               &s->d->bio_split);
912
913         /* btree_search_recurse()'s btree iterator is no good anymore */
914         ret = miss == bio ? MAP_DONE : -EINTR;
915
916         cache_bio = bio_alloc_bioset(GFP_NOWAIT,
917                         DIV_ROUND_UP(s->insert_bio_sectors, PAGE_SECTORS),
918                         &dc->disk.bio_split);
919         if (!cache_bio)
920                 goto out_submit;
921
922         cache_bio->bi_iter.bi_sector    = miss->bi_iter.bi_sector;
923         bio_copy_dev(cache_bio, miss);
924         cache_bio->bi_iter.bi_size      = s->insert_bio_sectors << 9;
925
926         cache_bio->bi_end_io    = backing_request_endio;
927         cache_bio->bi_private   = &s->cl;
928
929         bch_bio_map(cache_bio, NULL);
930         if (bch_bio_alloc_pages(cache_bio, __GFP_NOWARN|GFP_NOIO))
931                 goto out_put;
932
933         s->cache_miss   = miss;
934         s->iop.bio      = cache_bio;
935         bio_get(cache_bio);
936         /* I/O request sent to backing device */
937         closure_bio_submit(s->iop.c, cache_bio, &s->cl);
938
939         return ret;
940 out_put:
941         bio_put(cache_bio);
942 out_submit:
943         miss->bi_end_io         = backing_request_endio;
944         miss->bi_private        = &s->cl;
945         /* I/O request sent to backing device */
946         closure_bio_submit(s->iop.c, miss, &s->cl);
947         return ret;
948 }
949
950 static void cached_dev_read(struct cached_dev *dc, struct search *s)
951 {
952         struct closure *cl = &s->cl;
953
954         closure_call(&s->iop.cl, cache_lookup, NULL, cl);
955         continue_at(cl, cached_dev_read_done_bh, NULL);
956 }
957
958 /* Process writes */
959
960 static void cached_dev_write_complete(struct closure *cl)
961 {
962         struct search *s = container_of(cl, struct search, cl);
963         struct cached_dev *dc = container_of(s->d, struct cached_dev, disk);
964
965         up_read_non_owner(&dc->writeback_lock);
966         cached_dev_bio_complete(cl);
967 }
968
969 static void cached_dev_write(struct cached_dev *dc, struct search *s)
970 {
971         struct closure *cl = &s->cl;
972         struct bio *bio = &s->bio.bio;
973         struct bkey start = KEY(dc->disk.id, bio->bi_iter.bi_sector, 0);
974         struct bkey end = KEY(dc->disk.id, bio_end_sector(bio), 0);
975
976         bch_keybuf_check_overlapping(&s->iop.c->moving_gc_keys, &start, &end);
977
978         down_read_non_owner(&dc->writeback_lock);
979         if (bch_keybuf_check_overlapping(&dc->writeback_keys, &start, &end)) {
980                 /*
981                  * We overlap with some dirty data undergoing background
982                  * writeback, force this write to writeback
983                  */
984                 s->iop.bypass = false;
985                 s->iop.writeback = true;
986         }
987
988         /*
989          * Discards aren't _required_ to do anything, so skipping if
990          * check_overlapping returned true is ok
991          *
992          * But check_overlapping drops dirty keys for which io hasn't started,
993          * so we still want to call it.
994          */
995         if (bio_op(bio) == REQ_OP_DISCARD)
996                 s->iop.bypass = true;
997
998         if (should_writeback(dc, s->orig_bio,
999                              cache_mode(dc),
1000                              s->iop.bypass)) {
1001                 s->iop.bypass = false;
1002                 s->iop.writeback = true;
1003         }
1004
1005         if (s->iop.bypass) {
1006                 s->iop.bio = s->orig_bio;
1007                 bio_get(s->iop.bio);
1008
1009                 if (bio_op(bio) == REQ_OP_DISCARD &&
1010                     !blk_queue_discard(bdev_get_queue(dc->bdev)))
1011                         goto insert_data;
1012
1013                 /* I/O request sent to backing device */
1014                 bio->bi_end_io = backing_request_endio;
1015                 closure_bio_submit(s->iop.c, bio, cl);
1016
1017         } else if (s->iop.writeback) {
1018                 bch_writeback_add(dc);
1019                 s->iop.bio = bio;
1020
1021                 if (bio->bi_opf & REQ_PREFLUSH) {
1022                         /*
1023                          * Also need to send a flush to the backing
1024                          * device.
1025                          */
1026                         struct bio *flush;
1027
1028                         flush = bio_alloc_bioset(GFP_NOIO, 0,
1029                                                  &dc->disk.bio_split);
1030                         if (!flush) {
1031                                 s->iop.status = BLK_STS_RESOURCE;
1032                                 goto insert_data;
1033                         }
1034                         bio_copy_dev(flush, bio);
1035                         flush->bi_end_io = backing_request_endio;
1036                         flush->bi_private = cl;
1037                         flush->bi_opf = REQ_OP_WRITE | REQ_PREFLUSH;
1038                         /* I/O request sent to backing device */
1039                         closure_bio_submit(s->iop.c, flush, cl);
1040                 }
1041         } else {
1042                 s->iop.bio = bio_clone_fast(bio, GFP_NOIO, &dc->disk.bio_split);
1043                 /* I/O request sent to backing device */
1044                 bio->bi_end_io = backing_request_endio;
1045                 closure_bio_submit(s->iop.c, bio, cl);
1046         }
1047
1048 insert_data:
1049         closure_call(&s->iop.cl, bch_data_insert, NULL, cl);
1050         continue_at(cl, cached_dev_write_complete, NULL);
1051 }
1052
1053 static void cached_dev_nodata(struct closure *cl)
1054 {
1055         struct search *s = container_of(cl, struct search, cl);
1056         struct bio *bio = &s->bio.bio;
1057
1058         if (s->iop.flush_journal)
1059                 bch_journal_meta(s->iop.c, cl);
1060
1061         /* If it's a flush, we send the flush to the backing device too */
1062         bio->bi_end_io = backing_request_endio;
1063         closure_bio_submit(s->iop.c, bio, cl);
1064
1065         continue_at(cl, cached_dev_bio_complete, NULL);
1066 }
1067
1068 struct detached_dev_io_private {
1069         struct bcache_device    *d;
1070         unsigned long           start_time;
1071         bio_end_io_t            *bi_end_io;
1072         void                    *bi_private;
1073         struct block_device     *orig_bdev;
1074 };
1075
1076 static void detached_dev_end_io(struct bio *bio)
1077 {
1078         struct detached_dev_io_private *ddip;
1079
1080         ddip = bio->bi_private;
1081         bio->bi_end_io = ddip->bi_end_io;
1082         bio->bi_private = ddip->bi_private;
1083
1084         /* Count on the bcache device */
1085         bio_end_io_acct_remapped(bio, ddip->start_time, ddip->orig_bdev);
1086
1087         if (bio->bi_status) {
1088                 struct cached_dev *dc = container_of(ddip->d,
1089                                                      struct cached_dev, disk);
1090                 /* should count I/O error for backing device here */
1091                 bch_count_backing_io_errors(dc, bio);
1092         }
1093
1094         kfree(ddip);
1095         bio->bi_end_io(bio);
1096 }
1097
1098 static void detached_dev_do_request(struct bcache_device *d, struct bio *bio,
1099                 struct block_device *orig_bdev, unsigned long start_time)
1100 {
1101         struct detached_dev_io_private *ddip;
1102         struct cached_dev *dc = container_of(d, struct cached_dev, disk);
1103
1104         /*
1105          * no need to call closure_get(&dc->disk.cl),
1106          * because upper layer had already opened bcache device,
1107          * which would call closure_get(&dc->disk.cl)
1108          */
1109         ddip = kzalloc(sizeof(struct detached_dev_io_private), GFP_NOIO);
1110         ddip->d = d;
1111         /* Count on the bcache device */
1112         ddip->orig_bdev = orig_bdev;
1113         ddip->start_time = start_time;
1114         ddip->bi_end_io = bio->bi_end_io;
1115         ddip->bi_private = bio->bi_private;
1116         bio->bi_end_io = detached_dev_end_io;
1117         bio->bi_private = ddip;
1118
1119         if ((bio_op(bio) == REQ_OP_DISCARD) &&
1120             !blk_queue_discard(bdev_get_queue(dc->bdev)))
1121                 bio->bi_end_io(bio);
1122         else
1123                 submit_bio_noacct(bio);
1124 }
1125
1126 static void quit_max_writeback_rate(struct cache_set *c,
1127                                     struct cached_dev *this_dc)
1128 {
1129         int i;
1130         struct bcache_device *d;
1131         struct cached_dev *dc;
1132
1133         /*
1134          * mutex bch_register_lock may compete with other parallel requesters,
1135          * or attach/detach operations on other backing device. Waiting to
1136          * the mutex lock may increase I/O request latency for seconds or more.
1137          * To avoid such situation, if mutext_trylock() failed, only writeback
1138          * rate of current cached device is set to 1, and __update_write_back()
1139          * will decide writeback rate of other cached devices (remember now
1140          * c->idle_counter is 0 already).
1141          */
1142         if (mutex_trylock(&bch_register_lock)) {
1143                 for (i = 0; i < c->devices_max_used; i++) {
1144                         if (!c->devices[i])
1145                                 continue;
1146
1147                         if (UUID_FLASH_ONLY(&c->uuids[i]))
1148                                 continue;
1149
1150                         d = c->devices[i];
1151                         dc = container_of(d, struct cached_dev, disk);
1152                         /*
1153                          * set writeback rate to default minimum value,
1154                          * then let update_writeback_rate() to decide the
1155                          * upcoming rate.
1156                          */
1157                         atomic_long_set(&dc->writeback_rate.rate, 1);
1158                 }
1159                 mutex_unlock(&bch_register_lock);
1160         } else
1161                 atomic_long_set(&this_dc->writeback_rate.rate, 1);
1162 }
1163
1164 /* Cached devices - read & write stuff */
1165
1166 blk_qc_t cached_dev_submit_bio(struct bio *bio)
1167 {
1168         struct search *s;
1169         struct block_device *orig_bdev = bio->bi_bdev;
1170         struct bcache_device *d = orig_bdev->bd_disk->private_data;
1171         struct cached_dev *dc = container_of(d, struct cached_dev, disk);
1172         unsigned long start_time;
1173         int rw = bio_data_dir(bio);
1174
1175         if (unlikely((d->c && test_bit(CACHE_SET_IO_DISABLE, &d->c->flags)) ||
1176                      dc->io_disable)) {
1177                 bio->bi_status = BLK_STS_IOERR;
1178                 bio_endio(bio);
1179                 return BLK_QC_T_NONE;
1180         }
1181
1182         if (likely(d->c)) {
1183                 if (atomic_read(&d->c->idle_counter))
1184                         atomic_set(&d->c->idle_counter, 0);
1185                 /*
1186                  * If at_max_writeback_rate of cache set is true and new I/O
1187                  * comes, quit max writeback rate of all cached devices
1188                  * attached to this cache set, and set at_max_writeback_rate
1189                  * to false.
1190                  */
1191                 if (unlikely(atomic_read(&d->c->at_max_writeback_rate) == 1)) {
1192                         atomic_set(&d->c->at_max_writeback_rate, 0);
1193                         quit_max_writeback_rate(d->c, dc);
1194                 }
1195         }
1196
1197         start_time = bio_start_io_acct(bio);
1198
1199         bio_set_dev(bio, dc->bdev);
1200         bio->bi_iter.bi_sector += dc->sb.data_offset;
1201
1202         if (cached_dev_get(dc)) {
1203                 s = search_alloc(bio, d, orig_bdev, start_time);
1204                 trace_bcache_request_start(s->d, bio);
1205
1206                 if (!bio->bi_iter.bi_size) {
1207                         /*
1208                          * can't call bch_journal_meta from under
1209                          * submit_bio_noacct
1210                          */
1211                         continue_at_nobarrier(&s->cl,
1212                                               cached_dev_nodata,
1213                                               bcache_wq);
1214                 } else {
1215                         s->iop.bypass = check_should_bypass(dc, bio);
1216
1217                         if (rw)
1218                                 cached_dev_write(dc, s);
1219                         else
1220                                 cached_dev_read(dc, s);
1221                 }
1222         } else
1223                 /* I/O request sent to backing device */
1224                 detached_dev_do_request(d, bio, orig_bdev, start_time);
1225
1226         return BLK_QC_T_NONE;
1227 }
1228
1229 static int cached_dev_ioctl(struct bcache_device *d, fmode_t mode,
1230                             unsigned int cmd, unsigned long arg)
1231 {
1232         struct cached_dev *dc = container_of(d, struct cached_dev, disk);
1233
1234         if (dc->io_disable)
1235                 return -EIO;
1236         if (!dc->bdev->bd_disk->fops->ioctl)
1237                 return -ENOTTY;
1238         return dc->bdev->bd_disk->fops->ioctl(dc->bdev, mode, cmd, arg);
1239 }
1240
1241 void bch_cached_dev_request_init(struct cached_dev *dc)
1242 {
1243         dc->disk.cache_miss                     = cached_dev_cache_miss;
1244         dc->disk.ioctl                          = cached_dev_ioctl;
1245 }
1246
1247 /* Flash backed devices */
1248
1249 static int flash_dev_cache_miss(struct btree *b, struct search *s,
1250                                 struct bio *bio, unsigned int sectors)
1251 {
1252         unsigned int bytes = min(sectors, bio_sectors(bio)) << 9;
1253
1254         swap(bio->bi_iter.bi_size, bytes);
1255         zero_fill_bio(bio);
1256         swap(bio->bi_iter.bi_size, bytes);
1257
1258         bio_advance(bio, bytes);
1259
1260         if (!bio->bi_iter.bi_size)
1261                 return MAP_DONE;
1262
1263         return MAP_CONTINUE;
1264 }
1265
1266 static void flash_dev_nodata(struct closure *cl)
1267 {
1268         struct search *s = container_of(cl, struct search, cl);
1269
1270         if (s->iop.flush_journal)
1271                 bch_journal_meta(s->iop.c, cl);
1272
1273         continue_at(cl, search_free, NULL);
1274 }
1275
1276 blk_qc_t flash_dev_submit_bio(struct bio *bio)
1277 {
1278         struct search *s;
1279         struct closure *cl;
1280         struct bcache_device *d = bio->bi_bdev->bd_disk->private_data;
1281
1282         if (unlikely(d->c && test_bit(CACHE_SET_IO_DISABLE, &d->c->flags))) {
1283                 bio->bi_status = BLK_STS_IOERR;
1284                 bio_endio(bio);
1285                 return BLK_QC_T_NONE;
1286         }
1287
1288         s = search_alloc(bio, d, bio->bi_bdev, bio_start_io_acct(bio));
1289         cl = &s->cl;
1290         bio = &s->bio.bio;
1291
1292         trace_bcache_request_start(s->d, bio);
1293
1294         if (!bio->bi_iter.bi_size) {
1295                 /*
1296                  * can't call bch_journal_meta from under submit_bio_noacct
1297                  */
1298                 continue_at_nobarrier(&s->cl,
1299                                       flash_dev_nodata,
1300                                       bcache_wq);
1301                 return BLK_QC_T_NONE;
1302         } else if (bio_data_dir(bio)) {
1303                 bch_keybuf_check_overlapping(&s->iop.c->moving_gc_keys,
1304                                         &KEY(d->id, bio->bi_iter.bi_sector, 0),
1305                                         &KEY(d->id, bio_end_sector(bio), 0));
1306
1307                 s->iop.bypass           = (bio_op(bio) == REQ_OP_DISCARD) != 0;
1308                 s->iop.writeback        = true;
1309                 s->iop.bio              = bio;
1310
1311                 closure_call(&s->iop.cl, bch_data_insert, NULL, cl);
1312         } else {
1313                 closure_call(&s->iop.cl, cache_lookup, NULL, cl);
1314         }
1315
1316         continue_at(cl, search_free, NULL);
1317         return BLK_QC_T_NONE;
1318 }
1319
1320 static int flash_dev_ioctl(struct bcache_device *d, fmode_t mode,
1321                            unsigned int cmd, unsigned long arg)
1322 {
1323         return -ENOTTY;
1324 }
1325
1326 void bch_flash_dev_request_init(struct bcache_device *d)
1327 {
1328         d->cache_miss                           = flash_dev_cache_miss;
1329         d->ioctl                                = flash_dev_ioctl;
1330 }
1331
1332 void bch_request_exit(void)
1333 {
1334         kmem_cache_destroy(bch_search_cache);
1335 }
1336
1337 int __init bch_request_init(void)
1338 {
1339         bch_search_cache = KMEM_CACHE(search, 0);
1340         if (!bch_search_cache)
1341                 return -ENOMEM;
1342
1343         return 0;
1344 }