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