Merge tag 'v3.10.89' into update
[GitHub/mt8127/android_kernel_alcatel_ttab.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 extern int trap_non_toi_io;
36
37 #define BIO_DEBUG
38
39 #ifdef BIO_DEBUG
40 #define BIO_BUG_ON BUG_ON
41 #else
42 #define BIO_BUG_ON
43 #endif
44
45 #define BIO_MAX_PAGES 256
46 #define BIO_MAX_SIZE (BIO_MAX_PAGES << PAGE_CACHE_SHIFT)
47 #define BIO_MAX_SECTORS (BIO_MAX_SIZE >> 9)
48
49 /*
50 * upper 16 bits of bi_rw define the io priority of this bio
51 */
52 #define BIO_PRIO_SHIFT (8 * sizeof(unsigned long) - IOPRIO_BITS)
53 #define bio_prio(bio) ((bio)->bi_rw >> BIO_PRIO_SHIFT)
54 #define bio_prio_valid(bio) ioprio_valid(bio_prio(bio))
55
56 #define bio_set_prio(bio, prio) do { \
57 WARN_ON(prio >= (1 << IOPRIO_BITS)); \
58 (bio)->bi_rw &= ((1UL << BIO_PRIO_SHIFT) - 1); \
59 (bio)->bi_rw |= ((unsigned long) (prio) << BIO_PRIO_SHIFT); \
60 } while (0)
61
62 /*
63 * various member access, note that bio_data should of course not be used
64 * on highmem page vectors
65 */
66 #define bio_iovec_idx(bio, idx) (&((bio)->bi_io_vec[(idx)]))
67 #define bio_iovec(bio) bio_iovec_idx((bio), (bio)->bi_idx)
68 #define bio_page(bio) bio_iovec((bio))->bv_page
69 #define bio_offset(bio) bio_iovec((bio))->bv_offset
70 #define bio_segments(bio) ((bio)->bi_vcnt - (bio)->bi_idx)
71 #define bio_sectors(bio) ((bio)->bi_size >> 9)
72 #define bio_end_sector(bio) ((bio)->bi_sector + bio_sectors((bio)))
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 /*
91 * will die
92 */
93 #define bio_to_phys(bio) (page_to_phys(bio_page((bio))) + (unsigned long) bio_offset((bio)))
94 #define bvec_to_phys(bv) (page_to_phys((bv)->bv_page) + (unsigned long) (bv)->bv_offset)
95
96 /*
97 * queues that have highmem support enabled may still need to revert to
98 * PIO transfers occasionally and thus map high pages temporarily. For
99 * permanent PIO fall back, user is probably better off disabling highmem
100 * I/O completely on that queue (see ide-dma for example)
101 */
102 #define __bio_kmap_atomic(bio, idx, kmtype) \
103 (kmap_atomic(bio_iovec_idx((bio), (idx))->bv_page) + \
104 bio_iovec_idx((bio), (idx))->bv_offset)
105
106 #define __bio_kunmap_atomic(addr, kmtype) kunmap_atomic(addr)
107
108 /*
109 * merge helpers etc
110 */
111
112 #define __BVEC_END(bio) bio_iovec_idx((bio), (bio)->bi_vcnt - 1)
113 #define __BVEC_START(bio) bio_iovec_idx((bio), (bio)->bi_idx)
114
115 /* Default implementation of BIOVEC_PHYS_MERGEABLE */
116 #define __BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
117 ((bvec_to_phys((vec1)) + (vec1)->bv_len) == bvec_to_phys((vec2)))
118
119 /*
120 * allow arch override, for eg virtualized architectures (put in asm/io.h)
121 */
122 #ifndef BIOVEC_PHYS_MERGEABLE
123 #define BIOVEC_PHYS_MERGEABLE(vec1, vec2) \
124 __BIOVEC_PHYS_MERGEABLE(vec1, vec2)
125 #endif
126
127 #define __BIO_SEG_BOUNDARY(addr1, addr2, mask) \
128 (((addr1) | (mask)) == (((addr2) - 1) | (mask)))
129 #define BIOVEC_SEG_BOUNDARY(q, b1, b2) \
130 __BIO_SEG_BOUNDARY(bvec_to_phys((b1)), bvec_to_phys((b2)) + (b2)->bv_len, queue_segment_boundary((q)))
131 #define BIO_SEG_BOUNDARY(q, b1, b2) \
132 BIOVEC_SEG_BOUNDARY((q), __BVEC_END((b1)), __BVEC_START((b2)))
133
134 #define bio_io_error(bio) bio_endio((bio), -EIO)
135
136 /*
137 * drivers should not use the __ version unless they _really_ know what
138 * they're doing
139 */
140 #define __bio_for_each_segment(bvl, bio, i, start_idx) \
141 for (bvl = bio_iovec_idx((bio), (start_idx)), i = (start_idx); \
142 i < (bio)->bi_vcnt; \
143 bvl++, i++)
144
145 /*
146 * drivers should _never_ use the all version - the bio may have been split
147 * before it got to the driver and the driver won't own all of it
148 */
149 #define bio_for_each_segment_all(bvl, bio, i) \
150 for (i = 0; \
151 bvl = bio_iovec_idx((bio), (i)), i < (bio)->bi_vcnt; \
152 i++)
153
154 #define bio_for_each_segment(bvl, bio, i) \
155 for (i = (bio)->bi_idx; \
156 bvl = bio_iovec_idx((bio), (i)), i < (bio)->bi_vcnt; \
157 i++)
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
224 extern struct bio_set *bioset_create(unsigned int, unsigned int);
225 extern void bioset_free(struct bio_set *);
226 extern mempool_t *biovec_create_pool(struct bio_set *bs, int pool_entries);
227
228 extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
229 extern void bio_put(struct bio *);
230
231 extern void __bio_clone(struct bio *, struct bio *);
232 extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
233
234 extern struct bio_set *fs_bio_set;
235
236 static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
237 {
238 return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
239 }
240
241 static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
242 {
243 return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
244 }
245
246 static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
247 {
248 return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
249 }
250
251 static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
252 {
253 return bio_clone_bioset(bio, gfp_mask, NULL);
254
255 }
256
257 extern void bio_endio(struct bio *, int);
258 struct request_queue;
259 extern int bio_phys_segments(struct request_queue *, struct bio *);
260
261 extern int submit_bio_wait(int rw, struct bio *bio);
262 extern void bio_advance(struct bio *, unsigned);
263
264 extern void bio_init(struct bio *);
265 extern void bio_reset(struct bio *);
266
267 extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
268 extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
269 unsigned int, unsigned int);
270 extern int bio_get_nr_vecs(struct block_device *);
271 extern sector_t bio_sector_offset(struct bio *, unsigned short, unsigned int);
272 extern struct bio *bio_map_user(struct request_queue *, struct block_device *,
273 unsigned long, unsigned int, int, gfp_t);
274 struct sg_iovec;
275 struct rq_map_data;
276 extern struct bio *bio_map_user_iov(struct request_queue *,
277 struct block_device *,
278 struct sg_iovec *, int, int, gfp_t);
279 extern void bio_unmap_user(struct bio *);
280 extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
281 gfp_t);
282 extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
283 gfp_t, int);
284 extern void bio_set_pages_dirty(struct bio *bio);
285 extern void bio_check_pages_dirty(struct bio *bio);
286
287 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
288 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
289 #endif
290 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
291 extern void bio_flush_dcache_pages(struct bio *bi);
292 #else
293 static inline void bio_flush_dcache_pages(struct bio *bi)
294 {
295 }
296 #endif
297
298 extern void bio_copy_data(struct bio *dst, struct bio *src);
299 extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
300
301 extern struct bio *bio_copy_user(struct request_queue *, struct rq_map_data *,
302 unsigned long, unsigned int, int, gfp_t);
303 extern struct bio *bio_copy_user_iov(struct request_queue *,
304 struct rq_map_data *, struct sg_iovec *,
305 int, int, gfp_t);
306 extern int bio_uncopy_user(struct bio *);
307 void zero_fill_bio(struct bio *bio);
308 extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
309 extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
310 extern unsigned int bvec_nr_vecs(unsigned short idx);
311
312 #ifdef CONFIG_BLK_CGROUP
313 int bio_associate_current(struct bio *bio);
314 void bio_disassociate_task(struct bio *bio);
315 #else /* CONFIG_BLK_CGROUP */
316 static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
317 static inline void bio_disassociate_task(struct bio *bio) { }
318 #endif /* CONFIG_BLK_CGROUP */
319
320 #ifdef CONFIG_HIGHMEM
321 /*
322 * remember never ever reenable interrupts between a bvec_kmap_irq and
323 * bvec_kunmap_irq!
324 */
325 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
326 {
327 unsigned long addr;
328
329 /*
330 * might not be a highmem page, but the preempt/irq count
331 * balancing is a lot nicer this way
332 */
333 local_irq_save(*flags);
334 addr = (unsigned long) kmap_atomic(bvec->bv_page);
335
336 BUG_ON(addr & ~PAGE_MASK);
337
338 return (char *) addr + bvec->bv_offset;
339 }
340
341 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
342 {
343 unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
344
345 kunmap_atomic((void *) ptr);
346 local_irq_restore(*flags);
347 }
348
349 #else
350 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
351 {
352 return page_address(bvec->bv_page) + bvec->bv_offset;
353 }
354
355 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
356 {
357 *flags = 0;
358 }
359 #endif
360
361 static inline char *__bio_kmap_irq(struct bio *bio, unsigned short idx,
362 unsigned long *flags)
363 {
364 return bvec_kmap_irq(bio_iovec_idx(bio, idx), flags);
365 }
366 #define __bio_kunmap_irq(buf, flags) bvec_kunmap_irq(buf, flags)
367
368 #define bio_kmap_irq(bio, flags) \
369 __bio_kmap_irq((bio), (bio)->bi_idx, (flags))
370 #define bio_kunmap_irq(buf,flags) __bio_kunmap_irq(buf, flags)
371
372 /*
373 * Check whether this bio carries any data or not. A NULL bio is allowed.
374 */
375 static inline bool bio_has_data(struct bio *bio)
376 {
377 if (bio && bio->bi_vcnt)
378 return true;
379
380 return false;
381 }
382
383 static inline bool bio_is_rw(struct bio *bio)
384 {
385 if (!bio_has_data(bio))
386 return false;
387
388 if (bio->bi_rw & REQ_WRITE_SAME)
389 return false;
390
391 return true;
392 }
393
394 static inline bool bio_mergeable(struct bio *bio)
395 {
396 if (bio->bi_rw & REQ_NOMERGE_FLAGS)
397 return false;
398
399 return true;
400 }
401
402 /*
403 * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
404 *
405 * A bio_list anchors a singly-linked list of bios chained through the bi_next
406 * member of the bio. The bio_list also caches the last list member to allow
407 * fast access to the tail.
408 */
409 struct bio_list {
410 struct bio *head;
411 struct bio *tail;
412 };
413
414 static inline int bio_list_empty(const struct bio_list *bl)
415 {
416 return bl->head == NULL;
417 }
418
419 static inline void bio_list_init(struct bio_list *bl)
420 {
421 bl->head = bl->tail = NULL;
422 }
423
424 #define bio_list_for_each(bio, bl) \
425 for (bio = (bl)->head; bio; bio = bio->bi_next)
426
427 static inline unsigned bio_list_size(const struct bio_list *bl)
428 {
429 unsigned sz = 0;
430 struct bio *bio;
431
432 bio_list_for_each(bio, bl)
433 sz++;
434
435 return sz;
436 }
437
438 static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
439 {
440 bio->bi_next = NULL;
441
442 if (bl->tail)
443 bl->tail->bi_next = bio;
444 else
445 bl->head = bio;
446
447 bl->tail = bio;
448 }
449
450 static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
451 {
452 bio->bi_next = bl->head;
453
454 bl->head = bio;
455
456 if (!bl->tail)
457 bl->tail = bio;
458 }
459
460 static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
461 {
462 if (!bl2->head)
463 return;
464
465 if (bl->tail)
466 bl->tail->bi_next = bl2->head;
467 else
468 bl->head = bl2->head;
469
470 bl->tail = bl2->tail;
471 }
472
473 static inline void bio_list_merge_head(struct bio_list *bl,
474 struct bio_list *bl2)
475 {
476 if (!bl2->head)
477 return;
478
479 if (bl->head)
480 bl2->tail->bi_next = bl->head;
481 else
482 bl->tail = bl2->tail;
483
484 bl->head = bl2->head;
485 }
486
487 static inline struct bio *bio_list_peek(struct bio_list *bl)
488 {
489 return bl->head;
490 }
491
492 static inline struct bio *bio_list_pop(struct bio_list *bl)
493 {
494 struct bio *bio = bl->head;
495
496 if (bio) {
497 bl->head = bl->head->bi_next;
498 if (!bl->head)
499 bl->tail = NULL;
500
501 bio->bi_next = NULL;
502 }
503
504 return bio;
505 }
506
507 static inline struct bio *bio_list_get(struct bio_list *bl)
508 {
509 struct bio *bio = bl->head;
510
511 bl->head = bl->tail = NULL;
512
513 return bio;
514 }
515
516 /*
517 * bio_set is used to allow other portions of the IO system to
518 * allocate their own private memory pools for bio and iovec structures.
519 * These memory pools in turn all allocate from the bio_slab
520 * and the bvec_slabs[].
521 */
522 #define BIO_POOL_SIZE 2
523 #define BIOVEC_NR_POOLS 6
524 #define BIOVEC_MAX_IDX (BIOVEC_NR_POOLS - 1)
525
526 struct bio_set {
527 struct kmem_cache *bio_slab;
528 unsigned int front_pad;
529
530 mempool_t *bio_pool;
531 mempool_t *bvec_pool;
532 #if defined(CONFIG_BLK_DEV_INTEGRITY)
533 mempool_t *bio_integrity_pool;
534 mempool_t *bvec_integrity_pool;
535 #endif
536
537 /*
538 * Deadlock avoidance for stacking block drivers: see comments in
539 * bio_alloc_bioset() for details
540 */
541 spinlock_t rescue_lock;
542 struct bio_list rescue_list;
543 struct work_struct rescue_work;
544 struct workqueue_struct *rescue_workqueue;
545 };
546
547 struct biovec_slab {
548 int nr_vecs;
549 char *name;
550 struct kmem_cache *slab;
551 };
552
553 /*
554 * a small number of entries is fine, not going to be performance critical.
555 * basically we just need to survive
556 */
557 #define BIO_SPLIT_ENTRIES 2
558
559 #if defined(CONFIG_BLK_DEV_INTEGRITY)
560
561 #define bip_vec_idx(bip, idx) (&(bip->bip_vec[(idx)]))
562 #define bip_vec(bip) bip_vec_idx(bip, 0)
563
564 #define __bip_for_each_vec(bvl, bip, i, start_idx) \
565 for (bvl = bip_vec_idx((bip), (start_idx)), i = (start_idx); \
566 i < (bip)->bip_vcnt; \
567 bvl++, i++)
568
569 #define bip_for_each_vec(bvl, bip, i) \
570 __bip_for_each_vec(bvl, bip, i, (bip)->bip_idx)
571
572 #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
573 for_each_bio(_bio) \
574 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
575
576 #define bio_integrity(bio) (bio->bi_integrity != NULL)
577
578 extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
579 extern void bio_integrity_free(struct bio *);
580 extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
581 extern int bio_integrity_enabled(struct bio *bio);
582 extern int bio_integrity_set_tag(struct bio *, void *, unsigned int);
583 extern int bio_integrity_get_tag(struct bio *, void *, unsigned int);
584 extern int bio_integrity_prep(struct bio *);
585 extern void bio_integrity_endio(struct bio *, int);
586 extern void bio_integrity_advance(struct bio *, unsigned int);
587 extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
588 extern void bio_integrity_split(struct bio *, struct bio_pair *, int);
589 extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
590 extern int bioset_integrity_create(struct bio_set *, int);
591 extern void bioset_integrity_free(struct bio_set *);
592 extern void bio_integrity_init(void);
593
594 #else /* CONFIG_BLK_DEV_INTEGRITY */
595
596 static inline int bio_integrity(struct bio *bio)
597 {
598 return 0;
599 }
600
601 static inline int bio_integrity_enabled(struct bio *bio)
602 {
603 return 0;
604 }
605
606 static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
607 {
608 return 0;
609 }
610
611 static inline void bioset_integrity_free (struct bio_set *bs)
612 {
613 return;
614 }
615
616 static inline int bio_integrity_prep(struct bio *bio)
617 {
618 return 0;
619 }
620
621 static inline void bio_integrity_free(struct bio *bio)
622 {
623 return;
624 }
625
626 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
627 gfp_t gfp_mask)
628 {
629 return 0;
630 }
631
632 static inline void bio_integrity_split(struct bio *bio, struct bio_pair *bp,
633 int sectors)
634 {
635 return;
636 }
637
638 static inline void bio_integrity_advance(struct bio *bio,
639 unsigned int bytes_done)
640 {
641 return;
642 }
643
644 static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
645 unsigned int sectors)
646 {
647 return;
648 }
649
650 static inline void bio_integrity_init(void)
651 {
652 return;
653 }
654
655 #endif /* CONFIG_BLK_DEV_INTEGRITY */
656
657 #endif /* CONFIG_BLOCK */
658 #endif /* __LINUX_BIO_H */