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