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