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         struct bio_vec          bip_vec[0];     /* embedded bvec array */
 186 };
 187 #endif /* CONFIG_BLK_DEV_INTEGRITY */
 188
 189 /*
 190  * A bio_pair is used when we need to split a bio.
 191  * This can only happen for a bio that refers to just one
 192  * page of data, and in the unusual situation when the
 193  * page crosses a chunk/device boundary
 194  *
 195  * The address of the master bio is stored in bio1.bi_private
 196  * The address of the pool the pair was allocated from is stored
 197  *   in bio2.bi_private
 198  */
 199 struct bio_pair {
 200         struct bio                      bio1, bio2;
 201         struct bio_vec                  bv1, bv2;
 202 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 203         struct bio_integrity_payload    bip1, bip2;
 204         struct bio_vec                  iv1, iv2;
 205 #endif
 206         atomic_t                        cnt;
 207         int                             error;
 208 };
 209 extern struct bio_pair *bio_split(struct bio *bi, int first_sectors);
 210 extern void bio_pair_release(struct bio_pair *dbio);
 211
 212 extern struct bio_set *bioset_create(unsigned int, unsigned int);
 213 extern void bioset_free(struct bio_set *);
 214
 215 extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
 216 extern void bio_put(struct bio *);
 217
 218 extern struct bio_set *fs_bio_set;
 219
 220 static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
 221 {
 222         return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
 223 }
 224
 225 static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
 226 {
 227         return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
 228 }
 229
 230 extern void bio_endio(struct bio *, int);
 231 struct request_queue;
 232 extern int bio_phys_segments(struct request_queue *, struct bio *);
 233
 234 extern void __bio_clone(struct bio *, struct bio *);
 235 extern struct bio *bio_clone(struct bio *, gfp_t);
 236
 237 extern void bio_init(struct bio *);
 238 extern void bio_reset(struct bio *);
 239
 240 extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
 241 extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
 242                            unsigned int, unsigned int);
 243 extern int bio_get_nr_vecs(struct block_device *);
 244 extern sector_t bio_sector_offset(struct bio *, unsigned short, unsigned int);
 245 extern struct bio *bio_map_user(struct request_queue *, struct block_device *,
 246                                 unsigned long, unsigned int, int, gfp_t);
 247 struct sg_iovec;
 248 struct rq_map_data;
 249 extern struct bio *bio_map_user_iov(struct request_queue *,
 250                                     struct block_device *,
 251                                     struct sg_iovec *, int, int, gfp_t);
 252 extern void bio_unmap_user(struct bio *);
 253 extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
 254                                 gfp_t);
 255 extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
 256                                  gfp_t, int);
 257 extern void bio_set_pages_dirty(struct bio *bio);
 258 extern void bio_check_pages_dirty(struct bio *bio);
 259
 260 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 261 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
 262 #endif
 263 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 264 extern void bio_flush_dcache_pages(struct bio *bi);
 265 #else
 266 static inline void bio_flush_dcache_pages(struct bio *bi)
 267 {
 268 }
 269 #endif
 270
 271 extern struct bio *bio_copy_user(struct request_queue *, struct rq_map_data *,
 272                                  unsigned long, unsigned int, int, gfp_t);
 273 extern struct bio *bio_copy_user_iov(struct request_queue *,
 274                                      struct rq_map_data *, struct sg_iovec *,
 275                                      int, int, gfp_t);
 276 extern int bio_uncopy_user(struct bio *);
 277 void zero_fill_bio(struct bio *bio);
 278 extern struct bio_vec *bvec_alloc_bs(gfp_t, int, unsigned long *, struct bio_set *);
 279 extern void bvec_free_bs(struct bio_set *, struct bio_vec *, unsigned int);
 280 extern unsigned int bvec_nr_vecs(unsigned short idx);
 281
 282 #ifdef CONFIG_BLK_CGROUP
 283 int bio_associate_current(struct bio *bio);
 284 void bio_disassociate_task(struct bio *bio);
 285 #else   /* CONFIG_BLK_CGROUP */
 286 static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
 287 static inline void bio_disassociate_task(struct bio *bio) { }
 288 #endif  /* CONFIG_BLK_CGROUP */
 289
 290 /*
 291  * bio_set is used to allow other portions of the IO system to
 292  * allocate their own private memory pools for bio and iovec structures.
 293  * These memory pools in turn all allocate from the bio_slab
 294  * and the bvec_slabs[].
 295  */
 296 #define BIO_POOL_SIZE 2
 297 #define BIOVEC_NR_POOLS 6
 298 #define BIOVEC_MAX_IDX  (BIOVEC_NR_POOLS - 1)
 299
 300 struct bio_set {
 301         struct kmem_cache *bio_slab;
 302         unsigned int front_pad;
 303
 304         mempool_t *bio_pool;
 305 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 306         mempool_t *bio_integrity_pool;
 307 #endif
 308         mempool_t *bvec_pool;
 309 };
 310
 311 struct biovec_slab {
 312         int nr_vecs;
 313         char *name;
 314         struct kmem_cache *slab;
 315 };
 316
 317 /*
 318  * a small number of entries is fine, not going to be performance critical.
 319  * basically we just need to survive
 320  */
 321 #define BIO_SPLIT_ENTRIES 2
 322
 323 #ifdef CONFIG_HIGHMEM
 324 /*
 325  * remember never ever reenable interrupts between a bvec_kmap_irq and
 326  * bvec_kunmap_irq!
 327  */
 328 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
 329 {
 330         unsigned long addr;
 331
 332         /*
 333          * might not be a highmem page, but the preempt/irq count
 334          * balancing is a lot nicer this way
 335          */
 336         local_irq_save(*flags);
 337         addr = (unsigned long) kmap_atomic(bvec->bv_page);
 338
 339         BUG_ON(addr & ~PAGE_MASK);
 340
 341         return (char *) addr + bvec->bv_offset;
 342 }
 343
 344 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
 345 {
 346         unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
 347
 348         kunmap_atomic((void *) ptr);
 349         local_irq_restore(*flags);
 350 }
 351
 352 #else
 353 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
 354 {
 355         return page_address(bvec->bv_page) + bvec->bv_offset;
 356 }
 357
 358 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
 359 {
 360         *flags = 0;
 361 }
 362 #endif
 363
 364 static inline char *__bio_kmap_irq(struct bio *bio, unsigned short idx,
 365                                    unsigned long *flags)
 366 {
 367         return bvec_kmap_irq(bio_iovec_idx(bio, idx), flags);
 368 }
 369 #define __bio_kunmap_irq(buf, flags)    bvec_kunmap_irq(buf, flags)
 370
 371 #define bio_kmap_irq(bio, flags) \
 372         __bio_kmap_irq((bio), (bio)->bi_idx, (flags))
 373 #define bio_kunmap_irq(buf,flags)       __bio_kunmap_irq(buf, flags)
 374
 375 /*
 376  * Check whether this bio carries any data or not. A NULL bio is allowed.
 377  */
 378 static inline int bio_has_data(struct bio *bio)
 379 {
 380         return bio && bio->bi_io_vec != NULL;
 381 }
 382
 383 /*
 384  * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
 385  *
 386  * A bio_list anchors a singly-linked list of bios chained through the bi_next
 387  * member of the bio.  The bio_list also caches the last list member to allow
 388  * fast access to the tail.
 389  */
 390 struct bio_list {
 391         struct bio *head;
 392         struct bio *tail;
 393 };
 394
 395 static inline int bio_list_empty(const struct bio_list *bl)
 396 {
 397         return bl->head == NULL;
 398 }
 399
 400 static inline void bio_list_init(struct bio_list *bl)
 401 {
 402         bl->head = bl->tail = NULL;
 403 }
 404
 405 #define bio_list_for_each(bio, bl) \
 406         for (bio = (bl)->head; bio; bio = bio->bi_next)
 407
 408 static inline unsigned bio_list_size(const struct bio_list *bl)
 409 {
 410         unsigned sz = 0;
 411         struct bio *bio;
 412
 413         bio_list_for_each(bio, bl)
 414                 sz++;
 415
 416         return sz;
 417 }
 418
 419 static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
 420 {
 421         bio->bi_next = NULL;
 422
 423         if (bl->tail)
 424                 bl->tail->bi_next = bio;
 425         else
 426                 bl->head = bio;
 427
 428         bl->tail = bio;
 429 }
 430
 431 static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
 432 {
 433         bio->bi_next = bl->head;
 434
 435         bl->head = bio;
 436
 437         if (!bl->tail)
 438                 bl->tail = bio;
 439 }
 440
 441 static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
 442 {
 443         if (!bl2->head)
 444                 return;
 445
 446         if (bl->tail)
 447                 bl->tail->bi_next = bl2->head;
 448         else
 449                 bl->head = bl2->head;
 450
 451         bl->tail = bl2->tail;
 452 }
 453
 454 static inline void bio_list_merge_head(struct bio_list *bl,
 455                                        struct bio_list *bl2)
 456 {
 457         if (!bl2->head)
 458                 return;
 459
 460         if (bl->head)
 461                 bl2->tail->bi_next = bl->head;
 462         else
 463                 bl->tail = bl2->tail;
 464
 465         bl->head = bl2->head;
 466 }
 467
 468 static inline struct bio *bio_list_peek(struct bio_list *bl)
 469 {
 470         return bl->head;
 471 }
 472
 473 static inline struct bio *bio_list_pop(struct bio_list *bl)
 474 {
 475         struct bio *bio = bl->head;
 476
 477         if (bio) {
 478                 bl->head = bl->head->bi_next;
 479                 if (!bl->head)
 480                         bl->tail = NULL;
 481
 482                 bio->bi_next = NULL;
 483         }
 484
 485         return bio;
 486 }
 487
 488 static inline struct bio *bio_list_get(struct bio_list *bl)
 489 {
 490         struct bio *bio = bl->head;
 491
 492         bl->head = bl->tail = NULL;
 493
 494         return bio;
 495 }
 496
 497 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 498
 499 #define bip_vec_idx(bip, idx)   (&(bip->bip_vec[(idx)]))
 500 #define bip_vec(bip)            bip_vec_idx(bip, 0)
 501
 502 #define __bip_for_each_vec(bvl, bip, i, start_idx)                      \
 503         for (bvl = bip_vec_idx((bip), (start_idx)), i = (start_idx);    \
 504              i < (bip)->bip_vcnt;                                       \
 505              bvl++, i++)
 506
 507 #define bip_for_each_vec(bvl, bip, i)                                   \
 508         __bip_for_each_vec(bvl, bip, i, (bip)->bip_idx)
 509
 510 #define bio_for_each_integrity_vec(_bvl, _bio, _iter)                   \
 511         for_each_bio(_bio)                                              \
 512                 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
 513
 514 #define bio_integrity(bio) (bio->bi_integrity != NULL)
 515
 516 extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
 517 extern void bio_integrity_free(struct bio *);
 518 extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
 519 extern int bio_integrity_enabled(struct bio *bio);
 520 extern int bio_integrity_set_tag(struct bio *, void *, unsigned int);
 521 extern int bio_integrity_get_tag(struct bio *, void *, unsigned int);
 522 extern int bio_integrity_prep(struct bio *);
 523 extern void bio_integrity_endio(struct bio *, int);
 524 extern void bio_integrity_advance(struct bio *, unsigned int);
 525 extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
 526 extern void bio_integrity_split(struct bio *, struct bio_pair *, int);
 527 extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
 528 extern int bioset_integrity_create(struct bio_set *, int);
 529 extern void bioset_integrity_free(struct bio_set *);
 530 extern void bio_integrity_init(void);
 531
 532 #else /* CONFIG_BLK_DEV_INTEGRITY */
 533
 534 static inline int bio_integrity(struct bio *bio)
 535 {
 536         return 0;
 537 }
 538
 539 static inline int bio_integrity_enabled(struct bio *bio)
 540 {
 541         return 0;
 542 }
 543
 544 static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
 545 {
 546         return 0;
 547 }
 548
 549 static inline void bioset_integrity_free (struct bio_set *bs)
 550 {
 551         return;
 552 }
 553
 554 static inline int bio_integrity_prep(struct bio *bio)
 555 {
 556         return 0;
 557 }
 558
 559 static inline void bio_integrity_free(struct bio *bio)
 560 {
 561         return;
 562 }
 563
 564 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
 565                                       gfp_t gfp_mask)
 566 {
 567         return 0;
 568 }
 569
 570 static inline void bio_integrity_split(struct bio *bio, struct bio_pair *bp,
 571                                        int sectors)
 572 {
 573         return;
 574 }
 575
 576 static inline void bio_integrity_advance(struct bio *bio,
 577                                          unsigned int bytes_done)
 578 {
 579         return;
 580 }
 581
 582 static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
 583                                       unsigned int sectors)
 584 {
 585         return;
 586 }
 587
 588 static inline void bio_integrity_init(void)
 589 {
 590         return;
 591 }
 592
 593 #endif /* CONFIG_BLK_DEV_INTEGRITY */
 594
 595 #endif /* CONFIG_BLOCK */
 596 #endif /* __LINUX_BIO_H */