include/linux/bio.h

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