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