include/linux/blkdev.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_BLKDEV_H
   3 #define _LINUX_BLKDEV_H
   4
   5 #include <linux/sched.h>
   6 #include <linux/sched/clock.h>
   7
   8 #ifdef CONFIG_BLOCK
   9
  10 #include <linux/major.h>
  11 #include <linux/genhd.h>
  12 #include <linux/list.h>
  13 #include <linux/llist.h>
  14 #include <linux/timer.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/pagemap.h>
  17 #include <linux/backing-dev-defs.h>
  18 #include <linux/wait.h>
  19 #include <linux/mempool.h>
  20 #include <linux/pfn.h>
  21 #include <linux/bio.h>
  22 #include <linux/stringify.h>
  23 #include <linux/gfp.h>
  24 #include <linux/bsg.h>
  25 #include <linux/smp.h>
  26 #include <linux/rcupdate.h>
  27 #include <linux/percpu-refcount.h>
  28 #include <linux/scatterlist.h>
  29 #include <linux/blkzoned.h>
  30
  31 struct module;
  32 struct scsi_ioctl_command;
  33
  34 struct request_queue;
  35 struct elevator_queue;
  36 struct blk_trace;
  37 struct request;
  38 struct sg_io_hdr;
  39 struct bsg_job;
  40 struct blkcg_gq;
  41 struct blk_flush_queue;
  42 struct pr_ops;
  43 struct rq_qos;
  44 struct blk_queue_stats;
  45 struct blk_stat_callback;
  46
  47 #define BLKDEV_MIN_RQ   4
  48 #define BLKDEV_MAX_RQ   128     /* Default maximum */
  49
  50 /* Must be consistent with blk_mq_poll_stats_bkt() */
  51 #define BLK_MQ_POLL_STATS_BKTS 16
  52
  53 /*
  54  * Maximum number of blkcg policies allowed to be registered concurrently.
  55  * Defined here to simplify include dependency.
  56  */
  57 #define BLKCG_MAX_POLS          5
  58
  59 typedef void (rq_end_io_fn)(struct request *, blk_status_t);
  60
  61 #define BLK_RL_SYNCFULL         (1U << 0)
  62 #define BLK_RL_ASYNCFULL        (1U << 1)
  63
  64 struct request_list {
  65         struct request_queue    *q;     /* the queue this rl belongs to */
  66 #ifdef CONFIG_BLK_CGROUP
  67         struct blkcg_gq         *blkg;  /* blkg this request pool belongs to */
  68 #endif
  69         /*
  70          * count[], starved[], and wait[] are indexed by
  71          * BLK_RW_SYNC/BLK_RW_ASYNC
  72          */
  73         int                     count[2];
  74         int                     starved[2];
  75         mempool_t               *rq_pool;
  76         wait_queue_head_t       wait[2];
  77         unsigned int            flags;
  78 };
  79
  80 /*
  81  * request flags */
  82 typedef __u32 __bitwise req_flags_t;
  83
  84 /* elevator knows about this request */
  85 #define RQF_SORTED              ((__force req_flags_t)(1 << 0))
  86 /* drive already may have started this one */
  87 #define RQF_STARTED             ((__force req_flags_t)(1 << 1))
  88 /* uses tagged queueing */
  89 #define RQF_QUEUED              ((__force req_flags_t)(1 << 2))
  90 /* may not be passed by ioscheduler */
  91 #define RQF_SOFTBARRIER         ((__force req_flags_t)(1 << 3))
  92 /* request for flush sequence */
  93 #define RQF_FLUSH_SEQ           ((__force req_flags_t)(1 << 4))
  94 /* merge of different types, fail separately */
  95 #define RQF_MIXED_MERGE         ((__force req_flags_t)(1 << 5))
  96 /* track inflight for MQ */
  97 #define RQF_MQ_INFLIGHT         ((__force req_flags_t)(1 << 6))
  98 /* don't call prep for this one */
  99 #define RQF_DONTPREP            ((__force req_flags_t)(1 << 7))
 100 /* set for "ide_preempt" requests and also for requests for which the SCSI
 101    "quiesce" state must be ignored. */
 102 #define RQF_PREEMPT             ((__force req_flags_t)(1 << 8))
 103 /* contains copies of user pages */
 104 #define RQF_COPY_USER           ((__force req_flags_t)(1 << 9))
 105 /* vaguely specified driver internal error.  Ignored by the block layer */
 106 #define RQF_FAILED              ((__force req_flags_t)(1 << 10))
 107 /* don't warn about errors */
 108 #define RQF_QUIET               ((__force req_flags_t)(1 << 11))
 109 /* elevator private data attached */
 110 #define RQF_ELVPRIV             ((__force req_flags_t)(1 << 12))
 111 /* account I/O stat */
 112 #define RQF_IO_STAT             ((__force req_flags_t)(1 << 13))
 113 /* request came from our alloc pool */
 114 #define RQF_ALLOCED             ((__force req_flags_t)(1 << 14))
 115 /* runtime pm request */
 116 #define RQF_PM                  ((__force req_flags_t)(1 << 15))
 117 /* on IO scheduler merge hash */
 118 #define RQF_HASHED              ((__force req_flags_t)(1 << 16))
 119 /* IO stats tracking on */
 120 #define RQF_STATS               ((__force req_flags_t)(1 << 17))
 121 /* Look at ->special_vec for the actual data payload instead of the
 122    bio chain. */
 123 #define RQF_SPECIAL_PAYLOAD     ((__force req_flags_t)(1 << 18))
 124 /* The per-zone write lock is held for this request */
 125 #define RQF_ZONE_WRITE_LOCKED   ((__force req_flags_t)(1 << 19))
 126 /* already slept for hybrid poll */
 127 #define RQF_MQ_POLL_SLEPT       ((__force req_flags_t)(1 << 20))
 128 /* ->timeout has been called, don't expire again */
 129 #define RQF_TIMED_OUT           ((__force req_flags_t)(1 << 21))
 130
 131 /* flags that prevent us from merging requests: */
 132 #define RQF_NOMERGE_FLAGS \
 133         (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
 134
 135 /*
 136  * Request state for blk-mq.
 137  */
 138 enum mq_rq_state {
 139         MQ_RQ_IDLE              = 0,
 140         MQ_RQ_IN_FLIGHT         = 1,
 141         MQ_RQ_COMPLETE          = 2,
 142 };
 143
 144 /*
 145  * Try to put the fields that are referenced together in the same cacheline.
 146  *
 147  * If you modify this structure, make sure to update blk_rq_init() and
 148  * especially blk_mq_rq_ctx_init() to take care of the added fields.
 149  */
 150 struct request {
 151         struct request_queue *q;
 152         struct blk_mq_ctx *mq_ctx;
 153
 154         int cpu;
 155         unsigned int cmd_flags;         /* op and common flags */
 156         req_flags_t rq_flags;
 157
 158         int internal_tag;
 159
 160         /* the following two fields are internal, NEVER access directly */
 161         unsigned int __data_len;        /* total data len */
 162         int tag;
 163         sector_t __sector;              /* sector cursor */
 164
 165         struct bio *bio;
 166         struct bio *biotail;
 167
 168         struct list_head queuelist;
 169
 170         /*
 171          * The hash is used inside the scheduler, and killed once the
 172          * request reaches the dispatch list. The ipi_list is only used
 173          * to queue the request for softirq completion, which is long
 174          * after the request has been unhashed (and even removed from
 175          * the dispatch list).
 176          */
 177         union {
 178                 struct hlist_node hash; /* merge hash */
 179                 struct list_head ipi_list;
 180         };
 181
 182         /*
 183          * The rb_node is only used inside the io scheduler, requests
 184          * are pruned when moved to the dispatch queue. So let the
 185          * completion_data share space with the rb_node.
 186          */
 187         union {
 188                 struct rb_node rb_node; /* sort/lookup */
 189                 struct bio_vec special_vec;
 190                 void *completion_data;
 191                 int error_count; /* for legacy drivers, don't use */
 192         };
 193
 194         /*
 195          * Three pointers are available for the IO schedulers, if they need
 196          * more they have to dynamically allocate it.  Flush requests are
 197          * never put on the IO scheduler. So let the flush fields share
 198          * space with the elevator data.
 199          */
 200         union {
 201                 struct {
 202                         struct io_cq            *icq;
 203                         void                    *priv[2];
 204                 } elv;
 205
 206                 struct {
 207                         unsigned int            seq;
 208                         struct list_head        list;
 209                         rq_end_io_fn            *saved_end_io;
 210                 } flush;
 211         };
 212
 213         struct gendisk *rq_disk;
 214         struct hd_struct *part;
 215         /* Time that I/O was submitted to the kernel. */
 216         u64 start_time_ns;
 217         /* Time that I/O was submitted to the device. */
 218         u64 io_start_time_ns;
 219
 220 #ifdef CONFIG_BLK_WBT
 221         unsigned short wbt_flags;
 222 #endif
 223 #ifdef CONFIG_BLK_DEV_THROTTLING_LOW
 224         unsigned short throtl_size;
 225 #endif
 226
 227         /*
 228          * Number of scatter-gather DMA addr+len pairs after
 229          * physical address coalescing is performed.
 230          */
 231         unsigned short nr_phys_segments;
 232
 233 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 234         unsigned short nr_integrity_segments;
 235 #endif
 236
 237         unsigned short write_hint;
 238         unsigned short ioprio;
 239
 240         void *special;          /* opaque pointer available for LLD use */
 241
 242         unsigned int extra_len; /* length of alignment and padding */
 243
 244         enum mq_rq_state state;
 245         refcount_t ref;
 246
 247         unsigned int timeout;
 248
 249         /* access through blk_rq_set_deadline, blk_rq_deadline */
 250         unsigned long __deadline;
 251
 252         struct list_head timeout_list;
 253
 254         union {
 255                 struct __call_single_data csd;
 256                 u64 fifo_time;
 257         };
 258
 259         /*
 260          * completion callback.
 261          */
 262         rq_end_io_fn *end_io;
 263         void *end_io_data;
 264
 265         /* for bidi */
 266         struct request *next_rq;
 267
 268 #ifdef CONFIG_BLK_CGROUP
 269         struct request_list *rl;                /* rl this rq is alloced from */
 270 #endif
 271 };
 272
 273 static inline bool blk_op_is_scsi(unsigned int op)
 274 {
 275         return op == REQ_OP_SCSI_IN || op == REQ_OP_SCSI_OUT;
 276 }
 277
 278 static inline bool blk_op_is_private(unsigned int op)
 279 {
 280         return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
 281 }
 282
 283 static inline bool blk_rq_is_scsi(struct request *rq)
 284 {
 285         return blk_op_is_scsi(req_op(rq));
 286 }
 287
 288 static inline bool blk_rq_is_private(struct request *rq)
 289 {
 290         return blk_op_is_private(req_op(rq));
 291 }
 292
 293 static inline bool blk_rq_is_passthrough(struct request *rq)
 294 {
 295         return blk_rq_is_scsi(rq) || blk_rq_is_private(rq);
 296 }
 297
 298 static inline bool bio_is_passthrough(struct bio *bio)
 299 {
 300         unsigned op = bio_op(bio);
 301
 302         return blk_op_is_scsi(op) || blk_op_is_private(op);
 303 }
 304
 305 static inline unsigned short req_get_ioprio(struct request *req)
 306 {
 307         return req->ioprio;
 308 }
 309
 310 #include <linux/elevator.h>
 311
 312 struct blk_queue_ctx;
 313
 314 typedef void (request_fn_proc) (struct request_queue *q);
 315 typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
 316 typedef bool (poll_q_fn) (struct request_queue *q, blk_qc_t);
 317 typedef int (prep_rq_fn) (struct request_queue *, struct request *);
 318 typedef void (unprep_rq_fn) (struct request_queue *, struct request *);
 319
 320 struct bio_vec;
 321 typedef void (softirq_done_fn)(struct request *);
 322 typedef int (dma_drain_needed_fn)(struct request *);
 323 typedef int (lld_busy_fn) (struct request_queue *q);
 324 typedef int (bsg_job_fn) (struct bsg_job *);
 325 typedef int (init_rq_fn)(struct request_queue *, struct request *, gfp_t);
 326 typedef void (exit_rq_fn)(struct request_queue *, struct request *);
 327
 328 enum blk_eh_timer_return {
 329         BLK_EH_DONE,            /* drivers has completed the command */
 330         BLK_EH_RESET_TIMER,     /* reset timer and try again */
 331 };
 332
 333 typedef enum blk_eh_timer_return (rq_timed_out_fn)(struct request *);
 334
 335 enum blk_queue_state {
 336         Queue_down,
 337         Queue_up,
 338 };
 339
 340 struct blk_queue_tag {
 341         struct request **tag_index;     /* map of busy tags */
 342         unsigned long *tag_map;         /* bit map of free/busy tags */
 343         int max_depth;                  /* what we will send to device */
 344         int real_max_depth;             /* what the array can hold */
 345         atomic_t refcnt;                /* map can be shared */
 346         int alloc_policy;               /* tag allocation policy */
 347         int next_tag;                   /* next tag */
 348 };
 349 #define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
 350 #define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
 351
 352 #define BLK_SCSI_MAX_CMDS       (256)
 353 #define BLK_SCSI_CMD_PER_LONG   (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
 354
 355 /*
 356  * Zoned block device models (zoned limit).
 357  */
 358 enum blk_zoned_model {
 359         BLK_ZONED_NONE, /* Regular block device */
 360         BLK_ZONED_HA,   /* Host-aware zoned block device */
 361         BLK_ZONED_HM,   /* Host-managed zoned block device */
 362 };
 363
 364 struct queue_limits {
 365         unsigned long           bounce_pfn;
 366         unsigned long           seg_boundary_mask;
 367         unsigned long           virt_boundary_mask;
 368
 369         unsigned int            max_hw_sectors;
 370         unsigned int            max_dev_sectors;
 371         unsigned int            chunk_sectors;
 372         unsigned int            max_sectors;
 373         unsigned int            max_segment_size;
 374         unsigned int            physical_block_size;
 375         unsigned int            alignment_offset;
 376         unsigned int            io_min;
 377         unsigned int            io_opt;
 378         unsigned int            max_discard_sectors;
 379         unsigned int            max_hw_discard_sectors;
 380         unsigned int            max_write_same_sectors;
 381         unsigned int            max_write_zeroes_sectors;
 382         unsigned int            discard_granularity;
 383         unsigned int            discard_alignment;
 384
 385         unsigned short          logical_block_size;
 386         unsigned short          max_segments;
 387         unsigned short          max_integrity_segments;
 388         unsigned short          max_discard_segments;
 389
 390         unsigned char           misaligned;
 391         unsigned char           discard_misaligned;
 392         unsigned char           cluster;
 393         unsigned char           raid_partial_stripes_expensive;
 394         enum blk_zoned_model    zoned;
 395 };
 396
 397 #ifdef CONFIG_BLK_DEV_ZONED
 398
 399 struct blk_zone_report_hdr {
 400         unsigned int    nr_zones;
 401         u8              padding[60];
 402 };
 403
 404 extern int blkdev_report_zones(struct block_device *bdev,
 405                                sector_t sector, struct blk_zone *zones,
 406                                unsigned int *nr_zones, gfp_t gfp_mask);
 407 extern int blkdev_reset_zones(struct block_device *bdev, sector_t sectors,
 408                               sector_t nr_sectors, gfp_t gfp_mask);
 409
 410 extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
 411                                      unsigned int cmd, unsigned long arg);
 412 extern int blkdev_reset_zones_ioctl(struct block_device *bdev, fmode_t mode,
 413                                     unsigned int cmd, unsigned long arg);
 414
 415 #else /* CONFIG_BLK_DEV_ZONED */
 416
 417 static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
 418                                             fmode_t mode, unsigned int cmd,
 419                                             unsigned long arg)
 420 {
 421         return -ENOTTY;
 422 }
 423
 424 static inline int blkdev_reset_zones_ioctl(struct block_device *bdev,
 425                                            fmode_t mode, unsigned int cmd,
 426                                            unsigned long arg)
 427 {
 428         return -ENOTTY;
 429 }
 430
 431 #endif /* CONFIG_BLK_DEV_ZONED */
 432
 433 struct request_queue {
 434         /*
 435          * Together with queue_head for cacheline sharing
 436          */
 437         struct list_head        queue_head;
 438         struct request          *last_merge;
 439         struct elevator_queue   *elevator;
 440         int                     nr_rqs[2];      /* # allocated [a]sync rqs */
 441         int                     nr_rqs_elvpriv; /* # allocated rqs w/ elvpriv */
 442
 443         struct blk_queue_stats  *stats;
 444         struct rq_qos           *rq_qos;
 445
 446         /*
 447          * If blkcg is not used, @q->root_rl serves all requests.  If blkcg
 448          * is used, root blkg allocates from @q->root_rl and all other
 449          * blkgs from their own blkg->rl.  Which one to use should be
 450          * determined using bio_request_list().
 451          */
 452         struct request_list     root_rl;
 453
 454         request_fn_proc         *request_fn;
 455         make_request_fn         *make_request_fn;
 456         poll_q_fn               *poll_fn;
 457         prep_rq_fn              *prep_rq_fn;
 458         unprep_rq_fn            *unprep_rq_fn;
 459         softirq_done_fn         *softirq_done_fn;
 460         rq_timed_out_fn         *rq_timed_out_fn;
 461         dma_drain_needed_fn     *dma_drain_needed;
 462         lld_busy_fn             *lld_busy_fn;
 463         /* Called just after a request is allocated */
 464         init_rq_fn              *init_rq_fn;
 465         /* Called just before a request is freed */
 466         exit_rq_fn              *exit_rq_fn;
 467         /* Called from inside blk_get_request() */
 468         void (*initialize_rq_fn)(struct request *rq);
 469
 470         const struct blk_mq_ops *mq_ops;
 471
 472         unsigned int            *mq_map;
 473
 474         /* sw queues */
 475         struct blk_mq_ctx __percpu      *queue_ctx;
 476         unsigned int            nr_queues;
 477
 478         unsigned int            queue_depth;
 479
 480         /* hw dispatch queues */
 481         struct blk_mq_hw_ctx    **queue_hw_ctx;
 482         unsigned int            nr_hw_queues;
 483
 484         /*
 485          * Dispatch queue sorting
 486          */
 487         sector_t                end_sector;
 488         struct request          *boundary_rq;
 489
 490         /*
 491          * Delayed queue handling
 492          */
 493         struct delayed_work     delay_work;
 494
 495         struct backing_dev_info *backing_dev_info;
 496
 497         /*
 498          * The queue owner gets to use this for whatever they like.
 499          * ll_rw_blk doesn't touch it.
 500          */
 501         void                    *queuedata;
 502
 503         /*
 504          * various queue flags, see QUEUE_* below
 505          */
 506         unsigned long           queue_flags;
 507
 508         /*
 509          * ida allocated id for this queue.  Used to index queues from
 510          * ioctx.
 511          */
 512         int                     id;
 513
 514         /*
 515          * queue needs bounce pages for pages above this limit
 516          */
 517         gfp_t                   bounce_gfp;
 518
 519         /*
 520          * protects queue structures from reentrancy. ->__queue_lock should
 521          * _never_ be used directly, it is queue private. always use
 522          * ->queue_lock.
 523          */
 524         spinlock_t              __queue_lock;
 525         spinlock_t              *queue_lock;
 526
 527         /*
 528          * queue kobject
 529          */
 530         struct kobject kobj;
 531
 532         /*
 533          * mq queue kobject
 534          */
 535         struct kobject mq_kobj;
 536
 537 #ifdef  CONFIG_BLK_DEV_INTEGRITY
 538         struct blk_integrity integrity;
 539 #endif  /* CONFIG_BLK_DEV_INTEGRITY */
 540
 541 #ifdef CONFIG_PM
 542         struct device           *dev;
 543         int                     rpm_status;
 544         unsigned int            nr_pending;
 545 #endif
 546
 547         /*
 548          * queue settings
 549          */
 550         unsigned long           nr_requests;    /* Max # of requests */
 551         unsigned int            nr_congestion_on;
 552         unsigned int            nr_congestion_off;
 553         unsigned int            nr_batching;
 554
 555         unsigned int            dma_drain_size;
 556         void                    *dma_drain_buffer;
 557         unsigned int            dma_pad_mask;
 558         unsigned int            dma_alignment;
 559
 560         struct blk_queue_tag    *queue_tags;
 561
 562         unsigned int            nr_sorted;
 563         unsigned int            in_flight[2];
 564
 565         /*
 566          * Number of active block driver functions for which blk_drain_queue()
 567          * must wait. Must be incremented around functions that unlock the
 568          * queue_lock internally, e.g. scsi_request_fn().
 569          */
 570         unsigned int            request_fn_active;
 571
 572         unsigned int            rq_timeout;
 573         int                     poll_nsec;
 574
 575         struct blk_stat_callback        *poll_cb;
 576         struct blk_rq_stat      poll_stat[BLK_MQ_POLL_STATS_BKTS];
 577
 578         struct timer_list       timeout;
 579         struct work_struct      timeout_work;
 580         struct list_head        timeout_list;
 581
 582         struct list_head        icq_list;
 583 #ifdef CONFIG_BLK_CGROUP
 584         DECLARE_BITMAP          (blkcg_pols, BLKCG_MAX_POLS);
 585         struct blkcg_gq         *root_blkg;
 586         struct list_head        blkg_list;
 587 #endif
 588
 589         struct queue_limits     limits;
 590
 591 #ifdef CONFIG_BLK_DEV_ZONED
 592         /*
 593          * Zoned block device information for request dispatch control.
 594          * nr_zones is the total number of zones of the device. This is always
 595          * 0 for regular block devices. seq_zones_bitmap is a bitmap of nr_zones
 596          * bits which indicates if a zone is conventional (bit clear) or
 597          * sequential (bit set). seq_zones_wlock is a bitmap of nr_zones
 598          * bits which indicates if a zone is write locked, that is, if a write
 599          * request targeting the zone was dispatched. All three fields are
 600          * initialized by the low level device driver (e.g. scsi/sd.c).
 601          * Stacking drivers (device mappers) may or may not initialize
 602          * these fields.
 603          *
 604          * Reads of this information must be protected with blk_queue_enter() /
 605          * blk_queue_exit(). Modifying this information is only allowed while
 606          * no requests are being processed. See also blk_mq_freeze_queue() and
 607          * blk_mq_unfreeze_queue().
 608          */
 609         unsigned int            nr_zones;
 610         unsigned long           *seq_zones_bitmap;
 611         unsigned long           *seq_zones_wlock;
 612 #endif /* CONFIG_BLK_DEV_ZONED */
 613
 614         /*
 615          * sg stuff
 616          */
 617         unsigned int            sg_timeout;
 618         unsigned int            sg_reserved_size;
 619         int                     node;
 620 #ifdef CONFIG_BLK_DEV_IO_TRACE
 621         struct blk_trace        *blk_trace;
 622         struct mutex            blk_trace_mutex;
 623 #endif
 624         /*
 625          * for flush operations
 626          */
 627         struct blk_flush_queue  *fq;
 628
 629         struct list_head        requeue_list;
 630         spinlock_t              requeue_lock;
 631         struct delayed_work     requeue_work;
 632
 633         struct mutex            sysfs_lock;
 634
 635         int                     bypass_depth;
 636         atomic_t                mq_freeze_depth;
 637
 638 #if defined(CONFIG_BLK_DEV_BSG)
 639         bsg_job_fn              *bsg_job_fn;
 640         struct bsg_class_device bsg_dev;
 641 #endif
 642
 643 #ifdef CONFIG_BLK_DEV_THROTTLING
 644         /* Throttle data */
 645         struct throtl_data *td;
 646 #endif
 647         struct rcu_head         rcu_head;
 648         wait_queue_head_t       mq_freeze_wq;
 649         struct percpu_ref       q_usage_counter;
 650         struct list_head        all_q_node;
 651
 652         struct blk_mq_tag_set   *tag_set;
 653         struct list_head        tag_set_list;
 654         struct bio_set          bio_split;
 655
 656 #ifdef CONFIG_BLK_DEBUG_FS
 657         struct dentry           *debugfs_dir;
 658         struct dentry           *sched_debugfs_dir;
 659 #endif
 660
 661         bool                    mq_sysfs_init_done;
 662
 663         size_t                  cmd_size;
 664         void                    *rq_alloc_data;
 665
 666         struct work_struct      release_work;
 667
 668 #define BLK_MAX_WRITE_HINTS     5
 669         u64                     write_hints[BLK_MAX_WRITE_HINTS];
 670 };
 671
 672 #define QUEUE_FLAG_QUEUED       0       /* uses generic tag queueing */
 673 #define QUEUE_FLAG_STOPPED      1       /* queue is stopped */
 674 #define QUEUE_FLAG_DYING        2       /* queue being torn down */
 675 #define QUEUE_FLAG_BYPASS       3       /* act as dumb FIFO queue */
 676 #define QUEUE_FLAG_BIDI         4       /* queue supports bidi requests */
 677 #define QUEUE_FLAG_NOMERGES     5       /* disable merge attempts */
 678 #define QUEUE_FLAG_SAME_COMP    6       /* complete on same CPU-group */
 679 #define QUEUE_FLAG_FAIL_IO      7       /* fake timeout */
 680 #define QUEUE_FLAG_NONROT       9       /* non-rotational device (SSD) */
 681 #define QUEUE_FLAG_VIRT        QUEUE_FLAG_NONROT /* paravirt device */
 682 #define QUEUE_FLAG_IO_STAT     10       /* do IO stats */
 683 #define QUEUE_FLAG_DISCARD     11       /* supports DISCARD */
 684 #define QUEUE_FLAG_NOXMERGES   12       /* No extended merges */
 685 #define QUEUE_FLAG_ADD_RANDOM  13       /* Contributes to random pool */
 686 #define QUEUE_FLAG_SECERASE    14       /* supports secure erase */
 687 #define QUEUE_FLAG_SAME_FORCE  15       /* force complete on same CPU */
 688 #define QUEUE_FLAG_DEAD        16       /* queue tear-down finished */
 689 #define QUEUE_FLAG_INIT_DONE   17       /* queue is initialized */
 690 #define QUEUE_FLAG_NO_SG_MERGE 18       /* don't attempt to merge SG segments*/
 691 #define QUEUE_FLAG_POLL        19       /* IO polling enabled if set */
 692 #define QUEUE_FLAG_WC          20       /* Write back caching */
 693 #define QUEUE_FLAG_FUA         21       /* device supports FUA writes */
 694 #define QUEUE_FLAG_FLUSH_NQ    22       /* flush not queueuable */
 695 #define QUEUE_FLAG_DAX         23       /* device supports DAX */
 696 #define QUEUE_FLAG_STATS       24       /* track rq completion times */
 697 #define QUEUE_FLAG_POLL_STATS  25       /* collecting stats for hybrid polling */
 698 #define QUEUE_FLAG_REGISTERED  26       /* queue has been registered to a disk */
 699 #define QUEUE_FLAG_SCSI_PASSTHROUGH 27  /* queue supports SCSI commands */
 700 #define QUEUE_FLAG_QUIESCED    28       /* queue has been quiesced */
 701 #define QUEUE_FLAG_PREEMPT_ONLY 29      /* only process REQ_PREEMPT requests */
 702 #define QUEUE_FLAG_PCI_P2PDMA  30       /* device supports PCI p2p requests */
 703
 704 #define QUEUE_FLAG_DEFAULT      ((1 << QUEUE_FLAG_IO_STAT) |            \
 705                                  (1 << QUEUE_FLAG_SAME_COMP)    |       \
 706                                  (1 << QUEUE_FLAG_ADD_RANDOM))
 707
 708 #define QUEUE_FLAG_MQ_DEFAULT   ((1 << QUEUE_FLAG_IO_STAT) |            \
 709                                  (1 << QUEUE_FLAG_SAME_COMP)    |       \
 710                                  (1 << QUEUE_FLAG_POLL))
 711
 712 void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
 713 void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
 714 bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
 715 bool blk_queue_flag_test_and_clear(unsigned int flag, struct request_queue *q);
 716
 717 #define blk_queue_tagged(q)     test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
 718 #define blk_queue_stopped(q)    test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
 719 #define blk_queue_dying(q)      test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
 720 #define blk_queue_dead(q)       test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
 721 #define blk_queue_bypass(q)     test_bit(QUEUE_FLAG_BYPASS, &(q)->queue_flags)
 722 #define blk_queue_init_done(q)  test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
 723 #define blk_queue_nomerges(q)   test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
 724 #define blk_queue_noxmerges(q)  \
 725         test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
 726 #define blk_queue_nonrot(q)     test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
 727 #define blk_queue_io_stat(q)    test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
 728 #define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
 729 #define blk_queue_discard(q)    test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
 730 #define blk_queue_secure_erase(q) \
 731         (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
 732 #define blk_queue_dax(q)        test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
 733 #define blk_queue_scsi_passthrough(q)   \
 734         test_bit(QUEUE_FLAG_SCSI_PASSTHROUGH, &(q)->queue_flags)
 735 #define blk_queue_pci_p2pdma(q) \
 736         test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
 737
 738 #define blk_noretry_request(rq) \
 739         ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
 740                              REQ_FAILFAST_DRIVER))
 741 #define blk_queue_quiesced(q)   test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
 742 #define blk_queue_preempt_only(q)                               \
 743         test_bit(QUEUE_FLAG_PREEMPT_ONLY, &(q)->queue_flags)
 744 #define blk_queue_fua(q)        test_bit(QUEUE_FLAG_FUA, &(q)->queue_flags)
 745
 746 extern int blk_set_preempt_only(struct request_queue *q);
 747 extern void blk_clear_preempt_only(struct request_queue *q);
 748
 749 static inline int queue_in_flight(struct request_queue *q)
 750 {
 751         return q->in_flight[0] + q->in_flight[1];
 752 }
 753
 754 static inline bool blk_account_rq(struct request *rq)
 755 {
 756         return (rq->rq_flags & RQF_STARTED) && !blk_rq_is_passthrough(rq);
 757 }
 758
 759 #define blk_rq_cpu_valid(rq)    ((rq)->cpu != -1)
 760 #define blk_bidi_rq(rq)         ((rq)->next_rq != NULL)
 761 /* rq->queuelist of dequeued request must be list_empty() */
 762 #define blk_queued_rq(rq)       (!list_empty(&(rq)->queuelist))
 763
 764 #define list_entry_rq(ptr)      list_entry((ptr), struct request, queuelist)
 765
 766 #define rq_data_dir(rq)         (op_is_write(req_op(rq)) ? WRITE : READ)
 767
 768 /*
 769  * Driver can handle struct request, if it either has an old style
 770  * request_fn defined, or is blk-mq based.
 771  */
 772 static inline bool queue_is_rq_based(struct request_queue *q)
 773 {
 774         return q->request_fn || q->mq_ops;
 775 }
 776
 777 static inline unsigned int blk_queue_cluster(struct request_queue *q)
 778 {
 779         return q->limits.cluster;
 780 }
 781
 782 static inline enum blk_zoned_model
 783 blk_queue_zoned_model(struct request_queue *q)
 784 {
 785         return q->limits.zoned;
 786 }
 787
 788 static inline bool blk_queue_is_zoned(struct request_queue *q)
 789 {
 790         switch (blk_queue_zoned_model(q)) {
 791         case BLK_ZONED_HA:
 792         case BLK_ZONED_HM:
 793                 return true;
 794         default:
 795                 return false;
 796         }
 797 }
 798
 799 static inline unsigned int blk_queue_zone_sectors(struct request_queue *q)
 800 {
 801         return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
 802 }
 803
 804 #ifdef CONFIG_BLK_DEV_ZONED
 805 static inline unsigned int blk_queue_zone_no(struct request_queue *q,
 806                                              sector_t sector)
 807 {
 808         if (!blk_queue_is_zoned(q))
 809                 return 0;
 810         return sector >> ilog2(q->limits.chunk_sectors);
 811 }
 812
 813 static inline bool blk_queue_zone_is_seq(struct request_queue *q,
 814                                          sector_t sector)
 815 {
 816         if (!blk_queue_is_zoned(q) || !q->seq_zones_bitmap)
 817                 return false;
 818         return test_bit(blk_queue_zone_no(q, sector), q->seq_zones_bitmap);
 819 }
 820 #endif /* CONFIG_BLK_DEV_ZONED */
 821
 822 static inline bool rq_is_sync(struct request *rq)
 823 {
 824         return op_is_sync(rq->cmd_flags);
 825 }
 826
 827 static inline bool blk_rl_full(struct request_list *rl, bool sync)
 828 {
 829         unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
 830
 831         return rl->flags & flag;
 832 }
 833
 834 static inline void blk_set_rl_full(struct request_list *rl, bool sync)
 835 {
 836         unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
 837
 838         rl->flags |= flag;
 839 }
 840
 841 static inline void blk_clear_rl_full(struct request_list *rl, bool sync)
 842 {
 843         unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
 844
 845         rl->flags &= ~flag;
 846 }
 847
 848 static inline bool rq_mergeable(struct request *rq)
 849 {
 850         if (blk_rq_is_passthrough(rq))
 851                 return false;
 852
 853         if (req_op(rq) == REQ_OP_FLUSH)
 854                 return false;
 855
 856         if (req_op(rq) == REQ_OP_WRITE_ZEROES)
 857                 return false;
 858
 859         if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
 860                 return false;
 861         if (rq->rq_flags & RQF_NOMERGE_FLAGS)
 862                 return false;
 863
 864         return true;
 865 }
 866
 867 static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
 868 {
 869         if (bio_page(a) == bio_page(b) &&
 870             bio_offset(a) == bio_offset(b))
 871                 return true;
 872
 873         return false;
 874 }
 875
 876 static inline unsigned int blk_queue_depth(struct request_queue *q)
 877 {
 878         if (q->queue_depth)
 879                 return q->queue_depth;
 880
 881         return q->nr_requests;
 882 }
 883
 884 /*
 885  * q->prep_rq_fn return values
 886  */
 887 enum {
 888         BLKPREP_OK,             /* serve it */
 889         BLKPREP_KILL,           /* fatal error, kill, return -EIO */
 890         BLKPREP_DEFER,          /* leave on queue */
 891         BLKPREP_INVALID,        /* invalid command, kill, return -EREMOTEIO */
 892 };
 893
 894 extern unsigned long blk_max_low_pfn, blk_max_pfn;
 895
 896 /*
 897  * standard bounce addresses:
 898  *
 899  * BLK_BOUNCE_HIGH      : bounce all highmem pages
 900  * BLK_BOUNCE_ANY       : don't bounce anything
 901  * BLK_BOUNCE_ISA       : bounce pages above ISA DMA boundary
 902  */
 903
 904 #if BITS_PER_LONG == 32
 905 #define BLK_BOUNCE_HIGH         ((u64)blk_max_low_pfn << PAGE_SHIFT)
 906 #else
 907 #define BLK_BOUNCE_HIGH         -1ULL
 908 #endif
 909 #define BLK_BOUNCE_ANY          (-1ULL)
 910 #define BLK_BOUNCE_ISA          (DMA_BIT_MASK(24))
 911
 912 /*
 913  * default timeout for SG_IO if none specified
 914  */
 915 #define BLK_DEFAULT_SG_TIMEOUT  (60 * HZ)
 916 #define BLK_MIN_SG_TIMEOUT      (7 * HZ)
 917
 918 struct rq_map_data {
 919         struct page **pages;
 920         int page_order;
 921         int nr_entries;
 922         unsigned long offset;
 923         int null_mapped;
 924         int from_user;
 925 };
 926
 927 struct req_iterator {
 928         struct bvec_iter iter;
 929         struct bio *bio;
 930 };
 931
 932 /* This should not be used directly - use rq_for_each_segment */
 933 #define for_each_bio(_bio)              \
 934         for (; _bio; _bio = _bio->bi_next)
 935 #define __rq_for_each_bio(_bio, rq)     \
 936         if ((rq->bio))                  \
 937                 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
 938
 939 #define rq_for_each_segment(bvl, _rq, _iter)                    \
 940         __rq_for_each_bio(_iter.bio, _rq)                       \
 941                 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
 942
 943 #define rq_iter_last(bvec, _iter)                               \
 944                 (_iter.bio->bi_next == NULL &&                  \
 945                  bio_iter_last(bvec, _iter.iter))
 946
 947 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 948 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
 949 #endif
 950 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 951 extern void rq_flush_dcache_pages(struct request *rq);
 952 #else
 953 static inline void rq_flush_dcache_pages(struct request *rq)
 954 {
 955 }
 956 #endif
 957
 958 extern int blk_register_queue(struct gendisk *disk);
 959 extern void blk_unregister_queue(struct gendisk *disk);
 960 extern blk_qc_t generic_make_request(struct bio *bio);
 961 extern blk_qc_t direct_make_request(struct bio *bio);
 962 extern void blk_rq_init(struct request_queue *q, struct request *rq);
 963 extern void blk_init_request_from_bio(struct request *req, struct bio *bio);
 964 extern void blk_put_request(struct request *);
 965 extern void __blk_put_request(struct request_queue *, struct request *);
 966 extern struct request *blk_get_request(struct request_queue *, unsigned int op,
 967                                        blk_mq_req_flags_t flags);
 968 extern void blk_requeue_request(struct request_queue *, struct request *);
 969 extern int blk_lld_busy(struct request_queue *q);
 970 extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
 971                              struct bio_set *bs, gfp_t gfp_mask,
 972                              int (*bio_ctr)(struct bio *, struct bio *, void *),
 973                              void *data);
 974 extern void blk_rq_unprep_clone(struct request *rq);
 975 extern blk_status_t blk_insert_cloned_request(struct request_queue *q,
 976                                      struct request *rq);
 977 extern int blk_rq_append_bio(struct request *rq, struct bio **bio);
 978 extern void blk_delay_queue(struct request_queue *, unsigned long);
 979 extern void blk_queue_split(struct request_queue *, struct bio **);
 980 extern void blk_recount_segments(struct request_queue *, struct bio *);
 981 extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
 982 extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
 983                               unsigned int, void __user *);
 984 extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
 985                           unsigned int, void __user *);
 986 extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
 987                          struct scsi_ioctl_command __user *);
 988
 989 extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
 990 extern void blk_queue_exit(struct request_queue *q);
 991 extern void blk_start_queue(struct request_queue *q);
 992 extern void blk_start_queue_async(struct request_queue *q);
 993 extern void blk_stop_queue(struct request_queue *q);
 994 extern void blk_sync_queue(struct request_queue *q);
 995 extern void __blk_stop_queue(struct request_queue *q);
 996 extern void __blk_run_queue(struct request_queue *q);
 997 extern void __blk_run_queue_uncond(struct request_queue *q);
 998 extern void blk_run_queue(struct request_queue *);
 999 extern void blk_run_queue_async(struct request_queue *q);
1000 extern int blk_rq_map_user(struct request_queue *, struct request *,
1001                            struct rq_map_data *, void __user *, unsigned long,
1002                            gfp_t);
1003 extern int blk_rq_unmap_user(struct bio *);
1004 extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
1005 extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
1006                                struct rq_map_data *, const struct iov_iter *,
1007                                gfp_t);
1008 extern void blk_execute_rq(struct request_queue *, struct gendisk *,
1009                           struct request *, int);
1010 extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
1011                                   struct request *, int, rq_end_io_fn *);
1012
1013 int blk_status_to_errno(blk_status_t status);
1014 blk_status_t errno_to_blk_status(int errno);
1015
1016 bool blk_poll(struct request_queue *q, blk_qc_t cookie);
1017
1018 static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
1019 {
1020         return bdev->bd_disk->queue;    /* this is never NULL */
1021 }
1022
1023 /*
1024  * The basic unit of block I/O is a sector. It is used in a number of contexts
1025  * in Linux (blk, bio, genhd). The size of one sector is 512 = 2**9
1026  * bytes. Variables of type sector_t represent an offset or size that is a
1027  * multiple of 512 bytes. Hence these two constants.
1028  */
1029 #ifndef SECTOR_SHIFT
1030 #define SECTOR_SHIFT 9
1031 #endif
1032 #ifndef SECTOR_SIZE
1033 #define SECTOR_SIZE (1 << SECTOR_SHIFT)
1034 #endif
1035
1036 /*
1037  * blk_rq_pos()                 : the current sector
1038  * blk_rq_bytes()               : bytes left in the entire request
1039  * blk_rq_cur_bytes()           : bytes left in the current segment
1040  * blk_rq_err_bytes()           : bytes left till the next error boundary
1041  * blk_rq_sectors()             : sectors left in the entire request
1042  * blk_rq_cur_sectors()         : sectors left in the current segment
1043  */
1044 static inline sector_t blk_rq_pos(const struct request *rq)
1045 {
1046         return rq->__sector;
1047 }
1048
1049 static inline unsigned int blk_rq_bytes(const struct request *rq)
1050 {
1051         return rq->__data_len;
1052 }
1053
1054 static inline int blk_rq_cur_bytes(const struct request *rq)
1055 {
1056         return rq->bio ? bio_cur_bytes(rq->bio) : 0;
1057 }
1058
1059 extern unsigned int blk_rq_err_bytes(const struct request *rq);
1060
1061 static inline unsigned int blk_rq_sectors(const struct request *rq)
1062 {
1063         return blk_rq_bytes(rq) >> SECTOR_SHIFT;
1064 }
1065
1066 static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
1067 {
1068         return blk_rq_cur_bytes(rq) >> SECTOR_SHIFT;
1069 }
1070
1071 #ifdef CONFIG_BLK_DEV_ZONED
1072 static inline unsigned int blk_rq_zone_no(struct request *rq)
1073 {
1074         return blk_queue_zone_no(rq->q, blk_rq_pos(rq));
1075 }
1076
1077 static inline unsigned int blk_rq_zone_is_seq(struct request *rq)
1078 {
1079         return blk_queue_zone_is_seq(rq->q, blk_rq_pos(rq));
1080 }
1081 #endif /* CONFIG_BLK_DEV_ZONED */
1082
1083 /*
1084  * Some commands like WRITE SAME have a payload or data transfer size which
1085  * is different from the size of the request.  Any driver that supports such
1086  * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
1087  * calculate the data transfer size.
1088  */
1089 static inline unsigned int blk_rq_payload_bytes(struct request *rq)
1090 {
1091         if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1092                 return rq->special_vec.bv_len;
1093         return blk_rq_bytes(rq);
1094 }
1095
1096 static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
1097                                                      int op)
1098 {
1099         if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
1100                 return min(q->limits.max_discard_sectors,
1101                            UINT_MAX >> SECTOR_SHIFT);
1102
1103         if (unlikely(op == REQ_OP_WRITE_SAME))
1104                 return q->limits.max_write_same_sectors;
1105
1106         if (unlikely(op == REQ_OP_WRITE_ZEROES))
1107                 return q->limits.max_write_zeroes_sectors;
1108
1109         return q->limits.max_sectors;
1110 }
1111
1112 /*
1113  * Return maximum size of a request at given offset. Only valid for
1114  * file system requests.
1115  */
1116 static inline unsigned int blk_max_size_offset(struct request_queue *q,
1117                                                sector_t offset)
1118 {
1119         if (!q->limits.chunk_sectors)
1120                 return q->limits.max_sectors;
1121
1122         return min(q->limits.max_sectors, (unsigned int)(q->limits.chunk_sectors -
1123                         (offset & (q->limits.chunk_sectors - 1))));
1124 }
1125
1126 static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
1127                                                   sector_t offset)
1128 {
1129         struct request_queue *q = rq->q;
1130
1131         if (blk_rq_is_passthrough(rq))
1132                 return q->limits.max_hw_sectors;
1133
1134         if (!q->limits.chunk_sectors ||
1135             req_op(rq) == REQ_OP_DISCARD ||
1136             req_op(rq) == REQ_OP_SECURE_ERASE)
1137                 return blk_queue_get_max_sectors(q, req_op(rq));
1138
1139         return min(blk_max_size_offset(q, offset),
1140                         blk_queue_get_max_sectors(q, req_op(rq)));
1141 }
1142
1143 static inline unsigned int blk_rq_count_bios(struct request *rq)
1144 {
1145         unsigned int nr_bios = 0;
1146         struct bio *bio;
1147
1148         __rq_for_each_bio(bio, rq)
1149                 nr_bios++;
1150
1151         return nr_bios;
1152 }
1153
1154 /*
1155  * Request issue related functions.
1156  */
1157 extern struct request *blk_peek_request(struct request_queue *q);
1158 extern void blk_start_request(struct request *rq);
1159 extern struct request *blk_fetch_request(struct request_queue *q);
1160
1161 void blk_steal_bios(struct bio_list *list, struct request *rq);
1162
1163 /*
1164  * Request completion related functions.
1165  *
1166  * blk_update_request() completes given number of bytes and updates
1167  * the request without completing it.
1168  *
1169  * blk_end_request() and friends.  __blk_end_request() must be called
1170  * with the request queue spinlock acquired.
1171  *
1172  * Several drivers define their own end_request and call
1173  * blk_end_request() for parts of the original function.
1174  * This prevents code duplication in drivers.
1175  */
1176 extern bool blk_update_request(struct request *rq, blk_status_t error,
1177                                unsigned int nr_bytes);
1178 extern void blk_finish_request(struct request *rq, blk_status_t error);
1179 extern bool blk_end_request(struct request *rq, blk_status_t error,
1180                             unsigned int nr_bytes);
1181 extern void blk_end_request_all(struct request *rq, blk_status_t error);
1182 extern bool __blk_end_request(struct request *rq, blk_status_t error,
1183                               unsigned int nr_bytes);
1184 extern void __blk_end_request_all(struct request *rq, blk_status_t error);
1185 extern bool __blk_end_request_cur(struct request *rq, blk_status_t error);
1186
1187 extern void blk_complete_request(struct request *);
1188 extern void __blk_complete_request(struct request *);
1189 extern void blk_abort_request(struct request *);
1190 extern void blk_unprep_request(struct request *);
1191
1192 /*
1193  * Access functions for manipulating queue properties
1194  */
1195 extern struct request_queue *blk_init_queue_node(request_fn_proc *rfn,
1196                                         spinlock_t *lock, int node_id);
1197 extern struct request_queue *blk_init_queue(request_fn_proc *, spinlock_t *);
1198 extern int blk_init_allocated_queue(struct request_queue *);
1199 extern void blk_cleanup_queue(struct request_queue *);
1200 extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
1201 extern void blk_queue_bounce_limit(struct request_queue *, u64);
1202 extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
1203 extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
1204 extern void blk_queue_max_segments(struct request_queue *, unsigned short);
1205 extern void blk_queue_max_discard_segments(struct request_queue *,
1206                 unsigned short);
1207 extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
1208 extern void blk_queue_max_discard_sectors(struct request_queue *q,
1209                 unsigned int max_discard_sectors);
1210 extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1211                 unsigned int max_write_same_sectors);
1212 extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1213                 unsigned int max_write_same_sectors);
1214 extern void blk_queue_logical_block_size(struct request_queue *, unsigned short);
1215 extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
1216 extern void blk_queue_alignment_offset(struct request_queue *q,
1217                                        unsigned int alignment);
1218 extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
1219 extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
1220 extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
1221 extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
1222 extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
1223 extern void blk_set_default_limits(struct queue_limits *lim);
1224 extern void blk_set_stacking_limits(struct queue_limits *lim);
1225 extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1226                             sector_t offset);
1227 extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1228                             sector_t offset);
1229 extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1230                               sector_t offset);
1231 extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
1232 extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
1233 extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
1234 extern int blk_queue_dma_drain(struct request_queue *q,
1235                                dma_drain_needed_fn *dma_drain_needed,
1236                                void *buf, unsigned int size);
1237 extern void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn);
1238 extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
1239 extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
1240 extern void blk_queue_prep_rq(struct request_queue *, prep_rq_fn *pfn);
1241 extern void blk_queue_unprep_rq(struct request_queue *, unprep_rq_fn *ufn);
1242 extern void blk_queue_dma_alignment(struct request_queue *, int);
1243 extern void blk_queue_update_dma_alignment(struct request_queue *, int);
1244 extern void blk_queue_softirq_done(struct request_queue *, softirq_done_fn *);
1245 extern void blk_queue_rq_timed_out(struct request_queue *, rq_timed_out_fn *);
1246 extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
1247 extern void blk_queue_flush_queueable(struct request_queue *q, bool queueable);
1248 extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
1249
1250 /*
1251  * Number of physical segments as sent to the device.
1252  *
1253  * Normally this is the number of discontiguous data segments sent by the
1254  * submitter.  But for data-less command like discard we might have no
1255  * actual data segments submitted, but the driver might have to add it's
1256  * own special payload.  In that case we still return 1 here so that this
1257  * special payload will be mapped.
1258  */
1259 static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1260 {
1261         if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1262                 return 1;
1263         return rq->nr_phys_segments;
1264 }
1265
1266 /*
1267  * Number of discard segments (or ranges) the driver needs to fill in.
1268  * Each discard bio merged into a request is counted as one segment.
1269  */
1270 static inline unsigned short blk_rq_nr_discard_segments(struct request *rq)
1271 {
1272         return max_t(unsigned short, rq->nr_phys_segments, 1);
1273 }
1274
1275 extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
1276 extern void blk_dump_rq_flags(struct request *, char *);
1277 extern long nr_blockdev_pages(void);
1278
1279 bool __must_check blk_get_queue(struct request_queue *);
1280 struct request_queue *blk_alloc_queue(gfp_t);
1281 struct request_queue *blk_alloc_queue_node(gfp_t gfp_mask, int node_id,
1282                                            spinlock_t *lock);
1283 extern void blk_put_queue(struct request_queue *);
1284 extern void blk_set_queue_dying(struct request_queue *);
1285
1286 /*
1287  * block layer runtime pm functions
1288  */
1289 #ifdef CONFIG_PM
1290 extern void blk_pm_runtime_init(struct request_queue *q, struct device *dev);
1291 extern int blk_pre_runtime_suspend(struct request_queue *q);
1292 extern void blk_post_runtime_suspend(struct request_queue *q, int err);
1293 extern void blk_pre_runtime_resume(struct request_queue *q);
1294 extern void blk_post_runtime_resume(struct request_queue *q, int err);
1295 extern void blk_set_runtime_active(struct request_queue *q);
1296 #else
1297 static inline void blk_pm_runtime_init(struct request_queue *q,
1298         struct device *dev) {}
1299 static inline int blk_pre_runtime_suspend(struct request_queue *q)
1300 {
1301         return -ENOSYS;
1302 }
1303 static inline void blk_post_runtime_suspend(struct request_queue *q, int err) {}
1304 static inline void blk_pre_runtime_resume(struct request_queue *q) {}
1305 static inline void blk_post_runtime_resume(struct request_queue *q, int err) {}
1306 static inline void blk_set_runtime_active(struct request_queue *q) {}
1307 #endif
1308
1309 /*
1310  * blk_plug permits building a queue of related requests by holding the I/O
1311  * fragments for a short period. This allows merging of sequential requests
1312  * into single larger request. As the requests are moved from a per-task list to
1313  * the device's request_queue in a batch, this results in improved scalability
1314  * as the lock contention for request_queue lock is reduced.
1315  *
1316  * It is ok not to disable preemption when adding the request to the plug list
1317  * or when attempting a merge, because blk_schedule_flush_list() will only flush
1318  * the plug list when the task sleeps by itself. For details, please see
1319  * schedule() where blk_schedule_flush_plug() is called.
1320  */
1321 struct blk_plug {
1322         struct list_head list; /* requests */
1323         struct list_head mq_list; /* blk-mq requests */
1324         struct list_head cb_list; /* md requires an unplug callback */
1325 };
1326 #define BLK_MAX_REQUEST_COUNT 16
1327 #define BLK_PLUG_FLUSH_SIZE (128 * 1024)
1328
1329 struct blk_plug_cb;
1330 typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
1331 struct blk_plug_cb {
1332         struct list_head list;
1333         blk_plug_cb_fn callback;
1334         void *data;
1335 };
1336 extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1337                                              void *data, int size);
1338 extern void blk_start_plug(struct blk_plug *);
1339 extern void blk_finish_plug(struct blk_plug *);
1340 extern void blk_flush_plug_list(struct blk_plug *, bool);
1341
1342 static inline void blk_flush_plug(struct task_struct *tsk)
1343 {
1344         struct blk_plug *plug = tsk->plug;
1345
1346         if (plug)
1347                 blk_flush_plug_list(plug, false);
1348 }
1349
1350 static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1351 {
1352         struct blk_plug *plug = tsk->plug;
1353
1354         if (plug)
1355                 blk_flush_plug_list(plug, true);
1356 }
1357
1358 static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1359 {
1360         struct blk_plug *plug = tsk->plug;
1361
1362         return plug &&
1363                 (!list_empty(&plug->list) ||
1364                  !list_empty(&plug->mq_list) ||
1365                  !list_empty(&plug->cb_list));
1366 }
1367
1368 /*
1369  * tag stuff
1370  */
1371 extern int blk_queue_start_tag(struct request_queue *, struct request *);
1372 extern struct request *blk_queue_find_tag(struct request_queue *, int);
1373 extern void blk_queue_end_tag(struct request_queue *, struct request *);
1374 extern int blk_queue_init_tags(struct request_queue *, int, struct blk_queue_tag *, int);
1375 extern void blk_queue_free_tags(struct request_queue *);
1376 extern int blk_queue_resize_tags(struct request_queue *, int);
1377 extern struct blk_queue_tag *blk_init_tags(int, int);
1378 extern void blk_free_tags(struct blk_queue_tag *);
1379
1380 static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
1381                                                 int tag)
1382 {
1383         if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
1384                 return NULL;
1385         return bqt->tag_index[tag];
1386 }
1387
1388 extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
1389 extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1390                 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
1391
1392 #define BLKDEV_DISCARD_SECURE   (1 << 0)        /* issue a secure erase */
1393
1394 extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1395                 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
1396 extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1397                 sector_t nr_sects, gfp_t gfp_mask, int flags,
1398                 struct bio **biop);
1399
1400 #define BLKDEV_ZERO_NOUNMAP     (1 << 0)  /* do not free blocks */
1401 #define BLKDEV_ZERO_NOFALLBACK  (1 << 1)  /* don't write explicit zeroes */
1402
1403 extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1404                 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
1405                 unsigned flags);
1406 extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1407                 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1408
1409 static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1410                 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
1411 {
1412         return blkdev_issue_discard(sb->s_bdev,
1413                                     block << (sb->s_blocksize_bits -
1414                                               SECTOR_SHIFT),
1415                                     nr_blocks << (sb->s_blocksize_bits -
1416                                                   SECTOR_SHIFT),
1417                                     gfp_mask, flags);
1418 }
1419 static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
1420                 sector_t nr_blocks, gfp_t gfp_mask)
1421 {
1422         return blkdev_issue_zeroout(sb->s_bdev,
1423                                     block << (sb->s_blocksize_bits -
1424                                               SECTOR_SHIFT),
1425                                     nr_blocks << (sb->s_blocksize_bits -
1426                                                   SECTOR_SHIFT),
1427                                     gfp_mask, 0);
1428 }
1429
1430 extern int blk_verify_command(unsigned char *cmd, fmode_t mode);
1431
1432 enum blk_default_limits {
1433         BLK_MAX_SEGMENTS        = 128,
1434         BLK_SAFE_MAX_SECTORS    = 255,
1435         BLK_DEF_MAX_SECTORS     = 2560,
1436         BLK_MAX_SEGMENT_SIZE    = 65536,
1437         BLK_SEG_BOUNDARY_MASK   = 0xFFFFFFFFUL,
1438 };
1439
1440 static inline unsigned long queue_segment_boundary(struct request_queue *q)
1441 {
1442         return q->limits.seg_boundary_mask;
1443 }
1444
1445 static inline unsigned long queue_virt_boundary(struct request_queue *q)
1446 {
1447         return q->limits.virt_boundary_mask;
1448 }
1449
1450 static inline unsigned int queue_max_sectors(struct request_queue *q)
1451 {
1452         return q->limits.max_sectors;
1453 }
1454
1455 static inline unsigned int queue_max_hw_sectors(struct request_queue *q)
1456 {
1457         return q->limits.max_hw_sectors;
1458 }
1459
1460 static inline unsigned short queue_max_segments(struct request_queue *q)
1461 {
1462         return q->limits.max_segments;
1463 }
1464
1465 static inline unsigned short queue_max_discard_segments(struct request_queue *q)
1466 {
1467         return q->limits.max_discard_segments;
1468 }
1469
1470 static inline unsigned int queue_max_segment_size(struct request_queue *q)
1471 {
1472         return q->limits.max_segment_size;
1473 }
1474
1475 static inline unsigned short queue_logical_block_size(struct request_queue *q)
1476 {
1477         int retval = 512;
1478
1479         if (q && q->limits.logical_block_size)
1480                 retval = q->limits.logical_block_size;
1481
1482         return retval;
1483 }
1484
1485 static inline unsigned short bdev_logical_block_size(struct block_device *bdev)
1486 {
1487         return queue_logical_block_size(bdev_get_queue(bdev));
1488 }
1489
1490 static inline unsigned int queue_physical_block_size(struct request_queue *q)
1491 {
1492         return q->limits.physical_block_size;
1493 }
1494
1495 static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
1496 {
1497         return queue_physical_block_size(bdev_get_queue(bdev));
1498 }
1499
1500 static inline unsigned int queue_io_min(struct request_queue *q)
1501 {
1502         return q->limits.io_min;
1503 }
1504
1505 static inline int bdev_io_min(struct block_device *bdev)
1506 {
1507         return queue_io_min(bdev_get_queue(bdev));
1508 }
1509
1510 static inline unsigned int queue_io_opt(struct request_queue *q)
1511 {
1512         return q->limits.io_opt;
1513 }
1514
1515 static inline int bdev_io_opt(struct block_device *bdev)
1516 {
1517         return queue_io_opt(bdev_get_queue(bdev));
1518 }
1519
1520 static inline int queue_alignment_offset(struct request_queue *q)
1521 {
1522         if (q->limits.misaligned)
1523                 return -1;
1524
1525         return q->limits.alignment_offset;
1526 }
1527
1528 static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
1529 {
1530         unsigned int granularity = max(lim->physical_block_size, lim->io_min);
1531         unsigned int alignment = sector_div(sector, granularity >> SECTOR_SHIFT)
1532                 << SECTOR_SHIFT;
1533
1534         return (granularity + lim->alignment_offset - alignment) % granularity;
1535 }
1536
1537 static inline int bdev_alignment_offset(struct block_device *bdev)
1538 {
1539         struct request_queue *q = bdev_get_queue(bdev);
1540
1541         if (q->limits.misaligned)
1542                 return -1;
1543
1544         if (bdev != bdev->bd_contains)
1545                 return bdev->bd_part->alignment_offset;
1546
1547         return q->limits.alignment_offset;
1548 }
1549
1550 static inline int queue_discard_alignment(struct request_queue *q)
1551 {
1552         if (q->limits.discard_misaligned)
1553                 return -1;
1554
1555         return q->limits.discard_alignment;
1556 }
1557
1558 static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
1559 {
1560         unsigned int alignment, granularity, offset;
1561
1562         if (!lim->max_discard_sectors)
1563                 return 0;
1564
1565         /* Why are these in bytes, not sectors? */
1566         alignment = lim->discard_alignment >> SECTOR_SHIFT;
1567         granularity = lim->discard_granularity >> SECTOR_SHIFT;
1568         if (!granularity)
1569                 return 0;
1570
1571         /* Offset of the partition start in 'granularity' sectors */
1572         offset = sector_div(sector, granularity);
1573
1574         /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1575         offset = (granularity + alignment - offset) % granularity;
1576
1577         /* Turn it back into bytes, gaah */
1578         return offset << SECTOR_SHIFT;
1579 }
1580
1581 static inline int bdev_discard_alignment(struct block_device *bdev)
1582 {
1583         struct request_queue *q = bdev_get_queue(bdev);
1584
1585         if (bdev != bdev->bd_contains)
1586                 return bdev->bd_part->discard_alignment;
1587
1588         return q->limits.discard_alignment;
1589 }
1590
1591 static inline unsigned int bdev_write_same(struct block_device *bdev)
1592 {
1593         struct request_queue *q = bdev_get_queue(bdev);
1594
1595         if (q)
1596                 return q->limits.max_write_same_sectors;
1597
1598         return 0;
1599 }
1600
1601 static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1602 {
1603         struct request_queue *q = bdev_get_queue(bdev);
1604
1605         if (q)
1606                 return q->limits.max_write_zeroes_sectors;
1607
1608         return 0;
1609 }
1610
1611 static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1612 {
1613         struct request_queue *q = bdev_get_queue(bdev);
1614
1615         if (q)
1616                 return blk_queue_zoned_model(q);
1617
1618         return BLK_ZONED_NONE;
1619 }
1620
1621 static inline bool bdev_is_zoned(struct block_device *bdev)
1622 {
1623         struct request_queue *q = bdev_get_queue(bdev);
1624
1625         if (q)
1626                 return blk_queue_is_zoned(q);
1627
1628         return false;
1629 }
1630
1631 static inline unsigned int bdev_zone_sectors(struct block_device *bdev)
1632 {
1633         struct request_queue *q = bdev_get_queue(bdev);
1634
1635         if (q)
1636                 return blk_queue_zone_sectors(q);
1637         return 0;
1638 }
1639
1640 static inline int queue_dma_alignment(struct request_queue *q)
1641 {
1642         return q ? q->dma_alignment : 511;
1643 }
1644
1645 static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
1646                                  unsigned int len)
1647 {
1648         unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
1649         return !(addr & alignment) && !(len & alignment);
1650 }
1651
1652 /* assumes size > 256 */
1653 static inline unsigned int blksize_bits(unsigned int size)
1654 {
1655         unsigned int bits = 8;
1656         do {
1657                 bits++;
1658                 size >>= 1;
1659         } while (size > 256);
1660         return bits;
1661 }
1662
1663 static inline unsigned int block_size(struct block_device *bdev)
1664 {
1665         return bdev->bd_block_size;
1666 }
1667
1668 static inline bool queue_flush_queueable(struct request_queue *q)
1669 {
1670         return !test_bit(QUEUE_FLAG_FLUSH_NQ, &q->queue_flags);
1671 }
1672
1673 typedef struct {struct page *v;} Sector;
1674
1675 unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
1676
1677 static inline void put_dev_sector(Sector p)
1678 {
1679         put_page(p.v);
1680 }
1681
1682 static inline bool __bvec_gap_to_prev(struct request_queue *q,
1683                                 struct bio_vec *bprv, unsigned int offset)
1684 {
1685         return offset ||
1686                 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
1687 }
1688
1689 /*
1690  * Check if adding a bio_vec after bprv with offset would create a gap in
1691  * the SG list. Most drivers don't care about this, but some do.
1692  */
1693 static inline bool bvec_gap_to_prev(struct request_queue *q,
1694                                 struct bio_vec *bprv, unsigned int offset)
1695 {
1696         if (!queue_virt_boundary(q))
1697                 return false;
1698         return __bvec_gap_to_prev(q, bprv, offset);
1699 }
1700
1701 /*
1702  * Check if the two bvecs from two bios can be merged to one segment.
1703  * If yes, no need to check gap between the two bios since the 1st bio
1704  * and the 1st bvec in the 2nd bio can be handled in one segment.
1705  */
1706 static inline bool bios_segs_mergeable(struct request_queue *q,
1707                 struct bio *prev, struct bio_vec *prev_last_bv,
1708                 struct bio_vec *next_first_bv)
1709 {
1710         if (!BIOVEC_PHYS_MERGEABLE(prev_last_bv, next_first_bv))
1711                 return false;
1712         if (!BIOVEC_SEG_BOUNDARY(q, prev_last_bv, next_first_bv))
1713                 return false;
1714         if (prev->bi_seg_back_size + next_first_bv->bv_len >
1715                         queue_max_segment_size(q))
1716                 return false;
1717         return true;
1718 }
1719
1720 static inline bool bio_will_gap(struct request_queue *q,
1721                                 struct request *prev_rq,
1722                                 struct bio *prev,
1723                                 struct bio *next)
1724 {
1725         if (bio_has_data(prev) && queue_virt_boundary(q)) {
1726                 struct bio_vec pb, nb;
1727
1728                 /*
1729                  * don't merge if the 1st bio starts with non-zero
1730                  * offset, otherwise it is quite difficult to respect
1731                  * sg gap limit. We work hard to merge a huge number of small
1732                  * single bios in case of mkfs.
1733                  */
1734                 if (prev_rq)
1735                         bio_get_first_bvec(prev_rq->bio, &pb);
1736                 else
1737                         bio_get_first_bvec(prev, &pb);
1738                 if (pb.bv_offset)
1739                         return true;
1740
1741                 /*
1742                  * We don't need to worry about the situation that the
1743                  * merged segment ends in unaligned virt boundary:
1744                  *
1745                  * - if 'pb' ends aligned, the merged segment ends aligned
1746                  * - if 'pb' ends unaligned, the next bio must include
1747                  *   one single bvec of 'nb', otherwise the 'nb' can't
1748                  *   merge with 'pb'
1749                  */
1750                 bio_get_last_bvec(prev, &pb);
1751                 bio_get_first_bvec(next, &nb);
1752
1753                 if (!bios_segs_mergeable(q, prev, &pb, &nb))
1754                         return __bvec_gap_to_prev(q, &pb, nb.bv_offset);
1755         }
1756
1757         return false;
1758 }
1759
1760 static inline bool req_gap_back_merge(struct request *req, struct bio *bio)
1761 {
1762         return bio_will_gap(req->q, req, req->biotail, bio);
1763 }
1764
1765 static inline bool req_gap_front_merge(struct request *req, struct bio *bio)
1766 {
1767         return bio_will_gap(req->q, NULL, bio, req->bio);
1768 }
1769
1770 int kblockd_schedule_work(struct work_struct *work);
1771 int kblockd_schedule_work_on(int cpu, struct work_struct *work);
1772 int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1773
1774 #define MODULE_ALIAS_BLOCKDEV(major,minor) \
1775         MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1776 #define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1777         MODULE_ALIAS("block-major-" __stringify(major) "-*")
1778
1779 #if defined(CONFIG_BLK_DEV_INTEGRITY)
1780
1781 enum blk_integrity_flags {
1782         BLK_INTEGRITY_VERIFY            = 1 << 0,
1783         BLK_INTEGRITY_GENERATE          = 1 << 1,
1784         BLK_INTEGRITY_DEVICE_CAPABLE    = 1 << 2,
1785         BLK_INTEGRITY_IP_CHECKSUM       = 1 << 3,
1786 };
1787
1788 struct blk_integrity_iter {
1789         void                    *prot_buf;
1790         void                    *data_buf;
1791         sector_t                seed;
1792         unsigned int            data_size;
1793         unsigned short          interval;
1794         const char              *disk_name;
1795 };
1796
1797 typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
1798
1799 struct blk_integrity_profile {
1800         integrity_processing_fn         *generate_fn;
1801         integrity_processing_fn         *verify_fn;
1802         const char                      *name;
1803 };
1804
1805 extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
1806 extern void blk_integrity_unregister(struct gendisk *);
1807 extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
1808 extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1809                                    struct scatterlist *);
1810 extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
1811 extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1812                                    struct request *);
1813 extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1814                                     struct bio *);
1815
1816 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1817 {
1818         struct blk_integrity *bi = &disk->queue->integrity;
1819
1820         if (!bi->profile)
1821                 return NULL;
1822
1823         return bi;
1824 }
1825
1826 static inline
1827 struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
1828 {
1829         return blk_get_integrity(bdev->bd_disk);
1830 }
1831
1832 static inline bool blk_integrity_rq(struct request *rq)
1833 {
1834         return rq->cmd_flags & REQ_INTEGRITY;
1835 }
1836
1837 static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1838                                                     unsigned int segs)
1839 {
1840         q->limits.max_integrity_segments = segs;
1841 }
1842
1843 static inline unsigned short
1844 queue_max_integrity_segments(struct request_queue *q)
1845 {
1846         return q->limits.max_integrity_segments;
1847 }
1848
1849 static inline bool integrity_req_gap_back_merge(struct request *req,
1850                                                 struct bio *next)
1851 {
1852         struct bio_integrity_payload *bip = bio_integrity(req->bio);
1853         struct bio_integrity_payload *bip_next = bio_integrity(next);
1854
1855         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1856                                 bip_next->bip_vec[0].bv_offset);
1857 }
1858
1859 static inline bool integrity_req_gap_front_merge(struct request *req,
1860                                                  struct bio *bio)
1861 {
1862         struct bio_integrity_payload *bip = bio_integrity(bio);
1863         struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
1864
1865         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1866                                 bip_next->bip_vec[0].bv_offset);
1867 }
1868
1869 /**
1870  * bio_integrity_intervals - Return number of integrity intervals for a bio
1871  * @bi:         blk_integrity profile for device
1872  * @sectors:    Size of the bio in 512-byte sectors
1873  *
1874  * Description: The block layer calculates everything in 512 byte
1875  * sectors but integrity metadata is done in terms of the data integrity
1876  * interval size of the storage device.  Convert the block layer sectors
1877  * to the appropriate number of integrity intervals.
1878  */
1879 static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1880                                                    unsigned int sectors)
1881 {
1882         return sectors >> (bi->interval_exp - 9);
1883 }
1884
1885 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1886                                                unsigned int sectors)
1887 {
1888         return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
1889 }
1890
1891 #else /* CONFIG_BLK_DEV_INTEGRITY */
1892
1893 struct bio;
1894 struct block_device;
1895 struct gendisk;
1896 struct blk_integrity;
1897
1898 static inline int blk_integrity_rq(struct request *rq)
1899 {
1900         return 0;
1901 }
1902 static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1903                                             struct bio *b)
1904 {
1905         return 0;
1906 }
1907 static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1908                                           struct bio *b,
1909                                           struct scatterlist *s)
1910 {
1911         return 0;
1912 }
1913 static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1914 {
1915         return NULL;
1916 }
1917 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1918 {
1919         return NULL;
1920 }
1921 static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1922 {
1923         return 0;
1924 }
1925 static inline void blk_integrity_register(struct gendisk *d,
1926                                          struct blk_integrity *b)
1927 {
1928 }
1929 static inline void blk_integrity_unregister(struct gendisk *d)
1930 {
1931 }
1932 static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1933                                                     unsigned int segs)
1934 {
1935 }
1936 static inline unsigned short queue_max_integrity_segments(struct request_queue *q)
1937 {
1938         return 0;
1939 }
1940 static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1941                                           struct request *r1,
1942                                           struct request *r2)
1943 {
1944         return true;
1945 }
1946 static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1947                                            struct request *r,
1948                                            struct bio *b)
1949 {
1950         return true;
1951 }
1952
1953 static inline bool integrity_req_gap_back_merge(struct request *req,
1954                                                 struct bio *next)
1955 {
1956         return false;
1957 }
1958 static inline bool integrity_req_gap_front_merge(struct request *req,
1959                                                  struct bio *bio)
1960 {
1961         return false;
1962 }
1963
1964 static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1965                                                    unsigned int sectors)
1966 {
1967         return 0;
1968 }
1969
1970 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1971                                                unsigned int sectors)
1972 {
1973         return 0;
1974 }
1975
1976 #endif /* CONFIG_BLK_DEV_INTEGRITY */
1977
1978 struct block_device_operations {
1979         int (*open) (struct block_device *, fmode_t);
1980         void (*release) (struct gendisk *, fmode_t);
1981         int (*rw_page)(struct block_device *, sector_t, struct page *, unsigned int);
1982         int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1983         int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1984         unsigned int (*check_events) (struct gendisk *disk,
1985                                       unsigned int clearing);
1986         /* ->media_changed() is DEPRECATED, use ->check_events() instead */
1987         int (*media_changed) (struct gendisk *);
1988         void (*unlock_native_capacity) (struct gendisk *);
1989         int (*revalidate_disk) (struct gendisk *);
1990         int (*getgeo)(struct block_device *, struct hd_geometry *);
1991         /* this callback is with swap_lock and sometimes page table lock held */
1992         void (*swap_slot_free_notify) (struct block_device *, unsigned long);
1993         struct module *owner;
1994         const struct pr_ops *pr_ops;
1995 };
1996
1997 extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1998                                  unsigned long);
1999 extern int bdev_read_page(struct block_device *, sector_t, struct page *);
2000 extern int bdev_write_page(struct block_device *, sector_t, struct page *,
2001                                                 struct writeback_control *);
2002
2003 #ifdef CONFIG_BLK_DEV_ZONED
2004 bool blk_req_needs_zone_write_lock(struct request *rq);
2005 void __blk_req_zone_write_lock(struct request *rq);
2006 void __blk_req_zone_write_unlock(struct request *rq);
2007
2008 static inline void blk_req_zone_write_lock(struct request *rq)
2009 {
2010         if (blk_req_needs_zone_write_lock(rq))
2011                 __blk_req_zone_write_lock(rq);
2012 }
2013
2014 static inline void blk_req_zone_write_unlock(struct request *rq)
2015 {
2016         if (rq->rq_flags & RQF_ZONE_WRITE_LOCKED)
2017                 __blk_req_zone_write_unlock(rq);
2018 }
2019
2020 static inline bool blk_req_zone_is_write_locked(struct request *rq)
2021 {
2022         return rq->q->seq_zones_wlock &&
2023                 test_bit(blk_rq_zone_no(rq), rq->q->seq_zones_wlock);
2024 }
2025
2026 static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
2027 {
2028         if (!blk_req_needs_zone_write_lock(rq))
2029                 return true;
2030         return !blk_req_zone_is_write_locked(rq);
2031 }
2032 #else
2033 static inline bool blk_req_needs_zone_write_lock(struct request *rq)
2034 {
2035         return false;
2036 }
2037
2038 static inline void blk_req_zone_write_lock(struct request *rq)
2039 {
2040 }
2041
2042 static inline void blk_req_zone_write_unlock(struct request *rq)
2043 {
2044 }
2045 static inline bool blk_req_zone_is_write_locked(struct request *rq)
2046 {
2047         return false;
2048 }
2049
2050 static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
2051 {
2052         return true;
2053 }
2054 #endif /* CONFIG_BLK_DEV_ZONED */
2055
2056 #else /* CONFIG_BLOCK */
2057
2058 struct block_device;
2059
2060 /*
2061  * stubs for when the block layer is configured out
2062  */
2063 #define buffer_heads_over_limit 0
2064
2065 static inline long nr_blockdev_pages(void)
2066 {
2067         return 0;
2068 }
2069
2070 struct blk_plug {
2071 };
2072
2073 static inline void blk_start_plug(struct blk_plug *plug)
2074 {
2075 }
2076
2077 static inline void blk_finish_plug(struct blk_plug *plug)
2078 {
2079 }
2080
2081 static inline void blk_flush_plug(struct task_struct *task)
2082 {
2083 }
2084
2085 static inline void blk_schedule_flush_plug(struct task_struct *task)
2086 {
2087 }
2088
2089
2090 static inline bool blk_needs_flush_plug(struct task_struct *tsk)
2091 {
2092         return false;
2093 }
2094
2095 static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
2096                                      sector_t *error_sector)
2097 {
2098         return 0;
2099 }
2100
2101 #endif /* CONFIG_BLOCK */
2102
2103 #endif