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