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