]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/bio.h
block: Convert bio_for_each_segment() to bvec_iter
[mirror_ubuntu-bionic-kernel.git] / include / linux / bio.h
1 /*
2 * 2.5 block I/O model
3 *
4 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public Licens
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
19 */
20 #ifndef __LINUX_BIO_H
21 #define __LINUX_BIO_H
22
23 #include <linux/highmem.h>
24 #include <linux/mempool.h>
25 #include <linux/ioprio.h>
26 #include <linux/bug.h>
27
28 #ifdef CONFIG_BLOCK
29
30 #include <asm/io.h>
31
32 /* struct bio, bio_vec and BIO_* flags are defined in blk_types.h */
33 #include <linux/blk_types.h>
34
35 #define BIO_DEBUG
36
37 #ifdef BIO_DEBUG
38 #define BIO_BUG_ON BUG_ON
39 #else
40 #define BIO_BUG_ON
41 #endif
42
43 #define BIO_MAX_PAGES 256
44 #define BIO_MAX_SIZE (BIO_MAX_PAGES << PAGE_CACHE_SHIFT)
45 #define BIO_MAX_SECTORS (BIO_MAX_SIZE >> 9)
46
47 /*
48 * upper 16 bits of bi_rw define the io priority of this bio
49 */
50 #define BIO_PRIO_SHIFT (8 * sizeof(unsigned long) - IOPRIO_BITS)
51 #define bio_prio(bio) ((bio)->bi_rw >> BIO_PRIO_SHIFT)
52 #define bio_prio_valid(bio) ioprio_valid(bio_prio(bio))
53
54 #define bio_set_prio(bio, prio) do { \
55 WARN_ON(prio >= (1 << IOPRIO_BITS)); \
56 (bio)->bi_rw &= ((1UL << BIO_PRIO_SHIFT) - 1); \
57 (bio)->bi_rw |= ((unsigned long) (prio) << BIO_PRIO_SHIFT); \
58 } while (0)
59
60 /*
61 * various member access, note that bio_data should of course not be used
62 * on highmem page vectors
63 */
64 #define bio_iovec_idx(bio, idx) (&((bio)->bi_io_vec[(idx)]))
65 #define __bio_iovec(bio) bio_iovec_idx((bio), (bio)->bi_iter.bi_idx)
66
67 #define bio_iter_iovec(bio, iter) ((bio)->bi_io_vec[(iter).bi_idx])
68
69 #define bio_page(bio) (bio_iovec((bio)).bv_page)
70 #define bio_offset(bio) (bio_iovec((bio)).bv_offset)
71 #define bio_iovec(bio) (*__bio_iovec(bio))
72
73 #define bio_segments(bio) ((bio)->bi_vcnt - (bio)->bi_iter.bi_idx)
74 #define bio_sectors(bio) ((bio)->bi_iter.bi_size >> 9)
75 #define bio_end_sector(bio) ((bio)->bi_iter.bi_sector + bio_sectors((bio)))
76
77 static inline unsigned int bio_cur_bytes(struct bio *bio)
78 {
79 if (bio->bi_vcnt)
80 return bio_iovec(bio).bv_len;
81 else /* dataless requests such as discard */
82 return bio->bi_iter.bi_size;
83 }
84
85 static inline void *bio_data(struct bio *bio)
86 {
87 if (bio->bi_vcnt)
88 return page_address(bio_page(bio)) + bio_offset(bio);
89
90 return NULL;
91 }
92
93 /*
94 * will die
95 */
96 #define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
97 #define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
98
99 /*
100 * queues that have highmem support enabled may still need to revert to
101 * PIO transfers occasionally and thus map high pages temporarily. For
102 * permanent PIO fall back, user is probably better off disabling highmem
103 * I/O completely on that queue (see ide-dma for example)
104 */
105 #define __bio_kmap_atomic(bio, idx) \
106 (kmap_atomic(bio_iovec_idx((bio), (idx))->bv_page) + \
107 bio_iovec_idx((bio), (idx))->bv_offset)
108
109 #define __bio_kunmap_atomic(addr) kunmap_atomic(addr)
110
111 /*
112 * merge helpers etc
113 */
114
115 #define __BVEC_END(bio) bio_iovec_idx((bio), (bio)->bi_vcnt - 1)
116 #define __BVEC_START(bio) bio_iovec_idx((bio), (bio)->bi_iter.bi_idx)
117
118 /* Default implementation of BIOVEC_PHYS_MERGEABLE */
119 #define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
120 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
121
122 /*
123 * allow arch override, for eg virtualized architectures (put in asm/io.h)
124 */
125 #ifndef BIOVEC_PHYS_MERGEABLE
126 #define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
127 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
128 #endif
129
130 #define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
131 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
132 #define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
133 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, queue_segment_boundary((q)))
134 #define BIO_SEG_BOUNDARY(q, b1, b2) \
135 BIOVEC_SEG_BOUNDARY((q), __BVEC_END((b1)), __BVEC_START((b2)))
136
137 #define bio_io_error(bio) bio_endio((bio), -EIO)
138
139 /*
140 * drivers should _never_ use the all version - the bio may have been split
141 * before it got to the driver and the driver won't own all of it
142 */
143 #define bio_for_each_segment_all(bvl, bio, i) \
144 for (i = 0; \
145 bvl = bio_iovec_idx((bio), (i)), i < (bio)->bi_vcnt; \
146 i++)
147
148 #define __bio_for_each_segment(bvl, bio, iter, start) \
149 for (iter = (start); \
150 bvl = bio_iter_iovec((bio), (iter)), \
151 (iter).bi_idx < (bio)->bi_vcnt; \
152 (iter).bi_idx++)
153
154 #define bio_for_each_segment(bvl, bio, iter) \
155 __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
156
157 #define bio_iter_last(bio, iter) ((iter).bi_idx == (bio)->bi_vcnt - 1)
158
159 /*
160 * get a reference to a bio, so it won't disappear. the intended use is
161 * something like:
162 *
163 * bio_get(bio);
164 * submit_bio(rw, bio);
165 * if (bio->bi_flags ...)
166 * do_something
167 * bio_put(bio);
168 *
169 * without the bio_get(), it could potentially complete I/O before submit_bio
170 * returns. and then bio would be freed memory when if (bio->bi_flags ...)
171 * runs
172 */
173 #define bio_get(bio) atomic_inc(&(bio)->bi_cnt)
174
175 #if defined(CONFIG_BLK_DEV_INTEGRITY)
176 /*
177 * bio integrity payload
178 */
179 struct bio_integrity_payload {
180 struct bio *bip_bio; /* parent bio */
181
182 sector_t bip_sector; /* virtual start sector */
183
184 void *bip_buf; /* generated integrity data */
185 bio_end_io_t *bip_end_io; /* saved I/O completion fn */
186
187 unsigned int bip_size;
188
189 unsigned short bip_slab; /* slab the bip came from */
190 unsigned short bip_vcnt; /* # of integrity bio_vecs */
191 unsigned short bip_idx; /* current bip_vec index */
192 unsigned bip_owns_buf:1; /* should free bip_buf */
193
194 struct work_struct bip_work; /* I/O completion */
195
196 struct bio_vec *bip_vec;
197 struct bio_vec bip_inline_vecs[0];/* embedded bvec array */
198 };
199 #endif /* CONFIG_BLK_DEV_INTEGRITY */
200
201 /*
202 * A bio_pair is used when we need to split a bio.
203 * This can only happen for a bio that refers to just one
204 * page of data, and in the unusual situation when the
205 * page crosses a chunk/device boundary
206 *
207 * The address of the master bio is stored in bio1.bi_private
208 * The address of the pool the pair was allocated from is stored
209 * in bio2.bi_private
210 */
211 struct bio_pair {
212 struct bio bio1, bio2;
213 struct bio_vec bv1, bv2;
214 #if defined(CONFIG_BLK_DEV_INTEGRITY)
215 struct bio_integrity_payload bip1, bip2;
216 struct bio_vec iv1, iv2;
217 #endif
218 atomic_t cnt;
219 int error;
220 };
221 extern struct bio_pair *bio_split(struct bio *bi, int first_sectors);
222 extern void bio_pair_release(struct bio_pair *dbio);
223 extern void bio_trim(struct bio *bio, int offset, int size);
224
225 extern struct bio_set *bioset_create(unsigned int, unsigned int);
226 extern void bioset_free(struct bio_set *);
227 extern mempool_t *biovec_create_pool(struct bio_set *bs, int pool_entries);
228
229 extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
230 extern void bio_put(struct bio *);
231
232 extern void __bio_clone(struct bio *, struct bio *);
233 extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
234
235 extern struct bio_set *fs_bio_set;
236
237 static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
238 {
239 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
240 }
241
242 static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
243 {
244 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
245 }
246
247 static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
248 {
249 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
250 }
251
252 static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
253 {
254 return bio_clone_bioset(bio, gfp_mask, NULL);
255
256 }
257
258 extern void bio_endio(struct bio *, int);
259 struct request_queue;
260 extern int bio_phys_segments(struct request_queue *, struct bio *);
261
262 extern int submit_bio_wait(int rw, struct bio *bio);
263 extern void bio_advance(struct bio *, unsigned);
264
265 extern void bio_init(struct bio *);
266 extern void bio_reset(struct bio *);
267
268 extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
269 extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
270 unsigned int, unsigned int);
271 extern int bio_get_nr_vecs(struct block_device *);
272 extern sector_t bio_sector_offset(struct bio *, unsigned short, unsigned int);
273 extern struct bio *bio_map_user(struct request_queue *, struct block_device *,
274 unsigned long, unsigned int, int, gfp_t);
275 struct sg_iovec;
276 struct rq_map_data;
277 extern struct bio *bio_map_user_iov(struct request_queue *,
278 struct block_device *,
279 struct sg_iovec *, int, int, gfp_t);
280 extern void bio_unmap_user(struct bio *);
281 extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
282 gfp_t);
283 extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
284 gfp_t, int);
285 extern void bio_set_pages_dirty(struct bio *bio);
286 extern void bio_check_pages_dirty(struct bio *bio);
287
288 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
289 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
290 #endif
291 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
292 extern void bio_flush_dcache_pages(struct bio *bi);
293 #else
294 static inline void bio_flush_dcache_pages(struct bio *bi)
295 {
296 }
297 #endif
298
299 extern void bio_copy_data(struct bio *dst, struct bio *src);
300 extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
301
302 extern struct bio *bio_copy_user(struct request_queue *, struct rq_map_data *,
303 unsigned long, unsigned int, int, gfp_t);
304 extern struct bio *bio_copy_user_iov(struct request_queue *,
305 struct rq_map_data *, struct sg_iovec *,
306 int, int, gfp_t);
307 extern int bio_uncopy_user(struct bio *);
308 void zero_fill_bio(struct bio *bio);
309 extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
310 extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
311 extern unsigned int bvec_nr_vecs(unsigned short idx);
312
313 #ifdef CONFIG_BLK_CGROUP
314 int bio_associate_current(struct bio *bio);
315 void bio_disassociate_task(struct bio *bio);
316 #else /* CONFIG_BLK_CGROUP */
317 static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
318 static inline void bio_disassociate_task(struct bio *bio) { }
319 #endif /* CONFIG_BLK_CGROUP */
320
321 #ifdef CONFIG_HIGHMEM
322 /*
323 * remember never ever reenable interrupts between a bvec_kmap_irq and
324 * bvec_kunmap_irq!
325 */
326 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
327 {
328 unsigned long addr;
329
330 /*
331 * might not be a highmem page, but the preempt/irq count
332 * balancing is a lot nicer this way
333 */
334 local_irq_save(*flags);
335 addr = (unsigned long) kmap_atomic(bvec->bv_page);
336
337 BUG_ON(addr & ~PAGE_MASK);
338
339 return (char *) addr + bvec->bv_offset;
340 }
341
342 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
343 {
344 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
345
346 kunmap_atomic((void *) ptr);
347 local_irq_restore(*flags);
348 }
349
350 #else
351 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
352 {
353 return page_address(bvec->bv_page) + bvec->bv_offset;
354 }
355
356 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
357 {
358 *flags = 0;
359 }
360 #endif
361
362 static inline char *__bio_kmap_irq(struct bio *bio, unsigned short idx,
363 unsigned long *flags)
364 {
365 return bvec_kmap_irq(bio_iovec_idx(bio, idx), flags);
366 }
367 #define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
368
369 #define bio_kmap_irq(bio, flags) \
370 __bio_kmap_irq((bio), (bio)->bi_iter.bi_idx, (flags))
371 #define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
372
373 /*
374 * Check whether this bio carries any data or not. A NULL bio is allowed.
375 */
376 static inline bool bio_has_data(struct bio *bio)
377 {
378 if (bio && bio->bi_vcnt)
379 return true;
380
381 return false;
382 }
383
384 static inline bool bio_is_rw(struct bio *bio)
385 {
386 if (!bio_has_data(bio))
387 return false;
388
389 if (bio->bi_rw & REQ_WRITE_SAME)
390 return false;
391
392 return true;
393 }
394
395 static inline bool bio_mergeable(struct bio *bio)
396 {
397 if (bio->bi_rw & REQ_NOMERGE_FLAGS)
398 return false;
399
400 return true;
401 }
402
403 /*
404 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
405 *
406 * A bio_list anchors a singly-linked list of bios chained through the bi_next
407 * member of the bio. The bio_list also caches the last list member to allow
408 * fast access to the tail.
409 */
410 struct bio_list {
411 struct bio *head;
412 struct bio *tail;
413 };
414
415 static inline int bio_list_empty(const struct bio_list *bl)
416 {
417 return bl->head == NULL;
418 }
419
420 static inline void bio_list_init(struct bio_list *bl)
421 {
422 bl->head = bl->tail = NULL;
423 }
424
425 #define BIO_EMPTY_LIST { NULL, NULL }
426
427 #define bio_list_for_each(bio, bl) \
428 for (bio = (bl)->head; bio; bio = bio->bi_next)
429
430 static inline unsigned bio_list_size(const struct bio_list *bl)
431 {
432 unsigned sz = 0;
433 struct bio *bio;
434
435 bio_list_for_each(bio, bl)
436 sz++;
437
438 return sz;
439 }
440
441 static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
442 {
443 bio->bi_next = NULL;
444
445 if (bl->tail)
446 bl->tail->bi_next = bio;
447 else
448 bl->head = bio;
449
450 bl->tail = bio;
451 }
452
453 static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
454 {
455 bio->bi_next = bl->head;
456
457 bl->head = bio;
458
459 if (!bl->tail)
460 bl->tail = bio;
461 }
462
463 static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
464 {
465 if (!bl2->head)
466 return;
467
468 if (bl->tail)
469 bl->tail->bi_next = bl2->head;
470 else
471 bl->head = bl2->head;
472
473 bl->tail = bl2->tail;
474 }
475
476 static inline void bio_list_merge_head(struct bio_list *bl,
477 struct bio_list *bl2)
478 {
479 if (!bl2->head)
480 return;
481
482 if (bl->head)
483 bl2->tail->bi_next = bl->head;
484 else
485 bl->tail = bl2->tail;
486
487 bl->head = bl2->head;
488 }
489
490 static inline struct bio *bio_list_peek(struct bio_list *bl)
491 {
492 return bl->head;
493 }
494
495 static inline struct bio *bio_list_pop(struct bio_list *bl)
496 {
497 struct bio *bio = bl->head;
498
499 if (bio) {
500 bl->head = bl->head->bi_next;
501 if (!bl->head)
502 bl->tail = NULL;
503
504 bio->bi_next = NULL;
505 }
506
507 return bio;
508 }
509
510 static inline struct bio *bio_list_get(struct bio_list *bl)
511 {
512 struct bio *bio = bl->head;
513
514 bl->head = bl->tail = NULL;
515
516 return bio;
517 }
518
519 /*
520 * bio_set is used to allow other portions of the IO system to
521 * allocate their own private memory pools for bio and iovec structures.
522 * These memory pools in turn all allocate from the bio_slab
523 * and the bvec_slabs[].
524 */
525 #define BIO_POOL_SIZE 2
526 #define BIOVEC_NR_POOLS 6
527 #define BIOVEC_MAX_IDX (BIOVEC_NR_POOLS - 1)
528
529 struct bio_set {
530 struct kmem_cache *bio_slab;
531 unsigned int front_pad;
532
533 mempool_t *bio_pool;
534 mempool_t *bvec_pool;
535 #if defined(CONFIG_BLK_DEV_INTEGRITY)
536 mempool_t *bio_integrity_pool;
537 mempool_t *bvec_integrity_pool;
538 #endif
539
540 /*
541 * Deadlock avoidance for stacking block drivers: see comments in
542 * bio_alloc_bioset() for details
543 */
544 spinlock_t rescue_lock;
545 struct bio_list rescue_list;
546 struct work_struct rescue_work;
547 struct workqueue_struct *rescue_workqueue;
548 };
549
550 struct biovec_slab {
551 int nr_vecs;
552 char *name;
553 struct kmem_cache *slab;
554 };
555
556 /*
557 * a small number of entries is fine, not going to be performance critical.
558 * basically we just need to survive
559 */
560 #define BIO_SPLIT_ENTRIES 2
561
562 #if defined(CONFIG_BLK_DEV_INTEGRITY)
563
564 #define bip_vec_idx(bip, idx) (&(bip->bip_vec[(idx)]))
565 #define bip_vec(bip) bip_vec_idx(bip, 0)
566
567 #define __bip_for_each_vec(bvl, bip, i, start_idx) \
568 for (bvl = bip_vec_idx((bip), (start_idx)), i = (start_idx); \
569 i < (bip)->bip_vcnt; \
570 bvl++, i++)
571
572 #define bip_for_each_vec(bvl, bip, i) \
573 __bip_for_each_vec(bvl, bip, i, (bip)->bip_idx)
574
575 #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
576 for_each_bio(_bio) \
577 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
578
579 #define bio_integrity(bio) (bio->bi_integrity != NULL)
580
581 extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
582 extern void bio_integrity_free(struct bio *);
583 extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
584 extern int bio_integrity_enabled(struct bio *bio);
585 extern int bio_integrity_set_tag(struct bio *, void *, unsigned int);
586 extern int bio_integrity_get_tag(struct bio *, void *, unsigned int);
587 extern int bio_integrity_prep(struct bio *);
588 extern void bio_integrity_endio(struct bio *, int);
589 extern void bio_integrity_advance(struct bio *, unsigned int);
590 extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
591 extern void bio_integrity_split(struct bio *, struct bio_pair *, int);
592 extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
593 extern int bioset_integrity_create(struct bio_set *, int);
594 extern void bioset_integrity_free(struct bio_set *);
595 extern void bio_integrity_init(void);
596
597 #else /* CONFIG_BLK_DEV_INTEGRITY */
598
599 static inline int bio_integrity(struct bio *bio)
600 {
601 return 0;
602 }
603
604 static inline int bio_integrity_enabled(struct bio *bio)
605 {
606 return 0;
607 }
608
609 static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
610 {
611 return 0;
612 }
613
614 static inline void bioset_integrity_free (struct bio_set *bs)
615 {
616 return;
617 }
618
619 static inline int bio_integrity_prep(struct bio *bio)
620 {
621 return 0;
622 }
623
624 static inline void bio_integrity_free(struct bio *bio)
625 {
626 return;
627 }
628
629 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
630 gfp_t gfp_mask)
631 {
632 return 0;
633 }
634
635 static inline void bio_integrity_split(struct bio *bio, struct bio_pair *bp,
636 int sectors)
637 {
638 return;
639 }
640
641 static inline void bio_integrity_advance(struct bio *bio,
642 unsigned int bytes_done)
643 {
644 return;
645 }
646
647 static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
648 unsigned int sectors)
649 {
650 return;
651 }
652
653 static inline void bio_integrity_init(void)
654 {
655 return;
656 }
657
658 #endif /* CONFIG_BLK_DEV_INTEGRITY */
659
660 #endif /* CONFIG_BLOCK */
661 #endif /* __LINUX_BIO_H */