include/linux/blkdev.h

   1 #ifndef _LINUX_BLKDEV_H
   2 #define _LINUX_BLKDEV_H
   3
   4 #include <linux/sched.h>
   5
   6 #ifdef CONFIG_BLOCK
   7
   8 #include <linux/major.h>
   9 #include <linux/genhd.h>
  10 #include <linux/list.h>
  11 #include <linux/llist.h>
  12 #include <linux/timer.h>
  13 #include <linux/workqueue.h>
  14 #include <linux/pagemap.h>
  15 #include <linux/backing-dev-defs.h>
  16 #include <linux/wait.h>
  17 #include <linux/mempool.h>
  18 #include <linux/pfn.h>
  19 #include <linux/bio.h>
  20 #include <linux/stringify.h>
  21 #include <linux/gfp.h>
  22 #include <linux/bsg.h>
  23 #include <linux/smp.h>
  24 #include <linux/rcupdate.h>
  25 #include <linux/percpu-refcount.h>
  26 #include <linux/scatterlist.h>
  27
  28 struct module;
  29 struct scsi_ioctl_command;
  30
  31 struct request_queue;
  32 struct elevator_queue;
  33 struct blk_trace;
  34 struct request;
  35 struct sg_io_hdr;
  36 struct bsg_job;
  37 struct blkcg_gq;
  38 struct blk_flush_queue;
  39 struct pr_ops;
  40
  41 #define BLKDEV_MIN_RQ   4
  42 #define BLKDEV_MAX_RQ   128     /* Default maximum */
  43
  44 /*
  45  * Maximum number of blkcg policies allowed to be registered concurrently.
  46  * Defined here to simplify include dependency.
  47  */
  48 #define BLKCG_MAX_POLS          2
  49
  50 struct request;
  51 typedef void (rq_end_io_fn)(struct request *, int);
  52
  53 #define BLK_RL_SYNCFULL         (1U << 0)
  54 #define BLK_RL_ASYNCFULL        (1U << 1)
  55
  56 struct request_list {
  57         struct request_queue    *q;     /* the queue this rl belongs to */
  58 #ifdef CONFIG_BLK_CGROUP
  59         struct blkcg_gq         *blkg;  /* blkg this request pool belongs to */
  60 #endif
  61         /*
  62          * count[], starved[], and wait[] are indexed by
  63          * BLK_RW_SYNC/BLK_RW_ASYNC
  64          */
  65         int                     count[2];
  66         int                     starved[2];
  67         mempool_t               *rq_pool;
  68         wait_queue_head_t       wait[2];
  69         unsigned int            flags;
  70 };
  71
  72 /*
  73  * request command types
  74  */
  75 enum rq_cmd_type_bits {
  76         REQ_TYPE_FS             = 1,    /* fs request */
  77         REQ_TYPE_BLOCK_PC,              /* scsi command */
  78         REQ_TYPE_DRV_PRIV,              /* driver defined types from here */
  79 };
  80
  81 #define BLK_MAX_CDB     16
  82
  83 /*
  84  * Try to put the fields that are referenced together in the same cacheline.
  85  *
  86  * If you modify this structure, make sure to update blk_rq_init() and
  87  * especially blk_mq_rq_ctx_init() to take care of the added fields.
  88  */
  89 struct request {
  90         struct list_head queuelist;
  91         union {
  92                 struct call_single_data csd;
  93                 unsigned long fifo_time;
  94         };
  95
  96         struct request_queue *q;
  97         struct blk_mq_ctx *mq_ctx;
  98
  99         u64 cmd_flags;
 100         unsigned cmd_type;
 101         unsigned long atomic_flags;
 102
 103         int cpu;
 104
 105         /* the following two fields are internal, NEVER access directly */
 106         unsigned int __data_len;        /* total data len */
 107         sector_t __sector;              /* sector cursor */
 108
 109         struct bio *bio;
 110         struct bio *biotail;
 111
 112         /*
 113          * The hash is used inside the scheduler, and killed once the
 114          * request reaches the dispatch list. The ipi_list is only used
 115          * to queue the request for softirq completion, which is long
 116          * after the request has been unhashed (and even removed from
 117          * the dispatch list).
 118          */
 119         union {
 120                 struct hlist_node hash; /* merge hash */
 121                 struct list_head ipi_list;
 122         };
 123
 124         /*
 125          * The rb_node is only used inside the io scheduler, requests
 126          * are pruned when moved to the dispatch queue. So let the
 127          * completion_data share space with the rb_node.
 128          */
 129         union {
 130                 struct rb_node rb_node; /* sort/lookup */
 131                 void *completion_data;
 132         };
 133
 134         /*
 135          * Three pointers are available for the IO schedulers, if they need
 136          * more they have to dynamically allocate it.  Flush requests are
 137          * never put on the IO scheduler. So let the flush fields share
 138          * space with the elevator data.
 139          */
 140         union {
 141                 struct {
 142                         struct io_cq            *icq;
 143                         void                    *priv[2];
 144                 } elv;
 145
 146                 struct {
 147                         unsigned int            seq;
 148                         struct list_head        list;
 149                         rq_end_io_fn            *saved_end_io;
 150                 } flush;
 151         };
 152
 153         struct gendisk *rq_disk;
 154         struct hd_struct *part;
 155         unsigned long start_time;
 156 #ifdef CONFIG_BLK_CGROUP
 157         struct request_list *rl;                /* rl this rq is alloced from */
 158         unsigned long long start_time_ns;
 159         unsigned long long io_start_time_ns;    /* when passed to hardware */
 160 #endif
 161         /* Number of scatter-gather DMA addr+len pairs after
 162          * physical address coalescing is performed.
 163          */
 164         unsigned short nr_phys_segments;
 165 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 166         unsigned short nr_integrity_segments;
 167 #endif
 168
 169         unsigned short ioprio;
 170
 171         void *special;          /* opaque pointer available for LLD use */
 172
 173         int tag;
 174         int errors;
 175
 176         /*
 177          * when request is used as a packet command carrier
 178          */
 179         unsigned char __cmd[BLK_MAX_CDB];
 180         unsigned char *cmd;
 181         unsigned short cmd_len;
 182
 183         unsigned int extra_len; /* length of alignment and padding */
 184         unsigned int sense_len;
 185         unsigned int resid_len; /* residual count */
 186         void *sense;
 187
 188         unsigned long deadline;
 189         struct list_head timeout_list;
 190         unsigned int timeout;
 191         int retries;
 192
 193         /*
 194          * completion callback.
 195          */
 196         rq_end_io_fn *end_io;
 197         void *end_io_data;
 198
 199         /* for bidi */
 200         struct request *next_rq;
 201 };
 202
 203 #define REQ_OP_SHIFT (8 * sizeof(u64) - REQ_OP_BITS)
 204 #define req_op(req)  ((req)->cmd_flags >> REQ_OP_SHIFT)
 205
 206 #define req_set_op(req, op) do {                                \
 207         WARN_ON(op >= (1 << REQ_OP_BITS));                      \
 208         (req)->cmd_flags &= ((1ULL << REQ_OP_SHIFT) - 1);       \
 209         (req)->cmd_flags |= ((u64) (op) << REQ_OP_SHIFT);       \
 210 } while (0)
 211
 212 #define req_set_op_attrs(req, op, flags) do {   \
 213         req_set_op(req, op);                    \
 214         (req)->cmd_flags |= flags;              \
 215 } while (0)
 216
 217 static inline unsigned short req_get_ioprio(struct request *req)
 218 {
 219         return req->ioprio;
 220 }
 221
 222 #include <linux/elevator.h>
 223
 224 struct blk_queue_ctx;
 225
 226 typedef void (request_fn_proc) (struct request_queue *q);
 227 typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
 228 typedef int (prep_rq_fn) (struct request_queue *, struct request *);
 229 typedef void (unprep_rq_fn) (struct request_queue *, struct request *);
 230
 231 struct bio_vec;
 232 typedef void (softirq_done_fn)(struct request *);
 233 typedef int (dma_drain_needed_fn)(struct request *);
 234 typedef int (lld_busy_fn) (struct request_queue *q);
 235 typedef int (bsg_job_fn) (struct bsg_job *);
 236
 237 enum blk_eh_timer_return {
 238         BLK_EH_NOT_HANDLED,
 239         BLK_EH_HANDLED,
 240         BLK_EH_RESET_TIMER,
 241 };
 242
 243 typedef enum blk_eh_timer_return (rq_timed_out_fn)(struct request *);
 244
 245 enum blk_queue_state {
 246         Queue_down,
 247         Queue_up,
 248 };
 249
 250 struct blk_queue_tag {
 251         struct request **tag_index;     /* map of busy tags */
 252         unsigned long *tag_map;         /* bit map of free/busy tags */
 253         int busy;                       /* current depth */
 254         int max_depth;                  /* what we will send to device */
 255         int real_max_depth;             /* what the array can hold */
 256         atomic_t refcnt;                /* map can be shared */
 257         int alloc_policy;               /* tag allocation policy */
 258         int next_tag;                   /* next tag */
 259 };
 260 #define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
 261 #define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
 262
 263 #define BLK_SCSI_MAX_CMDS       (256)
 264 #define BLK_SCSI_CMD_PER_LONG   (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
 265
 266 struct queue_limits {
 267         unsigned long           bounce_pfn;
 268         unsigned long           seg_boundary_mask;
 269         unsigned long           virt_boundary_mask;
 270
 271         unsigned int            max_hw_sectors;
 272         unsigned int            max_dev_sectors;
 273         unsigned int            chunk_sectors;
 274         unsigned int            max_sectors;
 275         unsigned int            max_segment_size;
 276         unsigned int            physical_block_size;
 277         unsigned int            alignment_offset;
 278         unsigned int            io_min;
 279         unsigned int            io_opt;
 280         unsigned int            max_discard_sectors;
 281         unsigned int            max_hw_discard_sectors;
 282         unsigned int            max_write_same_sectors;
 283         unsigned int            discard_granularity;
 284         unsigned int            discard_alignment;
 285
 286         unsigned short          logical_block_size;
 287         unsigned short          max_segments;
 288         unsigned short          max_integrity_segments;
 289
 290         unsigned char           misaligned;
 291         unsigned char           discard_misaligned;
 292         unsigned char           cluster;
 293         unsigned char           discard_zeroes_data;
 294         unsigned char           raid_partial_stripes_expensive;
 295 };
 296
 297 struct request_queue {
 298         /*
 299          * Together with queue_head for cacheline sharing
 300          */
 301         struct list_head        queue_head;
 302         struct request          *last_merge;
 303         struct elevator_queue   *elevator;
 304         int                     nr_rqs[2];      /* # allocated [a]sync rqs */
 305         int                     nr_rqs_elvpriv; /* # allocated rqs w/ elvpriv */
 306
 307         /*
 308          * If blkcg is not used, @q->root_rl serves all requests.  If blkcg
 309          * is used, root blkg allocates from @q->root_rl and all other
 310          * blkgs from their own blkg->rl.  Which one to use should be
 311          * determined using bio_request_list().
 312          */
 313         struct request_list     root_rl;
 314
 315         request_fn_proc         *request_fn;
 316         make_request_fn         *make_request_fn;
 317         prep_rq_fn              *prep_rq_fn;
 318         unprep_rq_fn            *unprep_rq_fn;
 319         softirq_done_fn         *softirq_done_fn;
 320         rq_timed_out_fn         *rq_timed_out_fn;
 321         dma_drain_needed_fn     *dma_drain_needed;
 322         lld_busy_fn             *lld_busy_fn;
 323
 324         struct blk_mq_ops       *mq_ops;
 325
 326         unsigned int            *mq_map;
 327
 328         /* sw queues */
 329         struct blk_mq_ctx __percpu      *queue_ctx;
 330         unsigned int            nr_queues;
 331
 332         /* hw dispatch queues */
 333         struct blk_mq_hw_ctx    **queue_hw_ctx;
 334         unsigned int            nr_hw_queues;
 335
 336         /*
 337          * Dispatch queue sorting
 338          */
 339         sector_t                end_sector;
 340         struct request          *boundary_rq;
 341
 342         /*
 343          * Delayed queue handling
 344          */
 345         struct delayed_work     delay_work;
 346
 347         struct backing_dev_info backing_dev_info;
 348
 349         /*
 350          * The queue owner gets to use this for whatever they like.
 351          * ll_rw_blk doesn't touch it.
 352          */
 353         void                    *queuedata;
 354
 355         /*
 356          * various queue flags, see QUEUE_* below
 357          */
 358         unsigned long           queue_flags;
 359
 360         /*
 361          * ida allocated id for this queue.  Used to index queues from
 362          * ioctx.
 363          */
 364         int                     id;
 365
 366         /*
 367          * queue needs bounce pages for pages above this limit
 368          */
 369         gfp_t                   bounce_gfp;
 370
 371         /*
 372          * protects queue structures from reentrancy. ->__queue_lock should
 373          * _never_ be used directly, it is queue private. always use
 374          * ->queue_lock.
 375          */
 376         spinlock_t              __queue_lock;
 377         spinlock_t              *queue_lock;
 378
 379         /*
 380          * queue kobject
 381          */
 382         struct kobject kobj;
 383
 384         /*
 385          * mq queue kobject
 386          */
 387         struct kobject mq_kobj;
 388
 389 #ifdef  CONFIG_BLK_DEV_INTEGRITY
 390         struct blk_integrity integrity;
 391 #endif  /* CONFIG_BLK_DEV_INTEGRITY */
 392
 393 #ifdef CONFIG_PM
 394         struct device           *dev;
 395         int                     rpm_status;
 396         unsigned int            nr_pending;
 397 #endif
 398
 399         /*
 400          * queue settings
 401          */
 402         unsigned long           nr_requests;    /* Max # of requests */
 403         unsigned int            nr_congestion_on;
 404         unsigned int            nr_congestion_off;
 405         unsigned int            nr_batching;
 406
 407         unsigned int            dma_drain_size;
 408         void                    *dma_drain_buffer;
 409         unsigned int            dma_pad_mask;
 410         unsigned int            dma_alignment;
 411
 412         struct blk_queue_tag    *queue_tags;
 413         struct list_head        tag_busy_list;
 414
 415         unsigned int            nr_sorted;
 416         unsigned int            in_flight[2];
 417         /*
 418          * Number of active block driver functions for which blk_drain_queue()
 419          * must wait. Must be incremented around functions that unlock the
 420          * queue_lock internally, e.g. scsi_request_fn().
 421          */
 422         unsigned int            request_fn_active;
 423
 424         unsigned int            rq_timeout;
 425         struct timer_list       timeout;
 426         struct work_struct      timeout_work;
 427         struct list_head        timeout_list;
 428
 429         struct list_head        icq_list;
 430 #ifdef CONFIG_BLK_CGROUP
 431         DECLARE_BITMAP          (blkcg_pols, BLKCG_MAX_POLS);
 432         struct blkcg_gq         *root_blkg;
 433         struct list_head        blkg_list;
 434 #endif
 435
 436         struct queue_limits     limits;
 437
 438         /*
 439          * sg stuff
 440          */
 441         unsigned int            sg_timeout;
 442         unsigned int            sg_reserved_size;
 443         int                     node;
 444 #ifdef CONFIG_BLK_DEV_IO_TRACE
 445         struct blk_trace        *blk_trace;
 446 #endif
 447         /*
 448          * for flush operations
 449          */
 450         struct blk_flush_queue  *fq;
 451
 452         struct list_head        requeue_list;
 453         spinlock_t              requeue_lock;
 454         struct work_struct      requeue_work;
 455
 456         struct mutex            sysfs_lock;
 457
 458         int                     bypass_depth;
 459         atomic_t                mq_freeze_depth;
 460
 461 #if defined(CONFIG_BLK_DEV_BSG)
 462         bsg_job_fn              *bsg_job_fn;
 463         int                     bsg_job_size;
 464         struct bsg_class_device bsg_dev;
 465 #endif
 466
 467 #ifdef CONFIG_BLK_DEV_THROTTLING
 468         /* Throttle data */
 469         struct throtl_data *td;
 470 #endif
 471         struct rcu_head         rcu_head;
 472         wait_queue_head_t       mq_freeze_wq;
 473         struct percpu_ref       q_usage_counter;
 474         struct list_head        all_q_node;
 475
 476         struct blk_mq_tag_set   *tag_set;
 477         struct list_head        tag_set_list;
 478         struct bio_set          *bio_split;
 479
 480         bool                    mq_sysfs_init_done;
 481 };
 482
 483 #define QUEUE_FLAG_QUEUED       1       /* uses generic tag queueing */
 484 #define QUEUE_FLAG_STOPPED      2       /* queue is stopped */
 485 #define QUEUE_FLAG_SYNCFULL     3       /* read queue has been filled */
 486 #define QUEUE_FLAG_ASYNCFULL    4       /* write queue has been filled */
 487 #define QUEUE_FLAG_DYING        5       /* queue being torn down */
 488 #define QUEUE_FLAG_BYPASS       6       /* act as dumb FIFO queue */
 489 #define QUEUE_FLAG_BIDI         7       /* queue supports bidi requests */
 490 #define QUEUE_FLAG_NOMERGES     8       /* disable merge attempts */
 491 #define QUEUE_FLAG_SAME_COMP    9       /* complete on same CPU-group */
 492 #define QUEUE_FLAG_FAIL_IO     10       /* fake timeout */
 493 #define QUEUE_FLAG_STACKABLE   11       /* supports request stacking */
 494 #define QUEUE_FLAG_NONROT      12       /* non-rotational device (SSD) */
 495 #define QUEUE_FLAG_VIRT        QUEUE_FLAG_NONROT /* paravirt device */
 496 #define QUEUE_FLAG_IO_STAT     13       /* do IO stats */
 497 #define QUEUE_FLAG_DISCARD     14       /* supports DISCARD */
 498 #define QUEUE_FLAG_NOXMERGES   15       /* No extended merges */
 499 #define QUEUE_FLAG_ADD_RANDOM  16       /* Contributes to random pool */
 500 #define QUEUE_FLAG_SECERASE    17       /* supports secure erase */
 501 #define QUEUE_FLAG_SAME_FORCE  18       /* force complete on same CPU */
 502 #define QUEUE_FLAG_DEAD        19       /* queue tear-down finished */
 503 #define QUEUE_FLAG_INIT_DONE   20       /* queue is initialized */
 504 #define QUEUE_FLAG_NO_SG_MERGE 21       /* don't attempt to merge SG segments*/
 505 #define QUEUE_FLAG_POLL        22       /* IO polling enabled if set */
 506 #define QUEUE_FLAG_WC          23       /* Write back caching */
 507 #define QUEUE_FLAG_FUA         24       /* device supports FUA writes */
 508 #define QUEUE_FLAG_FLUSH_NQ    25       /* flush not queueuable */
 509
 510 #define QUEUE_FLAG_DEFAULT      ((1 << QUEUE_FLAG_IO_STAT) |            \
 511                                  (1 << QUEUE_FLAG_STACKABLE)    |       \
 512                                  (1 << QUEUE_FLAG_SAME_COMP)    |       \
 513                                  (1 << QUEUE_FLAG_ADD_RANDOM))
 514
 515 #define QUEUE_FLAG_MQ_DEFAULT   ((1 << QUEUE_FLAG_IO_STAT) |            \
 516                                  (1 << QUEUE_FLAG_STACKABLE)    |       \
 517                                  (1 << QUEUE_FLAG_SAME_COMP)    |       \
 518                                  (1 << QUEUE_FLAG_POLL))
 519
 520 static inline void queue_lockdep_assert_held(struct request_queue *q)
 521 {
 522         if (q->queue_lock)
 523                 lockdep_assert_held(q->queue_lock);
 524 }
 525
 526 static inline void queue_flag_set_unlocked(unsigned int flag,
 527                                            struct request_queue *q)
 528 {
 529         __set_bit(flag, &q->queue_flags);
 530 }
 531
 532 static inline int queue_flag_test_and_clear(unsigned int flag,
 533                                             struct request_queue *q)
 534 {
 535         queue_lockdep_assert_held(q);
 536
 537         if (test_bit(flag, &q->queue_flags)) {
 538                 __clear_bit(flag, &q->queue_flags);
 539                 return 1;
 540         }
 541
 542         return 0;
 543 }
 544
 545 static inline int queue_flag_test_and_set(unsigned int flag,
 546                                           struct request_queue *q)
 547 {
 548         queue_lockdep_assert_held(q);
 549
 550         if (!test_bit(flag, &q->queue_flags)) {
 551                 __set_bit(flag, &q->queue_flags);
 552                 return 0;
 553         }
 554
 555         return 1;
 556 }
 557
 558 static inline void queue_flag_set(unsigned int flag, struct request_queue *q)
 559 {
 560         queue_lockdep_assert_held(q);
 561         __set_bit(flag, &q->queue_flags);
 562 }
 563
 564 static inline void queue_flag_clear_unlocked(unsigned int flag,
 565                                              struct request_queue *q)
 566 {
 567         __clear_bit(flag, &q->queue_flags);
 568 }
 569
 570 static inline int queue_in_flight(struct request_queue *q)
 571 {
 572         return q->in_flight[0] + q->in_flight[1];
 573 }
 574
 575 static inline void queue_flag_clear(unsigned int flag, struct request_queue *q)
 576 {
 577         queue_lockdep_assert_held(q);
 578         __clear_bit(flag, &q->queue_flags);
 579 }
 580
 581 #define blk_queue_tagged(q)     test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
 582 #define blk_queue_stopped(q)    test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
 583 #define blk_queue_dying(q)      test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
 584 #define blk_queue_dead(q)       test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
 585 #define blk_queue_bypass(q)     test_bit(QUEUE_FLAG_BYPASS, &(q)->queue_flags)
 586 #define blk_queue_init_done(q)  test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
 587 #define blk_queue_nomerges(q)   test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
 588 #define blk_queue_noxmerges(q)  \
 589         test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
 590 #define blk_queue_nonrot(q)     test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
 591 #define blk_queue_io_stat(q)    test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
 592 #define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
 593 #define blk_queue_stackable(q)  \
 594         test_bit(QUEUE_FLAG_STACKABLE, &(q)->queue_flags)
 595 #define blk_queue_discard(q)    test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
 596 #define blk_queue_secure_erase(q) \
 597         (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
 598
 599 #define blk_noretry_request(rq) \
 600         ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
 601                              REQ_FAILFAST_DRIVER))
 602
 603 #define blk_account_rq(rq) \
 604         (((rq)->cmd_flags & REQ_STARTED) && \
 605          ((rq)->cmd_type == REQ_TYPE_FS))
 606
 607 #define blk_rq_cpu_valid(rq)    ((rq)->cpu != -1)
 608 #define blk_bidi_rq(rq)         ((rq)->next_rq != NULL)
 609 /* rq->queuelist of dequeued request must be list_empty() */
 610 #define blk_queued_rq(rq)       (!list_empty(&(rq)->queuelist))
 611
 612 #define list_entry_rq(ptr)      list_entry((ptr), struct request, queuelist)
 613
 614 #define rq_data_dir(rq)         (op_is_write(req_op(rq)) ? WRITE : READ)
 615
 616 /*
 617  * Driver can handle struct request, if it either has an old style
 618  * request_fn defined, or is blk-mq based.
 619  */
 620 static inline bool queue_is_rq_based(struct request_queue *q)
 621 {
 622         return q->request_fn || q->mq_ops;
 623 }
 624
 625 static inline unsigned int blk_queue_cluster(struct request_queue *q)
 626 {
 627         return q->limits.cluster;
 628 }
 629
 630 /*
 631  * We regard a request as sync, if either a read or a sync write
 632  */
 633 static inline bool rw_is_sync(int op, unsigned int rw_flags)
 634 {
 635         return op == REQ_OP_READ || (rw_flags & REQ_SYNC);
 636 }
 637
 638 static inline bool rq_is_sync(struct request *rq)
 639 {
 640         return rw_is_sync(req_op(rq), rq->cmd_flags);
 641 }
 642
 643 static inline bool blk_rl_full(struct request_list *rl, bool sync)
 644 {
 645         unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
 646
 647         return rl->flags & flag;
 648 }
 649
 650 static inline void blk_set_rl_full(struct request_list *rl, bool sync)
 651 {
 652         unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
 653
 654         rl->flags |= flag;
 655 }
 656
 657 static inline void blk_clear_rl_full(struct request_list *rl, bool sync)
 658 {
 659         unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
 660
 661         rl->flags &= ~flag;
 662 }
 663
 664 static inline bool rq_mergeable(struct request *rq)
 665 {
 666         if (rq->cmd_type != REQ_TYPE_FS)
 667                 return false;
 668
 669         if (req_op(rq) == REQ_OP_FLUSH)
 670                 return false;
 671
 672         if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
 673                 return false;
 674
 675         return true;
 676 }
 677
 678 static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
 679 {
 680         if (bio_data(a) == bio_data(b))
 681                 return true;
 682
 683         return false;
 684 }
 685
 686 /*
 687  * q->prep_rq_fn return values
 688  */
 689 enum {
 690         BLKPREP_OK,             /* serve it */
 691         BLKPREP_KILL,           /* fatal error, kill, return -EIO */
 692         BLKPREP_DEFER,          /* leave on queue */
 693         BLKPREP_INVALID,        /* invalid command, kill, return -EREMOTEIO */
 694 };
 695
 696 extern unsigned long blk_max_low_pfn, blk_max_pfn;
 697
 698 /*
 699  * standard bounce addresses:
 700  *
 701  * BLK_BOUNCE_HIGH      : bounce all highmem pages
 702  * BLK_BOUNCE_ANY       : don't bounce anything
 703  * BLK_BOUNCE_ISA       : bounce pages above ISA DMA boundary
 704  */
 705
 706 #if BITS_PER_LONG == 32
 707 #define BLK_BOUNCE_HIGH         ((u64)blk_max_low_pfn << PAGE_SHIFT)
 708 #else
 709 #define BLK_BOUNCE_HIGH         -1ULL
 710 #endif
 711 #define BLK_BOUNCE_ANY          (-1ULL)
 712 #define BLK_BOUNCE_ISA          (DMA_BIT_MASK(24))
 713
 714 /*
 715  * default timeout for SG_IO if none specified
 716  */
 717 #define BLK_DEFAULT_SG_TIMEOUT  (60 * HZ)
 718 #define BLK_MIN_SG_TIMEOUT      (7 * HZ)
 719
 720 #ifdef CONFIG_BOUNCE
 721 extern int init_emergency_isa_pool(void);
 722 extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
 723 #else
 724 static inline int init_emergency_isa_pool(void)
 725 {
 726         return 0;
 727 }
 728 static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
 729 {
 730 }
 731 #endif /* CONFIG_MMU */
 732
 733 struct rq_map_data {
 734         struct page **pages;
 735         int page_order;
 736         int nr_entries;
 737         unsigned long offset;
 738         int null_mapped;
 739         int from_user;
 740 };
 741
 742 struct req_iterator {
 743         struct bvec_iter iter;
 744         struct bio *bio;
 745 };
 746
 747 /* This should not be used directly - use rq_for_each_segment */
 748 #define for_each_bio(_bio)              \
 749         for (; _bio; _bio = _bio->bi_next)
 750 #define __rq_for_each_bio(_bio, rq)     \
 751         if ((rq->bio))                  \
 752                 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
 753
 754 #define rq_for_each_segment(bvl, _rq, _iter)                    \
 755         __rq_for_each_bio(_iter.bio, _rq)                       \
 756                 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
 757
 758 #define rq_iter_last(bvec, _iter)                               \
 759                 (_iter.bio->bi_next == NULL &&                  \
 760                  bio_iter_last(bvec, _iter.iter))
 761
 762 #ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 763 # error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
 764 #endif
 765 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
 766 extern void rq_flush_dcache_pages(struct request *rq);
 767 #else
 768 static inline void rq_flush_dcache_pages(struct request *rq)
 769 {
 770 }
 771 #endif
 772
 773 #ifdef CONFIG_PRINTK
 774 #define vfs_msg(sb, level, fmt, ...)                            \
 775         __vfs_msg(sb, level, fmt, ##__VA_ARGS__)
 776 #else
 777 #define vfs_msg(sb, level, fmt, ...)                            \
 778 do {                                                            \
 779         no_printk(fmt, ##__VA_ARGS__);                          \
 780         __vfs_msg(sb, "", " ");                                 \
 781 } while (0)
 782 #endif
 783
 784 extern int blk_register_queue(struct gendisk *disk);
 785 extern void blk_unregister_queue(struct gendisk *disk);
 786 extern blk_qc_t generic_make_request(struct bio *bio);
 787 extern void blk_rq_init(struct request_queue *q, struct request *rq);
 788 extern void blk_put_request(struct request *);
 789 extern void __blk_put_request(struct request_queue *, struct request *);
 790 extern struct request *blk_get_request(struct request_queue *, int, gfp_t);
 791 extern struct request *blk_make_request(struct request_queue *, struct bio *,
 792                                         gfp_t);
 793 extern void blk_rq_set_block_pc(struct request *);
 794 extern void blk_requeue_request(struct request_queue *, struct request *);
 795 extern void blk_add_request_payload(struct request *rq, struct page *page,
 796                 int offset, unsigned int len);
 797 extern int blk_lld_busy(struct request_queue *q);
 798 extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
 799                              struct bio_set *bs, gfp_t gfp_mask,
 800                              int (*bio_ctr)(struct bio *, struct bio *, void *),
 801                              void *data);
 802 extern void blk_rq_unprep_clone(struct request *rq);
 803 extern int blk_insert_cloned_request(struct request_queue *q,
 804                                      struct request *rq);
 805 extern void blk_delay_queue(struct request_queue *, unsigned long);
 806 extern void blk_queue_split(struct request_queue *, struct bio **,
 807                             struct bio_set *);
 808 extern void blk_recount_segments(struct request_queue *, struct bio *);
 809 extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
 810 extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
 811                               unsigned int, void __user *);
 812 extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
 813                           unsigned int, void __user *);
 814 extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
 815                          struct scsi_ioctl_command __user *);
 816
 817 extern int blk_queue_enter(struct request_queue *q, bool nowait);
 818 extern void blk_queue_exit(struct request_queue *q);
 819 extern void blk_start_queue(struct request_queue *q);
 820 extern void blk_start_queue_async(struct request_queue *q);
 821 extern void blk_stop_queue(struct request_queue *q);
 822 extern void blk_sync_queue(struct request_queue *q);
 823 extern void __blk_stop_queue(struct request_queue *q);
 824 extern void __blk_run_queue(struct request_queue *q);
 825 extern void __blk_run_queue_uncond(struct request_queue *q);
 826 extern void blk_run_queue(struct request_queue *);
 827 extern void blk_run_queue_async(struct request_queue *q);
 828 extern int blk_rq_map_user(struct request_queue *, struct request *,
 829                            struct rq_map_data *, void __user *, unsigned long,
 830                            gfp_t);
 831 extern int blk_rq_unmap_user(struct bio *);
 832 extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
 833 extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
 834                                struct rq_map_data *, const struct iov_iter *,
 835                                gfp_t);
 836 extern int blk_execute_rq(struct request_queue *, struct gendisk *,
 837                           struct request *, int);
 838 extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
 839                                   struct request *, int, rq_end_io_fn *);
 840
 841 bool blk_poll(struct request_queue *q, blk_qc_t cookie);
 842
 843 static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
 844 {
 845         return bdev->bd_disk->queue;    /* this is never NULL */
 846 }
 847
 848 /*
 849  * blk_rq_pos()                 : the current sector
 850  * blk_rq_bytes()               : bytes left in the entire request
 851  * blk_rq_cur_bytes()           : bytes left in the current segment
 852  * blk_rq_err_bytes()           : bytes left till the next error boundary
 853  * blk_rq_sectors()             : sectors left in the entire request
 854  * blk_rq_cur_sectors()         : sectors left in the current segment
 855  */
 856 static inline sector_t blk_rq_pos(const struct request *rq)
 857 {
 858         return rq->__sector;
 859 }
 860
 861 static inline unsigned int blk_rq_bytes(const struct request *rq)
 862 {
 863         return rq->__data_len;
 864 }
 865
 866 static inline int blk_rq_cur_bytes(const struct request *rq)
 867 {
 868         return rq->bio ? bio_cur_bytes(rq->bio) : 0;
 869 }
 870
 871 extern unsigned int blk_rq_err_bytes(const struct request *rq);
 872
 873 static inline unsigned int blk_rq_sectors(const struct request *rq)
 874 {
 875         return blk_rq_bytes(rq) >> 9;
 876 }
 877
 878 static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
 879 {
 880         return blk_rq_cur_bytes(rq) >> 9;
 881 }
 882
 883 static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
 884                                                      int op)
 885 {
 886         if (unlikely(op == REQ_OP_DISCARD))
 887                 return min(q->limits.max_discard_sectors, UINT_MAX >> 9);
 888
 889         if (unlikely(op == REQ_OP_WRITE_SAME))
 890                 return q->limits.max_write_same_sectors;
 891
 892         return q->limits.max_sectors;
 893 }
 894
 895 /*
 896  * Return maximum size of a request at given offset. Only valid for
 897  * file system requests.
 898  */
 899 static inline unsigned int blk_max_size_offset(struct request_queue *q,
 900                                                sector_t offset)
 901 {
 902         if (!q->limits.chunk_sectors)
 903                 return q->limits.max_sectors;
 904
 905         return q->limits.chunk_sectors -
 906                         (offset & (q->limits.chunk_sectors - 1));
 907 }
 908
 909 static inline unsigned int blk_rq_get_max_sectors(struct request *rq)
 910 {
 911         struct request_queue *q = rq->q;
 912
 913         if (unlikely(rq->cmd_type != REQ_TYPE_FS))
 914                 return q->limits.max_hw_sectors;
 915
 916         if (!q->limits.chunk_sectors || (req_op(rq) == REQ_OP_DISCARD))
 917                 return blk_queue_get_max_sectors(q, req_op(rq));
 918
 919         return min(blk_max_size_offset(q, blk_rq_pos(rq)),
 920                         blk_queue_get_max_sectors(q, req_op(rq)));
 921 }
 922
 923 static inline unsigned int blk_rq_count_bios(struct request *rq)
 924 {
 925         unsigned int nr_bios = 0;
 926         struct bio *bio;
 927
 928         __rq_for_each_bio(bio, rq)
 929                 nr_bios++;
 930
 931         return nr_bios;
 932 }
 933
 934 /*
 935  * Request issue related functions.
 936  */
 937 extern struct request *blk_peek_request(struct request_queue *q);
 938 extern void blk_start_request(struct request *rq);
 939 extern struct request *blk_fetch_request(struct request_queue *q);
 940
 941 /*
 942  * Request completion related functions.
 943  *
 944  * blk_update_request() completes given number of bytes and updates
 945  * the request without completing it.
 946  *
 947  * blk_end_request() and friends.  __blk_end_request() must be called
 948  * with the request queue spinlock acquired.
 949  *
 950  * Several drivers define their own end_request and call
 951  * blk_end_request() for parts of the original function.
 952  * This prevents code duplication in drivers.
 953  */
 954 extern bool blk_update_request(struct request *rq, int error,
 955                                unsigned int nr_bytes);
 956 extern void blk_finish_request(struct request *rq, int error);
 957 extern bool blk_end_request(struct request *rq, int error,
 958                             unsigned int nr_bytes);
 959 extern void blk_end_request_all(struct request *rq, int error);
 960 extern bool blk_end_request_cur(struct request *rq, int error);
 961 extern bool blk_end_request_err(struct request *rq, int error);
 962 extern bool __blk_end_request(struct request *rq, int error,
 963                               unsigned int nr_bytes);
 964 extern void __blk_end_request_all(struct request *rq, int error);
 965 extern bool __blk_end_request_cur(struct request *rq, int error);
 966 extern bool __blk_end_request_err(struct request *rq, int error);
 967
 968 extern void blk_complete_request(struct request *);
 969 extern void __blk_complete_request(struct request *);
 970 extern void blk_abort_request(struct request *);
 971 extern void blk_unprep_request(struct request *);
 972
 973 /*
 974  * Access functions for manipulating queue properties
 975  */
 976 extern struct request_queue *blk_init_queue_node(request_fn_proc *rfn,
 977                                         spinlock_t *lock, int node_id);
 978 extern struct request_queue *blk_init_queue(request_fn_proc *, spinlock_t *);
 979 extern struct request_queue *blk_init_allocated_queue(struct request_queue *,
 980                                                       request_fn_proc *, spinlock_t *);
 981 extern void blk_cleanup_queue(struct request_queue *);
 982 extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
 983 extern void blk_queue_bounce_limit(struct request_queue *, u64);
 984 extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
 985 extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
 986 extern void blk_queue_max_segments(struct request_queue *, unsigned short);
 987 extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
 988 extern void blk_queue_max_discard_sectors(struct request_queue *q,
 989                 unsigned int max_discard_sectors);
 990 extern void blk_queue_max_write_same_sectors(struct request_queue *q,
 991                 unsigned int max_write_same_sectors);
 992 extern void blk_queue_logical_block_size(struct request_queue *, unsigned short);
 993 extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
 994 extern void blk_queue_alignment_offset(struct request_queue *q,
 995                                        unsigned int alignment);
 996 extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
 997 extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
 998 extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
 999 extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
1000 extern void blk_set_default_limits(struct queue_limits *lim);
1001 extern void blk_set_stacking_limits(struct queue_limits *lim);
1002 extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1003                             sector_t offset);
1004 extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1005                             sector_t offset);
1006 extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1007                               sector_t offset);
1008 extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
1009 extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
1010 extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
1011 extern int blk_queue_dma_drain(struct request_queue *q,
1012                                dma_drain_needed_fn *dma_drain_needed,
1013                                void *buf, unsigned int size);
1014 extern void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn);
1015 extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
1016 extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
1017 extern void blk_queue_prep_rq(struct request_queue *, prep_rq_fn *pfn);
1018 extern void blk_queue_unprep_rq(struct request_queue *, unprep_rq_fn *ufn);
1019 extern void blk_queue_dma_alignment(struct request_queue *, int);
1020 extern void blk_queue_update_dma_alignment(struct request_queue *, int);
1021 extern void blk_queue_softirq_done(struct request_queue *, softirq_done_fn *);
1022 extern void blk_queue_rq_timed_out(struct request_queue *, rq_timed_out_fn *);
1023 extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
1024 extern void blk_queue_flush_queueable(struct request_queue *q, bool queueable);
1025 extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
1026 extern struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev);
1027
1028 extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
1029 extern void blk_dump_rq_flags(struct request *, char *);
1030 extern long nr_blockdev_pages(void);
1031
1032 bool __must_check blk_get_queue(struct request_queue *);
1033 struct request_queue *blk_alloc_queue(gfp_t);
1034 struct request_queue *blk_alloc_queue_node(gfp_t, int);
1035 extern void blk_put_queue(struct request_queue *);
1036 extern void blk_set_queue_dying(struct request_queue *);
1037
1038 /*
1039  * block layer runtime pm functions
1040  */
1041 #ifdef CONFIG_PM
1042 extern void blk_pm_runtime_init(struct request_queue *q, struct device *dev);
1043 extern int blk_pre_runtime_suspend(struct request_queue *q);
1044 extern void blk_post_runtime_suspend(struct request_queue *q, int err);
1045 extern void blk_pre_runtime_resume(struct request_queue *q);
1046 extern void blk_post_runtime_resume(struct request_queue *q, int err);
1047 extern void blk_set_runtime_active(struct request_queue *q);
1048 #else
1049 static inline void blk_pm_runtime_init(struct request_queue *q,
1050         struct device *dev) {}
1051 static inline int blk_pre_runtime_suspend(struct request_queue *q)
1052 {
1053         return -ENOSYS;
1054 }
1055 static inline void blk_post_runtime_suspend(struct request_queue *q, int err) {}
1056 static inline void blk_pre_runtime_resume(struct request_queue *q) {}
1057 static inline void blk_post_runtime_resume(struct request_queue *q, int err) {}
1058 extern inline void blk_set_runtime_active(struct request_queue *q) {}
1059 #endif
1060
1061 /*
1062  * blk_plug permits building a queue of related requests by holding the I/O
1063  * fragments for a short period. This allows merging of sequential requests
1064  * into single larger request. As the requests are moved from a per-task list to
1065  * the device's request_queue in a batch, this results in improved scalability
1066  * as the lock contention for request_queue lock is reduced.
1067  *
1068  * It is ok not to disable preemption when adding the request to the plug list
1069  * or when attempting a merge, because blk_schedule_flush_list() will only flush
1070  * the plug list when the task sleeps by itself. For details, please see
1071  * schedule() where blk_schedule_flush_plug() is called.
1072  */
1073 struct blk_plug {
1074         struct list_head list; /* requests */
1075         struct list_head mq_list; /* blk-mq requests */
1076         struct list_head cb_list; /* md requires an unplug callback */
1077 };
1078 #define BLK_MAX_REQUEST_COUNT 16
1079
1080 struct blk_plug_cb;
1081 typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
1082 struct blk_plug_cb {
1083         struct list_head list;
1084         blk_plug_cb_fn callback;
1085         void *data;
1086 };
1087 extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1088                                              void *data, int size);
1089 extern void blk_start_plug(struct blk_plug *);
1090 extern void blk_finish_plug(struct blk_plug *);
1091 extern void blk_flush_plug_list(struct blk_plug *, bool);
1092
1093 static inline void blk_flush_plug(struct task_struct *tsk)
1094 {
1095         struct blk_plug *plug = tsk->plug;
1096
1097         if (plug)
1098                 blk_flush_plug_list(plug, false);
1099 }
1100
1101 static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1102 {
1103         struct blk_plug *plug = tsk->plug;
1104
1105         if (plug)
1106                 blk_flush_plug_list(plug, true);
1107 }
1108
1109 static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1110 {
1111         struct blk_plug *plug = tsk->plug;
1112
1113         return plug &&
1114                 (!list_empty(&plug->list) ||
1115                  !list_empty(&plug->mq_list) ||
1116                  !list_empty(&plug->cb_list));
1117 }
1118
1119 /*
1120  * tag stuff
1121  */
1122 extern int blk_queue_start_tag(struct request_queue *, struct request *);
1123 extern struct request *blk_queue_find_tag(struct request_queue *, int);
1124 extern void blk_queue_end_tag(struct request_queue *, struct request *);
1125 extern int blk_queue_init_tags(struct request_queue *, int, struct blk_queue_tag *, int);
1126 extern void blk_queue_free_tags(struct request_queue *);
1127 extern int blk_queue_resize_tags(struct request_queue *, int);
1128 extern void blk_queue_invalidate_tags(struct request_queue *);
1129 extern struct blk_queue_tag *blk_init_tags(int, int);
1130 extern void blk_free_tags(struct blk_queue_tag *);
1131
1132 static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
1133                                                 int tag)
1134 {
1135         if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
1136                 return NULL;
1137         return bqt->tag_index[tag];
1138 }
1139
1140
1141 #define BLKDEV_DISCARD_SECURE   (1 << 0)        /* issue a secure erase */
1142 #define BLKDEV_DISCARD_ZERO     (1 << 1)        /* must reliably zero data */
1143
1144 extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
1145 extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1146                 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
1147 extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1148                 sector_t nr_sects, gfp_t gfp_mask, int flags,
1149                 struct bio **biop);
1150 extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1151                 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
1152 extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1153                 sector_t nr_sects, gfp_t gfp_mask, bool discard);
1154 static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1155                 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
1156 {
1157         return blkdev_issue_discard(sb->s_bdev, block << (sb->s_blocksize_bits - 9),
1158                                     nr_blocks << (sb->s_blocksize_bits - 9),
1159                                     gfp_mask, flags);
1160 }
1161 static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
1162                 sector_t nr_blocks, gfp_t gfp_mask)
1163 {
1164         return blkdev_issue_zeroout(sb->s_bdev,
1165                                     block << (sb->s_blocksize_bits - 9),
1166                                     nr_blocks << (sb->s_blocksize_bits - 9),
1167                                     gfp_mask, true);
1168 }
1169
1170 extern int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm);
1171
1172 enum blk_default_limits {
1173         BLK_MAX_SEGMENTS        = 128,
1174         BLK_SAFE_MAX_SECTORS    = 255,
1175         BLK_DEF_MAX_SECTORS     = 2560,
1176         BLK_MAX_SEGMENT_SIZE    = 65536,
1177         BLK_SEG_BOUNDARY_MASK   = 0xFFFFFFFFUL,
1178 };
1179
1180 #define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
1181
1182 static inline unsigned long queue_bounce_pfn(struct request_queue *q)
1183 {
1184         return q->limits.bounce_pfn;
1185 }
1186
1187 static inline unsigned long queue_segment_boundary(struct request_queue *q)
1188 {
1189         return q->limits.seg_boundary_mask;
1190 }
1191
1192 static inline unsigned long queue_virt_boundary(struct request_queue *q)
1193 {
1194         return q->limits.virt_boundary_mask;
1195 }
1196
1197 static inline unsigned int queue_max_sectors(struct request_queue *q)
1198 {
1199         return q->limits.max_sectors;
1200 }
1201
1202 static inline unsigned int queue_max_hw_sectors(struct request_queue *q)
1203 {
1204         return q->limits.max_hw_sectors;
1205 }
1206
1207 static inline unsigned short queue_max_segments(struct request_queue *q)
1208 {
1209         return q->limits.max_segments;
1210 }
1211
1212 static inline unsigned int queue_max_segment_size(struct request_queue *q)
1213 {
1214         return q->limits.max_segment_size;
1215 }
1216
1217 static inline unsigned short queue_logical_block_size(struct request_queue *q)
1218 {
1219         int retval = 512;
1220
1221         if (q && q->limits.logical_block_size)
1222                 retval = q->limits.logical_block_size;
1223
1224         return retval;
1225 }
1226
1227 static inline unsigned short bdev_logical_block_size(struct block_device *bdev)
1228 {
1229         return queue_logical_block_size(bdev_get_queue(bdev));
1230 }
1231
1232 static inline unsigned int queue_physical_block_size(struct request_queue *q)
1233 {
1234         return q->limits.physical_block_size;
1235 }
1236
1237 static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
1238 {
1239         return queue_physical_block_size(bdev_get_queue(bdev));
1240 }
1241
1242 static inline unsigned int queue_io_min(struct request_queue *q)
1243 {
1244         return q->limits.io_min;
1245 }
1246
1247 static inline int bdev_io_min(struct block_device *bdev)
1248 {
1249         return queue_io_min(bdev_get_queue(bdev));
1250 }
1251
1252 static inline unsigned int queue_io_opt(struct request_queue *q)
1253 {
1254         return q->limits.io_opt;
1255 }
1256
1257 static inline int bdev_io_opt(struct block_device *bdev)
1258 {
1259         return queue_io_opt(bdev_get_queue(bdev));
1260 }
1261
1262 static inline int queue_alignment_offset(struct request_queue *q)
1263 {
1264         if (q->limits.misaligned)
1265                 return -1;
1266
1267         return q->limits.alignment_offset;
1268 }
1269
1270 static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
1271 {
1272         unsigned int granularity = max(lim->physical_block_size, lim->io_min);
1273         unsigned int alignment = sector_div(sector, granularity >> 9) << 9;
1274
1275         return (granularity + lim->alignment_offset - alignment) % granularity;
1276 }
1277
1278 static inline int bdev_alignment_offset(struct block_device *bdev)
1279 {
1280         struct request_queue *q = bdev_get_queue(bdev);
1281
1282         if (q->limits.misaligned)
1283                 return -1;
1284
1285         if (bdev != bdev->bd_contains)
1286                 return bdev->bd_part->alignment_offset;
1287
1288         return q->limits.alignment_offset;
1289 }
1290
1291 static inline int queue_discard_alignment(struct request_queue *q)
1292 {
1293         if (q->limits.discard_misaligned)
1294                 return -1;
1295
1296         return q->limits.discard_alignment;
1297 }
1298
1299 static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
1300 {
1301         unsigned int alignment, granularity, offset;
1302
1303         if (!lim->max_discard_sectors)
1304                 return 0;
1305
1306         /* Why are these in bytes, not sectors? */
1307         alignment = lim->discard_alignment >> 9;
1308         granularity = lim->discard_granularity >> 9;
1309         if (!granularity)
1310                 return 0;
1311
1312         /* Offset of the partition start in 'granularity' sectors */
1313         offset = sector_div(sector, granularity);
1314
1315         /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1316         offset = (granularity + alignment - offset) % granularity;
1317
1318         /* Turn it back into bytes, gaah */
1319         return offset << 9;
1320 }
1321
1322 static inline int bdev_discard_alignment(struct block_device *bdev)
1323 {
1324         struct request_queue *q = bdev_get_queue(bdev);
1325
1326         if (bdev != bdev->bd_contains)
1327                 return bdev->bd_part->discard_alignment;
1328
1329         return q->limits.discard_alignment;
1330 }
1331
1332 static inline unsigned int queue_discard_zeroes_data(struct request_queue *q)
1333 {
1334         if (q->limits.max_discard_sectors && q->limits.discard_zeroes_data == 1)
1335                 return 1;
1336
1337         return 0;
1338 }
1339
1340 static inline unsigned int bdev_discard_zeroes_data(struct block_device *bdev)
1341 {
1342         return queue_discard_zeroes_data(bdev_get_queue(bdev));
1343 }
1344
1345 static inline unsigned int bdev_write_same(struct block_device *bdev)
1346 {
1347         struct request_queue *q = bdev_get_queue(bdev);
1348
1349         if (q)
1350                 return q->limits.max_write_same_sectors;
1351
1352         return 0;
1353 }
1354
1355 static inline int queue_dma_alignment(struct request_queue *q)
1356 {
1357         return q ? q->dma_alignment : 511;
1358 }
1359
1360 static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
1361                                  unsigned int len)
1362 {
1363         unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
1364         return !(addr & alignment) && !(len & alignment);
1365 }
1366
1367 /* assumes size > 256 */
1368 static inline unsigned int blksize_bits(unsigned int size)
1369 {
1370         unsigned int bits = 8;
1371         do {
1372                 bits++;
1373                 size >>= 1;
1374         } while (size > 256);
1375         return bits;
1376 }
1377
1378 static inline unsigned int block_size(struct block_device *bdev)
1379 {
1380         return bdev->bd_block_size;
1381 }
1382
1383 static inline bool queue_flush_queueable(struct request_queue *q)
1384 {
1385         return !test_bit(QUEUE_FLAG_FLUSH_NQ, &q->queue_flags);
1386 }
1387
1388 typedef struct {struct page *v;} Sector;
1389
1390 unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
1391
1392 static inline void put_dev_sector(Sector p)
1393 {
1394         put_page(p.v);
1395 }
1396
1397 static inline bool __bvec_gap_to_prev(struct request_queue *q,
1398                                 struct bio_vec *bprv, unsigned int offset)
1399 {
1400         return offset ||
1401                 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
1402 }
1403
1404 /*
1405  * Check if adding a bio_vec after bprv with offset would create a gap in
1406  * the SG list. Most drivers don't care about this, but some do.
1407  */
1408 static inline bool bvec_gap_to_prev(struct request_queue *q,
1409                                 struct bio_vec *bprv, unsigned int offset)
1410 {
1411         if (!queue_virt_boundary(q))
1412                 return false;
1413         return __bvec_gap_to_prev(q, bprv, offset);
1414 }
1415
1416 static inline bool bio_will_gap(struct request_queue *q, struct bio *prev,
1417                          struct bio *next)
1418 {
1419         if (bio_has_data(prev) && queue_virt_boundary(q)) {
1420                 struct bio_vec pb, nb;
1421
1422                 bio_get_last_bvec(prev, &pb);
1423                 bio_get_first_bvec(next, &nb);
1424
1425                 return __bvec_gap_to_prev(q, &pb, nb.bv_offset);
1426         }
1427
1428         return false;
1429 }
1430
1431 static inline bool req_gap_back_merge(struct request *req, struct bio *bio)
1432 {
1433         return bio_will_gap(req->q, req->biotail, bio);
1434 }
1435
1436 static inline bool req_gap_front_merge(struct request *req, struct bio *bio)
1437 {
1438         return bio_will_gap(req->q, bio, req->bio);
1439 }
1440
1441 struct work_struct;
1442 int kblockd_schedule_work(struct work_struct *work);
1443 int kblockd_schedule_delayed_work(struct delayed_work *dwork, unsigned long delay);
1444 int kblockd_schedule_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1445
1446 #ifdef CONFIG_BLK_CGROUP
1447 /*
1448  * This should not be using sched_clock(). A real patch is in progress
1449  * to fix this up, until that is in place we need to disable preemption
1450  * around sched_clock() in this function and set_io_start_time_ns().
1451  */
1452 static inline void set_start_time_ns(struct request *req)
1453 {
1454         preempt_disable();
1455         req->start_time_ns = sched_clock();
1456         preempt_enable();
1457 }
1458
1459 static inline void set_io_start_time_ns(struct request *req)
1460 {
1461         preempt_disable();
1462         req->io_start_time_ns = sched_clock();
1463         preempt_enable();
1464 }
1465
1466 static inline uint64_t rq_start_time_ns(struct request *req)
1467 {
1468         return req->start_time_ns;
1469 }
1470
1471 static inline uint64_t rq_io_start_time_ns(struct request *req)
1472 {
1473         return req->io_start_time_ns;
1474 }
1475 #else
1476 static inline void set_start_time_ns(struct request *req) {}
1477 static inline void set_io_start_time_ns(struct request *req) {}
1478 static inline uint64_t rq_start_time_ns(struct request *req)
1479 {
1480         return 0;
1481 }
1482 static inline uint64_t rq_io_start_time_ns(struct request *req)
1483 {
1484         return 0;
1485 }
1486 #endif
1487
1488 #define MODULE_ALIAS_BLOCKDEV(major,minor) \
1489         MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1490 #define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1491         MODULE_ALIAS("block-major-" __stringify(major) "-*")
1492
1493 #if defined(CONFIG_BLK_DEV_INTEGRITY)
1494
1495 enum blk_integrity_flags {
1496         BLK_INTEGRITY_VERIFY            = 1 << 0,
1497         BLK_INTEGRITY_GENERATE          = 1 << 1,
1498         BLK_INTEGRITY_DEVICE_CAPABLE    = 1 << 2,
1499         BLK_INTEGRITY_IP_CHECKSUM       = 1 << 3,
1500 };
1501
1502 struct blk_integrity_iter {
1503         void                    *prot_buf;
1504         void                    *data_buf;
1505         sector_t                seed;
1506         unsigned int            data_size;
1507         unsigned short          interval;
1508         const char              *disk_name;
1509 };
1510
1511 typedef int (integrity_processing_fn) (struct blk_integrity_iter *);
1512
1513 struct blk_integrity_profile {
1514         integrity_processing_fn         *generate_fn;
1515         integrity_processing_fn         *verify_fn;
1516         const char                      *name;
1517 };
1518
1519 extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
1520 extern void blk_integrity_unregister(struct gendisk *);
1521 extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
1522 extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1523                                    struct scatterlist *);
1524 extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
1525 extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1526                                    struct request *);
1527 extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1528                                     struct bio *);
1529
1530 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1531 {
1532         struct blk_integrity *bi = &disk->queue->integrity;
1533
1534         if (!bi->profile)
1535                 return NULL;
1536
1537         return bi;
1538 }
1539
1540 static inline
1541 struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
1542 {
1543         return blk_get_integrity(bdev->bd_disk);
1544 }
1545
1546 static inline bool blk_integrity_rq(struct request *rq)
1547 {
1548         return rq->cmd_flags & REQ_INTEGRITY;
1549 }
1550
1551 static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1552                                                     unsigned int segs)
1553 {
1554         q->limits.max_integrity_segments = segs;
1555 }
1556
1557 static inline unsigned short
1558 queue_max_integrity_segments(struct request_queue *q)
1559 {
1560         return q->limits.max_integrity_segments;
1561 }
1562
1563 static inline bool integrity_req_gap_back_merge(struct request *req,
1564                                                 struct bio *next)
1565 {
1566         struct bio_integrity_payload *bip = bio_integrity(req->bio);
1567         struct bio_integrity_payload *bip_next = bio_integrity(next);
1568
1569         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1570                                 bip_next->bip_vec[0].bv_offset);
1571 }
1572
1573 static inline bool integrity_req_gap_front_merge(struct request *req,
1574                                                  struct bio *bio)
1575 {
1576         struct bio_integrity_payload *bip = bio_integrity(bio);
1577         struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
1578
1579         return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1580                                 bip_next->bip_vec[0].bv_offset);
1581 }
1582
1583 #else /* CONFIG_BLK_DEV_INTEGRITY */
1584
1585 struct bio;
1586 struct block_device;
1587 struct gendisk;
1588 struct blk_integrity;
1589
1590 static inline int blk_integrity_rq(struct request *rq)
1591 {
1592         return 0;
1593 }
1594 static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1595                                             struct bio *b)
1596 {
1597         return 0;
1598 }
1599 static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1600                                           struct bio *b,
1601                                           struct scatterlist *s)
1602 {
1603         return 0;
1604 }
1605 static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1606 {
1607         return NULL;
1608 }
1609 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1610 {
1611         return NULL;
1612 }
1613 static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1614 {
1615         return 0;
1616 }
1617 static inline void blk_integrity_register(struct gendisk *d,
1618                                          struct blk_integrity *b)
1619 {
1620 }
1621 static inline void blk_integrity_unregister(struct gendisk *d)
1622 {
1623 }
1624 static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1625                                                     unsigned int segs)
1626 {
1627 }
1628 static inline unsigned short queue_max_integrity_segments(struct request_queue *q)
1629 {
1630         return 0;
1631 }
1632 static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1633                                           struct request *r1,
1634                                           struct request *r2)
1635 {
1636         return true;
1637 }
1638 static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1639                                            struct request *r,
1640                                            struct bio *b)
1641 {
1642         return true;
1643 }
1644
1645 static inline bool integrity_req_gap_back_merge(struct request *req,
1646                                                 struct bio *next)
1647 {
1648         return false;
1649 }
1650 static inline bool integrity_req_gap_front_merge(struct request *req,
1651                                                  struct bio *bio)
1652 {
1653         return false;
1654 }
1655
1656 #endif /* CONFIG_BLK_DEV_INTEGRITY */
1657
1658 /**
1659  * struct blk_dax_ctl - control and output parameters for ->direct_access
1660  * @sector: (input) offset relative to a block_device
1661  * @addr: (output) kernel virtual address for @sector populated by driver
1662  * @pfn: (output) page frame number for @addr populated by driver
1663  * @size: (input) number of bytes requested
1664  */
1665 struct blk_dax_ctl {
1666         sector_t sector;
1667         void __pmem *addr;
1668         long size;
1669         pfn_t pfn;
1670 };
1671
1672 struct block_device_operations {
1673         int (*open) (struct block_device *, fmode_t);
1674         void (*release) (struct gendisk *, fmode_t);
1675         int (*rw_page)(struct block_device *, sector_t, struct page *, int rw);
1676         int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1677         int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1678         long (*direct_access)(struct block_device *, sector_t, void __pmem **,
1679                         pfn_t *, 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         struct module *owner;
1690         const struct pr_ops *pr_ops;
1691 };
1692
1693 extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1694                                  unsigned long);
1695 extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1696 extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1697                                                 struct writeback_control *);
1698 extern long bdev_direct_access(struct block_device *, struct blk_dax_ctl *);
1699 extern int bdev_dax_supported(struct super_block *, int);
1700 extern bool bdev_dax_capable(struct block_device *);
1701 #else /* CONFIG_BLOCK */
1702
1703 struct block_device;
1704
1705 /*
1706  * stubs for when the block layer is configured out
1707  */
1708 #define buffer_heads_over_limit 0
1709
1710 static inline long nr_blockdev_pages(void)
1711 {
1712         return 0;
1713 }
1714
1715 struct blk_plug {
1716 };
1717
1718 static inline void blk_start_plug(struct blk_plug *plug)
1719 {
1720 }
1721
1722 static inline void blk_finish_plug(struct blk_plug *plug)
1723 {
1724 }
1725
1726 static inline void blk_flush_plug(struct task_struct *task)
1727 {
1728 }
1729
1730 static inline void blk_schedule_flush_plug(struct task_struct *task)
1731 {
1732 }
1733
1734
1735 static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1736 {
1737         return false;
1738 }
1739
1740 static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
1741                                      sector_t *error_sector)
1742 {
1743         return 0;
1744 }
1745
1746 #endif /* CONFIG_BLOCK */
1747
1748 #endif