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 /*
 190  * Check if adding a bio_vec after bprv with offset would create a gap in
 191  * the SG list. Most drivers don't care about this, but some do.
 192  */
 193 static inline bool bvec_gap_to_prev(struct bio_vec *bprv, unsigned int offset)
 194 {
 195         return offset || ((bprv->bv_offset + bprv->bv_len) & (PAGE_SIZE - 1));
 196 }
 197
 198 #define bio_io_error(bio) bio_endio((bio), -EIO)
 199
 200 /*
 201  * drivers should _never_ use the all version - the bio may have been split
 202  * before it got to the driver and the driver won't own all of it
 203  */
 204 #define bio_for_each_segment_all(bvl, bio, i)                           \
 205         for (i = 0, bvl = (bio)->bi_io_vec; i < (bio)->bi_vcnt; i++, bvl++)
 206
 207 static inline void bvec_iter_advance(struct bio_vec *bv, struct bvec_iter *iter,
 208                                      unsigned bytes)
 209 {
 210         WARN_ONCE(bytes > iter->bi_size,
 211                   "Attempted to advance past end of bvec iter\n");
 212
 213         while (bytes) {
 214                 unsigned len = min(bytes, bvec_iter_len(bv, *iter));
 215
 216                 bytes -= len;
 217                 iter->bi_size -= len;
 218                 iter->bi_bvec_done += len;
 219
 220                 if (iter->bi_bvec_done == __bvec_iter_bvec(bv, *iter)->bv_len) {
 221                         iter->bi_bvec_done = 0;
 222                         iter->bi_idx++;
 223                 }
 224         }
 225 }
 226
 227 #define for_each_bvec(bvl, bio_vec, iter, start)                        \
 228         for (iter = (start);                                            \
 229              (iter).bi_size &&                                          \
 230                 ((bvl = bvec_iter_bvec((bio_vec), (iter))), 1); \
 231              bvec_iter_advance((bio_vec), &(iter), (bvl).bv_len))
 232
 233
 234 static inline void bio_advance_iter(struct bio *bio, struct bvec_iter *iter,
 235                                     unsigned bytes)
 236 {
 237         iter->bi_sector += bytes >> 9;
 238
 239         if (bio->bi_rw & BIO_NO_ADVANCE_ITER_MASK)
 240                 iter->bi_size -= bytes;
 241         else
 242                 bvec_iter_advance(bio->bi_io_vec, iter, bytes);
 243 }
 244
 245 #define __bio_for_each_segment(bvl, bio, iter, start)                   \
 246         for (iter = (start);                                            \
 247              (iter).bi_size &&                                          \
 248                 ((bvl = bio_iter_iovec((bio), (iter))), 1);             \
 249              bio_advance_iter((bio), &(iter), (bvl).bv_len))
 250
 251 #define bio_for_each_segment(bvl, bio, iter)                            \
 252         __bio_for_each_segment(bvl, bio, iter, (bio)->bi_iter)
 253
 254 #define bio_iter_last(bvec, iter) ((iter).bi_size == (bvec).bv_len)
 255
 256 static inline unsigned bio_segments(struct bio *bio)
 257 {
 258         unsigned segs = 0;
 259         struct bio_vec bv;
 260         struct bvec_iter iter;
 261
 262         /*
 263          * We special case discard/write same, because they interpret bi_size
 264          * differently:
 265          */
 266
 267         if (bio->bi_rw & REQ_DISCARD)
 268                 return 1;
 269
 270         if (bio->bi_rw & REQ_WRITE_SAME)
 271                 return 1;
 272
 273         bio_for_each_segment(bv, bio, iter)
 274                 segs++;
 275
 276         return segs;
 277 }
 278
 279 /*
 280  * get a reference to a bio, so it won't disappear. the intended use is
 281  * something like:
 282  *
 283  * bio_get(bio);
 284  * submit_bio(rw, bio);
 285  * if (bio->bi_flags ...)
 286  *      do_something
 287  * bio_put(bio);
 288  *
 289  * without the bio_get(), it could potentially complete I/O before submit_bio
 290  * returns. and then bio would be freed memory when if (bio->bi_flags ...)
 291  * runs
 292  */
 293 #define bio_get(bio)    atomic_inc(&(bio)->bi_cnt)
 294
 295 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 296
 297 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
 298 {
 299         if (bio->bi_rw & REQ_INTEGRITY)
 300                 return bio->bi_integrity;
 301
 302         return NULL;
 303 }
 304
 305 /*
 306  * bio integrity payload
 307  */
 308 struct bio_integrity_payload {
 309         struct bio              *bip_bio;       /* parent bio */
 310
 311         struct bvec_iter        bip_iter;
 312
 313         bio_end_io_t            *bip_end_io;    /* saved I/O completion fn */
 314
 315         unsigned short          bip_slab;       /* slab the bip came from */
 316         unsigned short          bip_vcnt;       /* # of integrity bio_vecs */
 317         unsigned short          bip_max_vcnt;   /* integrity bio_vec slots */
 318         unsigned                bip_owns_buf:1; /* should free bip_buf */
 319
 320         struct work_struct      bip_work;       /* I/O completion */
 321
 322         struct bio_vec          *bip_vec;
 323         struct bio_vec          bip_inline_vecs[0];/* embedded bvec array */
 324 };
 325 #endif /* CONFIG_BLK_DEV_INTEGRITY */
 326
 327 extern void bio_trim(struct bio *bio, int offset, int size);
 328 extern struct bio *bio_split(struct bio *bio, int sectors,
 329                              gfp_t gfp, struct bio_set *bs);
 330
 331 /**
 332  * bio_next_split - get next @sectors from a bio, splitting if necessary
 333  * @bio:        bio to split
 334  * @sectors:    number of sectors to split from the front of @bio
 335  * @gfp:        gfp mask
 336  * @bs:         bio set to allocate from
 337  *
 338  * Returns a bio representing the next @sectors of @bio - if the bio is smaller
 339  * than @sectors, returns the original bio unchanged.
 340  */
 341 static inline struct bio *bio_next_split(struct bio *bio, int sectors,
 342                                          gfp_t gfp, struct bio_set *bs)
 343 {
 344         if (sectors >= bio_sectors(bio))
 345                 return bio;
 346
 347         return bio_split(bio, sectors, gfp, bs);
 348 }
 349
 350 extern struct bio_set *bioset_create(unsigned int, unsigned int);
 351 extern void bioset_free(struct bio_set *);
 352 extern mempool_t *biovec_create_pool(int pool_entries);
 353
 354 extern struct bio *bio_alloc_bioset(gfp_t, int, struct bio_set *);
 355 extern void bio_put(struct bio *);
 356
 357 extern void __bio_clone_fast(struct bio *, struct bio *);
 358 extern struct bio *bio_clone_fast(struct bio *, gfp_t, struct bio_set *);
 359 extern struct bio *bio_clone_bioset(struct bio *, gfp_t, struct bio_set *bs);
 360
 361 extern struct bio_set *fs_bio_set;
 362
 363 static inline struct bio *bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs)
 364 {
 365         return bio_alloc_bioset(gfp_mask, nr_iovecs, fs_bio_set);
 366 }
 367
 368 static inline struct bio *bio_clone(struct bio *bio, gfp_t gfp_mask)
 369 {
 370         return bio_clone_bioset(bio, gfp_mask, fs_bio_set);
 371 }
 372
 373 static inline struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned int nr_iovecs)
 374 {
 375         return bio_alloc_bioset(gfp_mask, nr_iovecs, NULL);
 376 }
 377
 378 static inline struct bio *bio_clone_kmalloc(struct bio *bio, gfp_t gfp_mask)
 379 {
 380         return bio_clone_bioset(bio, gfp_mask, NULL);
 381
 382 }
 383
 384 extern void bio_endio(struct bio *, int);
 385 extern void bio_endio_nodec(struct bio *, int);
 386 struct request_queue;
 387 extern int bio_phys_segments(struct request_queue *, struct bio *);
 388
 389 extern int submit_bio_wait(int rw, struct bio *bio);
 390 extern void bio_advance(struct bio *, unsigned);
 391
 392 extern void bio_init(struct bio *);
 393 extern void bio_reset(struct bio *);
 394 void bio_chain(struct bio *, struct bio *);
 395
 396 extern int bio_add_page(struct bio *, struct page *, unsigned int,unsigned int);
 397 extern int bio_add_pc_page(struct request_queue *, struct bio *, struct page *,
 398                            unsigned int, unsigned int);
 399 extern int bio_get_nr_vecs(struct block_device *);
 400 extern struct bio *bio_map_user(struct request_queue *, struct block_device *,
 401                                 unsigned long, unsigned int, int, gfp_t);
 402 struct sg_iovec;
 403 struct rq_map_data;
 404 extern struct bio *bio_map_user_iov(struct request_queue *,
 405                                     struct block_device *,
 406                                     const struct sg_iovec *, int, int, gfp_t);
 407 extern void bio_unmap_user(struct bio *);
 408 extern struct bio *bio_map_kern(struct request_queue *, void *, unsigned int,
 409                                 gfp_t);
 410 extern struct bio *bio_copy_kern(struct request_queue *, void *, unsigned int,
 411                                  gfp_t, int);
 412 extern void bio_set_pages_dirty(struct bio *bio);
 413 extern void bio_check_pages_dirty(struct bio *bio);
 414
 415 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 416 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
 417 #endif
 418 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 419 extern void bio_flush_dcache_pages(struct bio *bi);
 420 #else
 421 static inline void bio_flush_dcache_pages(struct bio *bi)
 422 {
 423 }
 424 #endif
 425
 426 extern void bio_copy_data(struct bio *dst, struct bio *src);
 427 extern int bio_alloc_pages(struct bio *bio, gfp_t gfp);
 428
 429 extern struct bio *bio_copy_user(struct request_queue *, struct rq_map_data *,
 430                                  unsigned long, unsigned int, int, gfp_t);
 431 extern struct bio *bio_copy_user_iov(struct request_queue *,
 432                                      struct rq_map_data *,
 433                                      const struct sg_iovec *,
 434                                      int, int, gfp_t);
 435 extern int bio_uncopy_user(struct bio *);
 436 void zero_fill_bio(struct bio *bio);
 437 extern struct bio_vec *bvec_alloc(gfp_t, int, unsigned long *, mempool_t *);
 438 extern void bvec_free(mempool_t *, struct bio_vec *, unsigned int);
 439 extern unsigned int bvec_nr_vecs(unsigned short idx);
 440
 441 #ifdef CONFIG_BLK_CGROUP
 442 int bio_associate_current(struct bio *bio);
 443 void bio_disassociate_task(struct bio *bio);
 444 #else   /* CONFIG_BLK_CGROUP */
 445 static inline int bio_associate_current(struct bio *bio) { return -ENOENT; }
 446 static inline void bio_disassociate_task(struct bio *bio) { }
 447 #endif  /* CONFIG_BLK_CGROUP */
 448
 449 #ifdef CONFIG_HIGHMEM
 450 /*
 451  * remember never ever reenable interrupts between a bvec_kmap_irq and
 452  * bvec_kunmap_irq!
 453  */
 454 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
 455 {
 456         unsigned long addr;
 457
 458         /*
 459          * might not be a highmem page, but the preempt/irq count
 460          * balancing is a lot nicer this way
 461          */
 462         local_irq_save(*flags);
 463         addr = (unsigned long) kmap_atomic(bvec->bv_page);
 464
 465         BUG_ON(addr & ~PAGE_MASK);
 466
 467         return (char *) addr + bvec->bv_offset;
 468 }
 469
 470 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
 471 {
 472         unsigned long ptr = (unsigned long) buffer & PAGE_MASK;
 473
 474         kunmap_atomic((void *) ptr);
 475         local_irq_restore(*flags);
 476 }
 477
 478 #else
 479 static inline char *bvec_kmap_irq(struct bio_vec *bvec, unsigned long *flags)
 480 {
 481         return page_address(bvec->bv_page) + bvec->bv_offset;
 482 }
 483
 484 static inline void bvec_kunmap_irq(char *buffer, unsigned long *flags)
 485 {
 486         *flags = 0;
 487 }
 488 #endif
 489
 490 static inline char *__bio_kmap_irq(struct bio *bio, struct bvec_iter iter,
 491                                    unsigned long *flags)
 492 {
 493         return bvec_kmap_irq(&bio_iter_iovec(bio, iter), flags);
 494 }
 495 #define __bio_kunmap_irq(buf, flags)    bvec_kunmap_irq(buf, flags)
 496
 497 #define bio_kmap_irq(bio, flags) \
 498         __bio_kmap_irq((bio), (bio)->bi_iter, (flags))
 499 #define bio_kunmap_irq(buf,flags)       __bio_kunmap_irq(buf, flags)
 500
 501 /*
 502  * BIO list management for use by remapping drivers (e.g. DM or MD) and loop.
 503  *
 504  * A bio_list anchors a singly-linked list of bios chained through the bi_next
 505  * member of the bio.  The bio_list also caches the last list member to allow
 506  * fast access to the tail.
 507  */
 508 struct bio_list {
 509         struct bio *head;
 510         struct bio *tail;
 511 };
 512
 513 static inline int bio_list_empty(const struct bio_list *bl)
 514 {
 515         return bl->head == NULL;
 516 }
 517
 518 static inline void bio_list_init(struct bio_list *bl)
 519 {
 520         bl->head = bl->tail = NULL;
 521 }
 522
 523 #define BIO_EMPTY_LIST  { NULL, NULL }
 524
 525 #define bio_list_for_each(bio, bl) \
 526         for (bio = (bl)->head; bio; bio = bio->bi_next)
 527
 528 static inline unsigned bio_list_size(const struct bio_list *bl)
 529 {
 530         unsigned sz = 0;
 531         struct bio *bio;
 532
 533         bio_list_for_each(bio, bl)
 534                 sz++;
 535
 536         return sz;
 537 }
 538
 539 static inline void bio_list_add(struct bio_list *bl, struct bio *bio)
 540 {
 541         bio->bi_next = NULL;
 542
 543         if (bl->tail)
 544                 bl->tail->bi_next = bio;
 545         else
 546                 bl->head = bio;
 547
 548         bl->tail = bio;
 549 }
 550
 551 static inline void bio_list_add_head(struct bio_list *bl, struct bio *bio)
 552 {
 553         bio->bi_next = bl->head;
 554
 555         bl->head = bio;
 556
 557         if (!bl->tail)
 558                 bl->tail = bio;
 559 }
 560
 561 static inline void bio_list_merge(struct bio_list *bl, struct bio_list *bl2)
 562 {
 563         if (!bl2->head)
 564                 return;
 565
 566         if (bl->tail)
 567                 bl->tail->bi_next = bl2->head;
 568         else
 569                 bl->head = bl2->head;
 570
 571         bl->tail = bl2->tail;
 572 }
 573
 574 static inline void bio_list_merge_head(struct bio_list *bl,
 575                                        struct bio_list *bl2)
 576 {
 577         if (!bl2->head)
 578                 return;
 579
 580         if (bl->head)
 581                 bl2->tail->bi_next = bl->head;
 582         else
 583                 bl->tail = bl2->tail;
 584
 585         bl->head = bl2->head;
 586 }
 587
 588 static inline struct bio *bio_list_peek(struct bio_list *bl)
 589 {
 590         return bl->head;
 591 }
 592
 593 static inline struct bio *bio_list_pop(struct bio_list *bl)
 594 {
 595         struct bio *bio = bl->head;
 596
 597         if (bio) {
 598                 bl->head = bl->head->bi_next;
 599                 if (!bl->head)
 600                         bl->tail = NULL;
 601
 602                 bio->bi_next = NULL;
 603         }
 604
 605         return bio;
 606 }
 607
 608 static inline struct bio *bio_list_get(struct bio_list *bl)
 609 {
 610         struct bio *bio = bl->head;
 611
 612         bl->head = bl->tail = NULL;
 613
 614         return bio;
 615 }
 616
 617 /*
 618  * bio_set is used to allow other portions of the IO system to
 619  * allocate their own private memory pools for bio and iovec structures.
 620  * These memory pools in turn all allocate from the bio_slab
 621  * and the bvec_slabs[].
 622  */
 623 #define BIO_POOL_SIZE 2
 624 #define BIOVEC_NR_POOLS 6
 625 #define BIOVEC_MAX_IDX  (BIOVEC_NR_POOLS - 1)
 626
 627 struct bio_set {
 628         struct kmem_cache *bio_slab;
 629         unsigned int front_pad;
 630
 631         mempool_t *bio_pool;
 632         mempool_t *bvec_pool;
 633 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 634         mempool_t *bio_integrity_pool;
 635         mempool_t *bvec_integrity_pool;
 636 #endif
 637
 638         /*
 639          * Deadlock avoidance for stacking block drivers: see comments in
 640          * bio_alloc_bioset() for details
 641          */
 642         spinlock_t              rescue_lock;
 643         struct bio_list         rescue_list;
 644         struct work_struct      rescue_work;
 645         struct workqueue_struct *rescue_workqueue;
 646 };
 647
 648 struct biovec_slab {
 649         int nr_vecs;
 650         char *name;
 651         struct kmem_cache *slab;
 652 };
 653
 654 /*
 655  * a small number of entries is fine, not going to be performance critical.
 656  * basically we just need to survive
 657  */
 658 #define BIO_SPLIT_ENTRIES 2
 659
 660 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 661
 662 #define bip_for_each_vec(bvl, bip, iter)                                \
 663         for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
 664
 665 #define bio_for_each_integrity_vec(_bvl, _bio, _iter)                   \
 666         for_each_bio(_bio)                                              \
 667                 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
 668
 669 extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
 670 extern void bio_integrity_free(struct bio *);
 671 extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
 672 extern bool bio_integrity_enabled(struct bio *bio);
 673 extern int bio_integrity_prep(struct bio *);
 674 extern void bio_integrity_endio(struct bio *, int);
 675 extern void bio_integrity_advance(struct bio *, unsigned int);
 676 extern void bio_integrity_trim(struct bio *, unsigned int, unsigned int);
 677 extern int bio_integrity_clone(struct bio *, struct bio *, gfp_t);
 678 extern int bioset_integrity_create(struct bio_set *, int);
 679 extern void bioset_integrity_free(struct bio_set *);
 680 extern void bio_integrity_init(void);
 681
 682 #else /* CONFIG_BLK_DEV_INTEGRITY */
 683
 684 static inline int bio_integrity(struct bio *bio)
 685 {
 686         return 0;
 687 }
 688
 689 static inline bool bio_integrity_enabled(struct bio *bio)
 690 {
 691         return false;
 692 }
 693
 694 static inline int bioset_integrity_create(struct bio_set *bs, int pool_size)
 695 {
 696         return 0;
 697 }
 698
 699 static inline void bioset_integrity_free (struct bio_set *bs)
 700 {
 701         return;
 702 }
 703
 704 static inline int bio_integrity_prep(struct bio *bio)
 705 {
 706         return 0;
 707 }
 708
 709 static inline void bio_integrity_free(struct bio *bio)
 710 {
 711         return;
 712 }
 713
 714 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
 715                                       gfp_t gfp_mask)
 716 {
 717         return 0;
 718 }
 719
 720 static inline void bio_integrity_advance(struct bio *bio,
 721                                          unsigned int bytes_done)
 722 {
 723         return;
 724 }
 725
 726 static inline void bio_integrity_trim(struct bio *bio, unsigned int offset,
 727                                       unsigned int sectors)
 728 {
 729         return;
 730 }
 731
 732 static inline void bio_integrity_init(void)
 733 {
 734         return;
 735 }
 736
 737 #endif /* CONFIG_BLK_DEV_INTEGRITY */
 738
 739 #endif /* CONFIG_BLOCK */
 740 #endif /* __LINUX_BIO_H */