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