Merge tag 'wireless-2024-01-22' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / include / linux / bio.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
4  */
5 #ifndef __LINUX_BIO_H
6 #define __LINUX_BIO_H
7
8 #include <linux/mempool.h>
9 /* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
10 #include <linux/blk_types.h>
11 #include <linux/uio.h>
12
13 #define BIO_MAX_VECS            256U
14
15 struct queue_limits;
16
17 static inline unsigned int bio_max_segs(unsigned int nr_segs)
18 {
19         return min(nr_segs, BIO_MAX_VECS);
20 }
21
22 #define bio_prio(bio)                   (bio)->bi_ioprio
23 #define bio_set_prio(bio, prio)         ((bio)->bi_ioprio = prio)
24
25 #define bio_iter_iovec(bio, iter)                               \
26         bvec_iter_bvec((bio)->bi_io_vec, (iter))
27
28 #define bio_iter_page(bio, iter)                                \
29         bvec_iter_page((bio)->bi_io_vec, (iter))
30 #define bio_iter_len(bio, iter)                                 \
31         bvec_iter_len((bio)->bi_io_vec, (iter))
32 #define bio_iter_offset(bio, iter)                              \
33         bvec_iter_offset((bio)->bi_io_vec, (iter))
34
35 #define bio_page(bio)           bio_iter_page((bio), (bio)->bi_iter)
36 #define bio_offset(bio)         bio_iter_offset((bio), (bio)->bi_iter)
37 #define bio_iovec(bio)          bio_iter_iovec((bio), (bio)->bi_iter)
38
39 #define bvec_iter_sectors(iter) ((iter).bi_size >> 9)
40 #define bvec_iter_end_sector(iter) ((iter).bi_sector + bvec_iter_sectors((iter)))
41
42 #define bio_sectors(bio)        bvec_iter_sectors((bio)->bi_iter)
43 #define bio_end_sector(bio)     bvec_iter_end_sector((bio)->bi_iter)
44
45 /*
46  * Return the data direction, READ or WRITE.
47  */
48 #define bio_data_dir(bio) \
49         (op_is_write(bio_op(bio)) ? WRITE : READ)
50
51 /*
52  * Check whether this bio carries any data or not. A NULL bio is allowed.
53  */
54 static inline bool bio_has_data(struct bio *bio)
55 {
56         if (bio &&
57             bio->bi_iter.bi_size &&
58             bio_op(bio) != REQ_OP_DISCARD &&
59             bio_op(bio) != REQ_OP_SECURE_ERASE &&
60             bio_op(bio) != REQ_OP_WRITE_ZEROES)
61                 return true;
62
63         return false;
64 }
65
66 static inline bool bio_no_advance_iter(const struct bio *bio)
67 {
68         return bio_op(bio) == REQ_OP_DISCARD ||
69                bio_op(bio) == REQ_OP_SECURE_ERASE ||
70                bio_op(bio) == REQ_OP_WRITE_ZEROES;
71 }
72
73 static inline void *bio_data(struct bio *bio)
74 {
75         if (bio_has_data(bio))
76                 return page_address(bio_page(bio)) + bio_offset(bio);
77
78         return NULL;
79 }
80
81 static inline bool bio_next_segment(const struct bio *bio,
82                                     struct bvec_iter_all *iter)
83 {
84         if (iter->idx >= bio->bi_vcnt)
85                 return false;
86
87         bvec_advance(&bio->bi_io_vec[iter->idx], iter);
88         return true;
89 }
90
91 /*
92  * drivers should _never_ use the all version - the bio may have been split
93  * before it got to the driver and the driver won't own all of it
94  */
95 #define bio_for_each_segment_all(bvl, bio, iter) \
96         for (bvl = bvec_init_iter_all(&iter); bio_next_segment((bio), &iter); )
97
98 static inline void bio_advance_iter(const struct bio *bio,
99                                     struct bvec_iter *iter, unsigned int bytes)
100 {
101         iter->bi_sector += bytes >> 9;
102
103         if (bio_no_advance_iter(bio))
104                 iter->bi_size -= bytes;
105         else
106                 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
107                 /* TODO: It is reasonable to complete bio with error here. */
108 }
109
110 /* @bytes should be less or equal to bvec[i->bi_idx].bv_len */
111 static inline void bio_advance_iter_single(const struct bio *bio,
112                                            struct bvec_iter *iter,
113                                            unsigned int bytes)
114 {
115         iter->bi_sector += bytes >> 9;
116
117         if (bio_no_advance_iter(bio))
118                 iter->bi_size -= bytes;
119         else
120                 bvec_iter_advance_single(bio->bi_io_vec, iter, bytes);
121 }
122
123 void __bio_advance(struct bio *, unsigned bytes);
124
125 /**
126  * bio_advance - increment/complete a bio by some number of bytes
127  * @bio:        bio to advance
128  * @nbytes:     number of bytes to complete
129  *
130  * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
131  * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
132  * be updated on the last bvec as well.
133  *
134  * @bio will then represent the remaining, uncompleted portion of the io.
135  */
136 static inline void bio_advance(struct bio *bio, unsigned int nbytes)
137 {
138         if (nbytes == bio->bi_iter.bi_size) {
139                 bio->bi_iter.bi_size = 0;
140                 return;
141         }
142         __bio_advance(bio, nbytes);
143 }
144
145 #define __bio_for_each_segment(bvl, bio, iter, start)                   \
146         for (iter = (start);                                            \
147              (iter).bi_size &&                                          \
148                 ((bvl = bio_iter_iovec((bio), (iter))), 1);             \
149              bio_advance_iter_single((bio), &(iter), (bvl).bv_len))
150
151 #define bio_for_each_segment(bvl, bio, iter)                            \
152         __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
153
154 #define __bio_for_each_bvec(bvl, bio, iter, start)              \
155         for (iter = (start);                                            \
156              (iter).bi_size &&                                          \
157                 ((bvl = mp_bvec_iter_bvec((bio)->bi_io_vec, (iter))), 1); \
158              bio_advance_iter_single((bio), &(iter), (bvl).bv_len))
159
160 /* iterate over multi-page bvec */
161 #define bio_for_each_bvec(bvl, bio, iter)                       \
162         __bio_for_each_bvec(bvl, bio, iter, (bio)->bi_iter)
163
164 /*
165  * Iterate over all multi-page bvecs. Drivers shouldn't use this version for the
166  * same reasons as bio_for_each_segment_all().
167  */
168 #define bio_for_each_bvec_all(bvl, bio, i)              \
169         for (i = 0, bvl = bio_first_bvec_all(bio);      \
170              i < (bio)->bi_vcnt; i++, bvl++)
171
172 #define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
173
174 static inline unsigned bio_segments(struct bio *bio)
175 {
176         unsigned segs = 0;
177         struct bio_vec bv;
178         struct bvec_iter iter;
179
180         /*
181          * We special case discard/write same/write zeroes, because they
182          * interpret bi_size differently:
183          */
184
185         switch (bio_op(bio)) {
186         case REQ_OP_DISCARD:
187         case REQ_OP_SECURE_ERASE:
188         case REQ_OP_WRITE_ZEROES:
189                 return 0;
190         default:
191                 break;
192         }
193
194         bio_for_each_segment(bv, bio, iter)
195                 segs++;
196
197         return segs;
198 }
199
200 /*
201  * get a reference to a bio, so it won't disappear. the intended use is
202  * something like:
203  *
204  * bio_get(bio);
205  * submit_bio(rw, bio);
206  * if (bio->bi_flags ...)
207  *      do_something
208  * bio_put(bio);
209  *
210  * without the bio_get(), it could potentially complete I/O before submit_bio
211  * returns. and then bio would be freed memory when if (bio->bi_flags ...)
212  * runs
213  */
214 static inline void bio_get(struct bio *bio)
215 {
216         bio->bi_flags |= (1 << BIO_REFFED);
217         smp_mb__before_atomic();
218         atomic_inc(&bio->__bi_cnt);
219 }
220
221 static inline void bio_cnt_set(struct bio *bio, unsigned int count)
222 {
223         if (count != 1) {
224                 bio->bi_flags |= (1 << BIO_REFFED);
225                 smp_mb();
226         }
227         atomic_set(&bio->__bi_cnt, count);
228 }
229
230 static inline bool bio_flagged(struct bio *bio, unsigned int bit)
231 {
232         return bio->bi_flags & (1U << bit);
233 }
234
235 static inline void bio_set_flag(struct bio *bio, unsigned int bit)
236 {
237         bio->bi_flags |= (1U << bit);
238 }
239
240 static inline void bio_clear_flag(struct bio *bio, unsigned int bit)
241 {
242         bio->bi_flags &= ~(1U << bit);
243 }
244
245 static inline struct bio_vec *bio_first_bvec_all(struct bio *bio)
246 {
247         WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
248         return bio->bi_io_vec;
249 }
250
251 static inline struct page *bio_first_page_all(struct bio *bio)
252 {
253         return bio_first_bvec_all(bio)->bv_page;
254 }
255
256 static inline struct folio *bio_first_folio_all(struct bio *bio)
257 {
258         return page_folio(bio_first_page_all(bio));
259 }
260
261 static inline struct bio_vec *bio_last_bvec_all(struct bio *bio)
262 {
263         WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
264         return &bio->bi_io_vec[bio->bi_vcnt - 1];
265 }
266
267 /**
268  * struct folio_iter - State for iterating all folios in a bio.
269  * @folio: The current folio we're iterating.  NULL after the last folio.
270  * @offset: The byte offset within the current folio.
271  * @length: The number of bytes in this iteration (will not cross folio
272  *      boundary).
273  */
274 struct folio_iter {
275         struct folio *folio;
276         size_t offset;
277         size_t length;
278         /* private: for use by the iterator */
279         struct folio *_next;
280         size_t _seg_count;
281         int _i;
282 };
283
284 static inline void bio_first_folio(struct folio_iter *fi, struct bio *bio,
285                                    int i)
286 {
287         struct bio_vec *bvec = bio_first_bvec_all(bio) + i;
288
289         fi->folio = page_folio(bvec->bv_page);
290         fi->offset = bvec->bv_offset +
291                         PAGE_SIZE * (bvec->bv_page - &fi->folio->page);
292         fi->_seg_count = bvec->bv_len;
293         fi->length = min(folio_size(fi->folio) - fi->offset, fi->_seg_count);
294         fi->_next = folio_next(fi->folio);
295         fi->_i = i;
296 }
297
298 static inline void bio_next_folio(struct folio_iter *fi, struct bio *bio)
299 {
300         fi->_seg_count -= fi->length;
301         if (fi->_seg_count) {
302                 fi->folio = fi->_next;
303                 fi->offset = 0;
304                 fi->length = min(folio_size(fi->folio), fi->_seg_count);
305                 fi->_next = folio_next(fi->folio);
306         } else if (fi->_i + 1 < bio->bi_vcnt) {
307                 bio_first_folio(fi, bio, fi->_i + 1);
308         } else {
309                 fi->folio = NULL;
310         }
311 }
312
313 /**
314  * bio_for_each_folio_all - Iterate over each folio in a bio.
315  * @fi: struct folio_iter which is updated for each folio.
316  * @bio: struct bio to iterate over.
317  */
318 #define bio_for_each_folio_all(fi, bio)                         \
319         for (bio_first_folio(&fi, bio, 0); fi.folio; bio_next_folio(&fi, bio))
320
321 enum bip_flags {
322         BIP_BLOCK_INTEGRITY     = 1 << 0, /* block layer owns integrity data */
323         BIP_MAPPED_INTEGRITY    = 1 << 1, /* ref tag has been remapped */
324         BIP_CTRL_NOCHECK        = 1 << 2, /* disable HBA integrity checking */
325         BIP_DISK_NOCHECK        = 1 << 3, /* disable disk integrity checking */
326         BIP_IP_CHECKSUM         = 1 << 4, /* IP checksum */
327         BIP_INTEGRITY_USER      = 1 << 5, /* Integrity payload is user address */
328         BIP_COPY_USER           = 1 << 6, /* Kernel bounce buffer in use */
329 };
330
331 /*
332  * bio integrity payload
333  */
334 struct bio_integrity_payload {
335         struct bio              *bip_bio;       /* parent bio */
336
337         struct bvec_iter        bip_iter;
338
339         unsigned short          bip_vcnt;       /* # of integrity bio_vecs */
340         unsigned short          bip_max_vcnt;   /* integrity bio_vec slots */
341         unsigned short          bip_flags;      /* control flags */
342
343         struct bvec_iter        bio_iter;       /* for rewinding parent bio */
344
345         struct work_struct      bip_work;       /* I/O completion */
346
347         struct bio_vec          *bip_vec;
348         struct bio_vec          bip_inline_vecs[];/* embedded bvec array */
349 };
350
351 #if defined(CONFIG_BLK_DEV_INTEGRITY)
352
353 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
354 {
355         if (bio->bi_opf & REQ_INTEGRITY)
356                 return bio->bi_integrity;
357
358         return NULL;
359 }
360
361 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
362 {
363         struct bio_integrity_payload *bip = bio_integrity(bio);
364
365         if (bip)
366                 return bip->bip_flags & flag;
367
368         return false;
369 }
370
371 static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
372 {
373         return bip->bip_iter.bi_sector;
374 }
375
376 static inline void bip_set_seed(struct bio_integrity_payload *bip,
377                                 sector_t seed)
378 {
379         bip->bip_iter.bi_sector = seed;
380 }
381
382 #endif /* CONFIG_BLK_DEV_INTEGRITY */
383
384 void bio_trim(struct bio *bio, sector_t offset, sector_t size);
385 extern struct bio *bio_split(struct bio *bio, int sectors,
386                              gfp_t gfp, struct bio_set *bs);
387 struct bio *bio_split_rw(struct bio *bio, const struct queue_limits *lim,
388                 unsigned *segs, struct bio_set *bs, unsigned max_bytes);
389
390 /**
391  * bio_next_split - get next @sectors from a bio, splitting if necessary
392  * @bio:        bio to split
393  * @sectors:    number of sectors to split from the front of @bio
394  * @gfp:        gfp mask
395  * @bs:         bio set to allocate from
396  *
397  * Return: a bio representing the next @sectors of @bio - if the bio is smaller
398  * than @sectors, returns the original bio unchanged.
399  */
400 static inline struct bio *bio_next_split(struct bio *bio, int sectors,
401                                          gfp_t gfp, struct bio_set *bs)
402 {
403         if (sectors >= bio_sectors(bio))
404                 return bio;
405
406         return bio_split(bio, sectors, gfp, bs);
407 }
408
409 enum {
410         BIOSET_NEED_BVECS = BIT(0),
411         BIOSET_NEED_RESCUER = BIT(1),
412         BIOSET_PERCPU_CACHE = BIT(2),
413 };
414 extern int bioset_init(struct bio_set *, unsigned int, unsigned int, int flags);
415 extern void bioset_exit(struct bio_set *);
416 extern int biovec_init_pool(mempool_t *pool, int pool_entries);
417
418 struct bio *bio_alloc_bioset(struct block_device *bdev, unsigned short nr_vecs,
419                              blk_opf_t opf, gfp_t gfp_mask,
420                              struct bio_set *bs);
421 struct bio *bio_kmalloc(unsigned short nr_vecs, gfp_t gfp_mask);
422 extern void bio_put(struct bio *);
423
424 struct bio *bio_alloc_clone(struct block_device *bdev, struct bio *bio_src,
425                 gfp_t gfp, struct bio_set *bs);
426 int bio_init_clone(struct block_device *bdev, struct bio *bio,
427                 struct bio *bio_src, gfp_t gfp);
428
429 extern struct bio_set fs_bio_set;
430
431 static inline struct bio *bio_alloc(struct block_device *bdev,
432                 unsigned short nr_vecs, blk_opf_t opf, gfp_t gfp_mask)
433 {
434         return bio_alloc_bioset(bdev, nr_vecs, opf, gfp_mask, &fs_bio_set);
435 }
436
437 void submit_bio(struct bio *bio);
438
439 extern void bio_endio(struct bio *);
440
441 static inline void bio_io_error(struct bio *bio)
442 {
443         bio->bi_status = BLK_STS_IOERR;
444         bio_endio(bio);
445 }
446
447 static inline void bio_wouldblock_error(struct bio *bio)
448 {
449         bio_set_flag(bio, BIO_QUIET);
450         bio->bi_status = BLK_STS_AGAIN;
451         bio_endio(bio);
452 }
453
454 /*
455  * Calculate number of bvec segments that should be allocated to fit data
456  * pointed by @iter. If @iter is backed by bvec it's going to be reused
457  * instead of allocating a new one.
458  */
459 static inline int bio_iov_vecs_to_alloc(struct iov_iter *iter, int max_segs)
460 {
461         if (iov_iter_is_bvec(iter))
462                 return 0;
463         return iov_iter_npages(iter, max_segs);
464 }
465
466 struct request_queue;
467
468 extern int submit_bio_wait(struct bio *bio);
469 void bio_init(struct bio *bio, struct block_device *bdev, struct bio_vec *table,
470               unsigned short max_vecs, blk_opf_t opf);
471 extern void bio_uninit(struct bio *);
472 void bio_reset(struct bio *bio, struct block_device *bdev, blk_opf_t opf);
473 void bio_chain(struct bio *, struct bio *);
474
475 int __must_check bio_add_page(struct bio *bio, struct page *page, unsigned len,
476                               unsigned off);
477 bool __must_check bio_add_folio(struct bio *bio, struct folio *folio,
478                                 size_t len, size_t off);
479 extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
480                            unsigned int, unsigned int);
481 int bio_add_zone_append_page(struct bio *bio, struct page *page,
482                              unsigned int len, unsigned int offset);
483 void __bio_add_page(struct bio *bio, struct page *page,
484                 unsigned int len, unsigned int off);
485 void bio_add_folio_nofail(struct bio *bio, struct folio *folio, size_t len,
486                           size_t off);
487 int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter);
488 void bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter);
489 void __bio_release_pages(struct bio *bio, bool mark_dirty);
490 extern void bio_set_pages_dirty(struct bio *bio);
491 extern void bio_check_pages_dirty(struct bio *bio);
492
493 extern void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
494                                struct bio *src, struct bvec_iter *src_iter);
495 extern void bio_copy_data(struct bio *dst, struct bio *src);
496 extern void bio_free_pages(struct bio *bio);
497 void guard_bio_eod(struct bio *bio);
498 void zero_fill_bio_iter(struct bio *bio, struct bvec_iter iter);
499
500 static inline void zero_fill_bio(struct bio *bio)
501 {
502         zero_fill_bio_iter(bio, bio->bi_iter);
503 }
504
505 static inline void bio_release_pages(struct bio *bio, bool mark_dirty)
506 {
507         if (bio_flagged(bio, BIO_PAGE_PINNED))
508                 __bio_release_pages(bio, mark_dirty);
509 }
510
511 #define bio_dev(bio) \
512         disk_devt((bio)->bi_bdev->bd_disk)
513
514 #ifdef CONFIG_BLK_CGROUP
515 void bio_associate_blkg(struct bio *bio);
516 void bio_associate_blkg_from_css(struct bio *bio,
517                                  struct cgroup_subsys_state *css);
518 void bio_clone_blkg_association(struct bio *dst, struct bio *src);
519 void blkcg_punt_bio_submit(struct bio *bio);
520 #else   /* CONFIG_BLK_CGROUP */
521 static inline void bio_associate_blkg(struct bio *bio) { }
522 static inline void bio_associate_blkg_from_css(struct bio *bio,
523                                                struct cgroup_subsys_state *css)
524 { }
525 static inline void bio_clone_blkg_association(struct bio *dst,
526                                               struct bio *src) { }
527 static inline void blkcg_punt_bio_submit(struct bio *bio)
528 {
529         submit_bio(bio);
530 }
531 #endif  /* CONFIG_BLK_CGROUP */
532
533 static inline void bio_set_dev(struct bio *bio, struct block_device *bdev)
534 {
535         bio_clear_flag(bio, BIO_REMAPPED);
536         if (bio->bi_bdev != bdev)
537                 bio_clear_flag(bio, BIO_BPS_THROTTLED);
538         bio->bi_bdev = bdev;
539         bio_associate_blkg(bio);
540 }
541
542 /*
543  * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
544  *
545  * A bio_list anchors a singly-linked list of bios chained through the bi_next
546  * member of the bio.  The bio_list also caches the last list member to allow
547  * fast access to the tail.
548  */
549 struct bio_list {
550         struct bio *head;
551         struct bio *tail;
552 };
553
554 static inline int bio_list_empty(const struct bio_list *bl)
555 {
556         return bl->head == NULL;
557 }
558
559 static inline void bio_list_init(struct bio_list *bl)
560 {
561         bl->head = bl->tail = NULL;
562 }
563
564 #define BIO_EMPTY_LIST  { NULL, NULL }
565
566 #define bio_list_for_each(bio, bl) \
567         for (bio = (bl)->head; bio; bio = bio->bi_next)
568
569 static inline unsigned bio_list_size(const struct bio_list *bl)
570 {
571         unsigned sz = 0;
572         struct bio *bio;
573
574         bio_list_for_each(bio, bl)
575                 sz++;
576
577         return sz;
578 }
579
580 static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
581 {
582         bio->bi_next = NULL;
583
584         if (bl->tail)
585                 bl->tail->bi_next = bio;
586         else
587                 bl->head = bio;
588
589         bl->tail = bio;
590 }
591
592 static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
593 {
594         bio->bi_next = bl->head;
595
596         bl->head = bio;
597
598         if (!bl->tail)
599                 bl->tail = bio;
600 }
601
602 static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
603 {
604         if (!bl2->head)
605                 return;
606
607         if (bl->tail)
608                 bl->tail->bi_next = bl2->head;
609         else
610                 bl->head = bl2->head;
611
612         bl->tail = bl2->tail;
613 }
614
615 static inline void bio_list_merge_head(struct bio_list *bl,
616                                        struct bio_list *bl2)
617 {
618         if (!bl2->head)
619                 return;
620
621         if (bl->head)
622                 bl2->tail->bi_next = bl->head;
623         else
624                 bl->tail = bl2->tail;
625
626         bl->head = bl2->head;
627 }
628
629 static inline struct bio *bio_list_peek(struct bio_list *bl)
630 {
631         return bl->head;
632 }
633
634 static inline struct bio *bio_list_pop(struct bio_list *bl)
635 {
636         struct bio *bio = bl->head;
637
638         if (bio) {
639                 bl->head = bl->head->bi_next;
640                 if (!bl->head)
641                         bl->tail = NULL;
642
643                 bio->bi_next = NULL;
644         }
645
646         return bio;
647 }
648
649 static inline struct bio *bio_list_get(struct bio_list *bl)
650 {
651         struct bio *bio = bl->head;
652
653         bl->head = bl->tail = NULL;
654
655         return bio;
656 }
657
658 /*
659  * Increment chain count for the bio. Make sure the CHAIN flag update
660  * is visible before the raised count.
661  */
662 static inline void bio_inc_remaining(struct bio *bio)
663 {
664         bio_set_flag(bio, BIO_CHAIN);
665         smp_mb__before_atomic();
666         atomic_inc(&bio->__bi_remaining);
667 }
668
669 /*
670  * bio_set is used to allow other portions of the IO system to
671  * allocate their own private memory pools for bio and iovec structures.
672  * These memory pools in turn all allocate from the bio_slab
673  * and the bvec_slabs[].
674  */
675 #define BIO_POOL_SIZE 2
676
677 struct bio_set {
678         struct kmem_cache *bio_slab;
679         unsigned int front_pad;
680
681         /*
682          * per-cpu bio alloc cache
683          */
684         struct bio_alloc_cache __percpu *cache;
685
686         mempool_t bio_pool;
687         mempool_t bvec_pool;
688 #if defined(CONFIG_BLK_DEV_INTEGRITY)
689         mempool_t bio_integrity_pool;
690         mempool_t bvec_integrity_pool;
691 #endif
692
693         unsigned int back_pad;
694         /*
695          * Deadlock avoidance for stacking block drivers: see comments in
696          * bio_alloc_bioset() for details
697          */
698         spinlock_t              rescue_lock;
699         struct bio_list         rescue_list;
700         struct work_struct      rescue_work;
701         struct workqueue_struct *rescue_workqueue;
702
703         /*
704          * Hot un-plug notifier for the per-cpu cache, if used
705          */
706         struct hlist_node cpuhp_dead;
707 };
708
709 static inline bool bioset_initialized(struct bio_set *bs)
710 {
711         return bs->bio_slab != NULL;
712 }
713
714 #if defined(CONFIG_BLK_DEV_INTEGRITY)
715
716 #define bip_for_each_vec(bvl, bip, iter)                                \
717         for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
718
719 #define bio_for_each_integrity_vec(_bvl, _bio, _iter)                   \
720         for_each_bio(_bio)                                              \
721                 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
722
723 int bio_integrity_map_user(struct bio *bio, void __user *ubuf, ssize_t len, u32 seed);
724 extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
725 extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
726 extern bool bio_integrity_prep(struct bio *);
727 extern void bio_integrity_advance(struct bio *, unsigned int);
728 extern void bio_integrity_trim(struct bio *);
729 extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
730 extern int bioset_integrity_create(struct bio_set *, int);
731 extern void bioset_integrity_free(struct bio_set *);
732 extern void bio_integrity_init(void);
733
734 #else /* CONFIG_BLK_DEV_INTEGRITY */
735
736 static inline void *bio_integrity(struct bio *bio)
737 {
738         return NULL;
739 }
740
741 static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
742 {
743         return 0;
744 }
745
746 static inline void bioset_integrity_free (struct bio_set *bs)
747 {
748         return;
749 }
750
751 static inline bool bio_integrity_prep(struct bio *bio)
752 {
753         return true;
754 }
755
756 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
757                                       gfp_t gfp_mask)
758 {
759         return 0;
760 }
761
762 static inline void bio_integrity_advance(struct bio *bio,
763                                          unsigned int bytes_done)
764 {
765         return;
766 }
767
768 static inline void bio_integrity_trim(struct bio *bio)
769 {
770         return;
771 }
772
773 static inline void bio_integrity_init(void)
774 {
775         return;
776 }
777
778 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
779 {
780         return false;
781 }
782
783 static inline void *bio_integrity_alloc(struct bio * bio, gfp_t gfp,
784                                                                 unsigned int nr)
785 {
786         return ERR_PTR(-EINVAL);
787 }
788
789 static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
790                                         unsigned int len, unsigned int offset)
791 {
792         return 0;
793 }
794
795 static inline int bio_integrity_map_user(struct bio *bio, void __user *ubuf,
796                                          ssize_t len, u32 seed)
797 {
798         return -EINVAL;
799 }
800
801 #endif /* CONFIG_BLK_DEV_INTEGRITY */
802
803 /*
804  * Mark a bio as polled. Note that for async polled IO, the caller must
805  * expect -EWOULDBLOCK if we cannot allocate a request (or other resources).
806  * We cannot block waiting for requests on polled IO, as those completions
807  * must be found by the caller. This is different than IRQ driven IO, where
808  * it's safe to wait for IO to complete.
809  */
810 static inline void bio_set_polled(struct bio *bio, struct kiocb *kiocb)
811 {
812         bio->bi_opf |= REQ_POLLED;
813         if (kiocb->ki_flags & IOCB_NOWAIT)
814                 bio->bi_opf |= REQ_NOWAIT;
815 }
816
817 static inline void bio_clear_polled(struct bio *bio)
818 {
819         bio->bi_opf &= ~REQ_POLLED;
820 }
821
822 struct bio *blk_next_bio(struct bio *bio, struct block_device *bdev,
823                 unsigned int nr_pages, blk_opf_t opf, gfp_t gfp);
824
825 #endif /* __LINUX_BIO_H */