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