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