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