]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/blkdev.h
block: Dynamically allocate and refcount backing_dev_info
[mirror_ubuntu-bionic-kernel.git] / include / linux / blkdev.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_BLKDEV_H
2#define _LINUX_BLKDEV_H
3
85fd0bc9
RK
4#include <linux/sched.h>
5
f5ff8422
JA
6#ifdef CONFIG_BLOCK
7
1da177e4
LT
8#include <linux/major.h>
9#include <linux/genhd.h>
10#include <linux/list.h>
320ae51f 11#include <linux/llist.h>
1da177e4
LT
12#include <linux/timer.h>
13#include <linux/workqueue.h>
14#include <linux/pagemap.h>
66114cad 15#include <linux/backing-dev-defs.h>
1da177e4
LT
16#include <linux/wait.h>
17#include <linux/mempool.h>
34c0fd54 18#include <linux/pfn.h>
1da177e4 19#include <linux/bio.h>
1da177e4 20#include <linux/stringify.h>
3e6053d7 21#include <linux/gfp.h>
d351af01 22#include <linux/bsg.h>
c7c22e4d 23#include <linux/smp.h>
548bc8e1 24#include <linux/rcupdate.h>
add703fd 25#include <linux/percpu-refcount.h>
84be456f 26#include <linux/scatterlist.h>
6a0cb1bc 27#include <linux/blkzoned.h>
1da177e4 28
de477254 29struct module;
21b2f0c8
CH
30struct scsi_ioctl_command;
31
1da177e4 32struct request_queue;
1da177e4 33struct elevator_queue;
2056a782 34struct blk_trace;
3d6392cf
JA
35struct request;
36struct sg_io_hdr;
aa387cc8 37struct bsg_job;
3c798398 38struct blkcg_gq;
7c94e1c1 39struct blk_flush_queue;
bbd3e064 40struct pr_ops;
87760e5e 41struct rq_wb;
1da177e4
LT
42
43#define BLKDEV_MIN_RQ 4
44#define BLKDEV_MAX_RQ 128 /* Default maximum */
45
8bd435b3
TH
46/*
47 * Maximum number of blkcg policies allowed to be registered concurrently.
48 * Defined here to simplify include dependency.
49 */
50#define BLKCG_MAX_POLS 2
51
8ffdc655 52typedef void (rq_end_io_fn)(struct request *, int);
1da177e4 53
5b788ce3
TH
54#define BLK_RL_SYNCFULL (1U << 0)
55#define BLK_RL_ASYNCFULL (1U << 1)
56
1da177e4 57struct request_list {
5b788ce3 58 struct request_queue *q; /* the queue this rl belongs to */
a051661c
TH
59#ifdef CONFIG_BLK_CGROUP
60 struct blkcg_gq *blkg; /* blkg this request pool belongs to */
61#endif
1faa16d2
JA
62 /*
63 * count[], starved[], and wait[] are indexed by
64 * BLK_RW_SYNC/BLK_RW_ASYNC
65 */
8a5ecdd4
TH
66 int count[2];
67 int starved[2];
68 mempool_t *rq_pool;
69 wait_queue_head_t wait[2];
5b788ce3 70 unsigned int flags;
1da177e4
LT
71};
72
e8064021
CH
73/*
74 * request flags */
75typedef __u32 __bitwise req_flags_t;
76
77/* elevator knows about this request */
78#define RQF_SORTED ((__force req_flags_t)(1 << 0))
79/* drive already may have started this one */
80#define RQF_STARTED ((__force req_flags_t)(1 << 1))
81/* uses tagged queueing */
82#define RQF_QUEUED ((__force req_flags_t)(1 << 2))
83/* may not be passed by ioscheduler */
84#define RQF_SOFTBARRIER ((__force req_flags_t)(1 << 3))
85/* request for flush sequence */
86#define RQF_FLUSH_SEQ ((__force req_flags_t)(1 << 4))
87/* merge of different types, fail separately */
88#define RQF_MIXED_MERGE ((__force req_flags_t)(1 << 5))
89/* track inflight for MQ */
90#define RQF_MQ_INFLIGHT ((__force req_flags_t)(1 << 6))
91/* don't call prep for this one */
92#define RQF_DONTPREP ((__force req_flags_t)(1 << 7))
93/* set for "ide_preempt" requests and also for requests for which the SCSI
94 "quiesce" state must be ignored. */
95#define RQF_PREEMPT ((__force req_flags_t)(1 << 8))
96/* contains copies of user pages */
97#define RQF_COPY_USER ((__force req_flags_t)(1 << 9))
98/* vaguely specified driver internal error. Ignored by the block layer */
99#define RQF_FAILED ((__force req_flags_t)(1 << 10))
100/* don't warn about errors */
101#define RQF_QUIET ((__force req_flags_t)(1 << 11))
102/* elevator private data attached */
103#define RQF_ELVPRIV ((__force req_flags_t)(1 << 12))
104/* account I/O stat */
105#define RQF_IO_STAT ((__force req_flags_t)(1 << 13))
106/* request came from our alloc pool */
107#define RQF_ALLOCED ((__force req_flags_t)(1 << 14))
108/* runtime pm request */
109#define RQF_PM ((__force req_flags_t)(1 << 15))
110/* on IO scheduler merge hash */
111#define RQF_HASHED ((__force req_flags_t)(1 << 16))
cf43e6be
JA
112/* IO stats tracking on */
113#define RQF_STATS ((__force req_flags_t)(1 << 17))
f9d03f96
CH
114/* Look at ->special_vec for the actual data payload instead of the
115 bio chain. */
116#define RQF_SPECIAL_PAYLOAD ((__force req_flags_t)(1 << 18))
e8064021
CH
117
118/* flags that prevent us from merging requests: */
119#define RQF_NOMERGE_FLAGS \
f9d03f96 120 (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
e8064021 121
1da177e4 122/*
af76e555
CH
123 * Try to put the fields that are referenced together in the same cacheline.
124 *
125 * If you modify this structure, make sure to update blk_rq_init() and
126 * especially blk_mq_rq_ctx_init() to take care of the added fields.
1da177e4
LT
127 */
128struct request {
6897fc22 129 struct list_head queuelist;
320ae51f
JA
130 union {
131 struct call_single_data csd;
9828c2c6 132 u64 fifo_time;
320ae51f 133 };
ff856bad 134
165125e1 135 struct request_queue *q;
320ae51f 136 struct blk_mq_ctx *mq_ctx;
e6a1c874 137
ca93e453 138 int cpu;
ef295ecf 139 unsigned int cmd_flags; /* op and common flags */
e8064021 140 req_flags_t rq_flags;
d486f1f2
JA
141
142 int internal_tag;
143
242f9dcb 144 unsigned long atomic_flags;
1da177e4 145
a2dec7b3 146 /* the following two fields are internal, NEVER access directly */
a2dec7b3 147 unsigned int __data_len; /* total data len */
bd166ef1 148 int tag;
181fdde3 149 sector_t __sector; /* sector cursor */
1da177e4
LT
150
151 struct bio *bio;
152 struct bio *biotail;
153
360f92c2
JA
154 /*
155 * The hash is used inside the scheduler, and killed once the
156 * request reaches the dispatch list. The ipi_list is only used
157 * to queue the request for softirq completion, which is long
158 * after the request has been unhashed (and even removed from
159 * the dispatch list).
160 */
161 union {
162 struct hlist_node hash; /* merge hash */
163 struct list_head ipi_list;
164 };
165
e6a1c874
JA
166 /*
167 * The rb_node is only used inside the io scheduler, requests
168 * are pruned when moved to the dispatch queue. So let the
c186794d 169 * completion_data share space with the rb_node.
e6a1c874
JA
170 */
171 union {
172 struct rb_node rb_node; /* sort/lookup */
f9d03f96 173 struct bio_vec special_vec;
c186794d 174 void *completion_data;
e6a1c874 175 };
9817064b 176
ff7d145f 177 /*
7f1dc8a2 178 * Three pointers are available for the IO schedulers, if they need
c186794d
MS
179 * more they have to dynamically allocate it. Flush requests are
180 * never put on the IO scheduler. So let the flush fields share
a612fddf 181 * space with the elevator data.
ff7d145f 182 */
c186794d 183 union {
a612fddf
TH
184 struct {
185 struct io_cq *icq;
186 void *priv[2];
187 } elv;
188
c186794d
MS
189 struct {
190 unsigned int seq;
191 struct list_head list;
4853abaa 192 rq_end_io_fn *saved_end_io;
c186794d
MS
193 } flush;
194 };
ff7d145f 195
8f34ee75 196 struct gendisk *rq_disk;
09e099d4 197 struct hd_struct *part;
1da177e4 198 unsigned long start_time;
cf43e6be 199 struct blk_issue_stat issue_stat;
9195291e 200#ifdef CONFIG_BLK_CGROUP
a051661c 201 struct request_list *rl; /* rl this rq is alloced from */
9195291e
DS
202 unsigned long long start_time_ns;
203 unsigned long long io_start_time_ns; /* when passed to hardware */
204#endif
1da177e4
LT
205 /* Number of scatter-gather DMA addr+len pairs after
206 * physical address coalescing is performed.
207 */
208 unsigned short nr_phys_segments;
13f05c8d
MP
209#if defined(CONFIG_BLK_DEV_INTEGRITY)
210 unsigned short nr_integrity_segments;
211#endif
1da177e4 212
8f34ee75
JA
213 unsigned short ioprio;
214
731ec497 215 void *special; /* opaque pointer available for LLD use */
1da177e4 216
cdd60262
JA
217 int errors;
218
7a85f889 219 unsigned int extra_len; /* length of alignment and padding */
1da177e4 220
242f9dcb
JA
221 unsigned long deadline;
222 struct list_head timeout_list;
1da177e4 223 unsigned int timeout;
17e01f21 224 int retries;
1da177e4 225
1da177e4 226 /*
c00895ab 227 * completion callback.
1da177e4
LT
228 */
229 rq_end_io_fn *end_io;
230 void *end_io_data;
abae1fde
FT
231
232 /* for bidi */
233 struct request *next_rq;
1da177e4
LT
234};
235
aebf526b
CH
236static inline bool blk_rq_is_scsi(struct request *rq)
237{
238 return req_op(rq) == REQ_OP_SCSI_IN || req_op(rq) == REQ_OP_SCSI_OUT;
239}
240
241static inline bool blk_rq_is_private(struct request *rq)
242{
243 return req_op(rq) == REQ_OP_DRV_IN || req_op(rq) == REQ_OP_DRV_OUT;
244}
245
57292b58
CH
246static inline bool blk_rq_is_passthrough(struct request *rq)
247{
aebf526b 248 return blk_rq_is_scsi(rq) || blk_rq_is_private(rq);
57292b58
CH
249}
250
766ca442
FLVC
251static inline unsigned short req_get_ioprio(struct request *req)
252{
253 return req->ioprio;
254}
255
1da177e4
LT
256#include <linux/elevator.h>
257
320ae51f
JA
258struct blk_queue_ctx;
259
165125e1 260typedef void (request_fn_proc) (struct request_queue *q);
dece1635 261typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
165125e1 262typedef int (prep_rq_fn) (struct request_queue *, struct request *);
28018c24 263typedef void (unprep_rq_fn) (struct request_queue *, struct request *);
1da177e4
LT
264
265struct bio_vec;
ff856bad 266typedef void (softirq_done_fn)(struct request *);
2fb98e84 267typedef int (dma_drain_needed_fn)(struct request *);
ef9e3fac 268typedef int (lld_busy_fn) (struct request_queue *q);
aa387cc8 269typedef int (bsg_job_fn) (struct bsg_job *);
6d247d7f
CH
270typedef int (init_rq_fn)(struct request_queue *, struct request *, gfp_t);
271typedef void (exit_rq_fn)(struct request_queue *, struct request *);
1da177e4 272
242f9dcb
JA
273enum blk_eh_timer_return {
274 BLK_EH_NOT_HANDLED,
275 BLK_EH_HANDLED,
276 BLK_EH_RESET_TIMER,
277};
278
279typedef enum blk_eh_timer_return (rq_timed_out_fn)(struct request *);
280
1da177e4
LT
281enum blk_queue_state {
282 Queue_down,
283 Queue_up,
284};
285
1da177e4
LT
286struct blk_queue_tag {
287 struct request **tag_index; /* map of busy tags */
288 unsigned long *tag_map; /* bit map of free/busy tags */
1da177e4 289 int max_depth; /* what we will send to device */
ba025082 290 int real_max_depth; /* what the array can hold */
1da177e4 291 atomic_t refcnt; /* map can be shared */
ee1b6f7a
SL
292 int alloc_policy; /* tag allocation policy */
293 int next_tag; /* next tag */
1da177e4 294};
ee1b6f7a
SL
295#define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
296#define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
1da177e4 297
abf54393
FT
298#define BLK_SCSI_MAX_CMDS (256)
299#define BLK_SCSI_CMD_PER_LONG (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
300
797476b8
DLM
301/*
302 * Zoned block device models (zoned limit).
303 */
304enum blk_zoned_model {
305 BLK_ZONED_NONE, /* Regular block device */
306 BLK_ZONED_HA, /* Host-aware zoned block device */
307 BLK_ZONED_HM, /* Host-managed zoned block device */
308};
309
025146e1
MP
310struct queue_limits {
311 unsigned long bounce_pfn;
312 unsigned long seg_boundary_mask;
03100aad 313 unsigned long virt_boundary_mask;
025146e1
MP
314
315 unsigned int max_hw_sectors;
ca369d51 316 unsigned int max_dev_sectors;
762380ad 317 unsigned int chunk_sectors;
025146e1
MP
318 unsigned int max_sectors;
319 unsigned int max_segment_size;
c72758f3
MP
320 unsigned int physical_block_size;
321 unsigned int alignment_offset;
322 unsigned int io_min;
323 unsigned int io_opt;
67efc925 324 unsigned int max_discard_sectors;
0034af03 325 unsigned int max_hw_discard_sectors;
4363ac7c 326 unsigned int max_write_same_sectors;
a6f0788e 327 unsigned int max_write_zeroes_sectors;
86b37281
MP
328 unsigned int discard_granularity;
329 unsigned int discard_alignment;
025146e1
MP
330
331 unsigned short logical_block_size;
8a78362c 332 unsigned short max_segments;
13f05c8d 333 unsigned short max_integrity_segments;
025146e1 334
c72758f3 335 unsigned char misaligned;
86b37281 336 unsigned char discard_misaligned;
e692cb66 337 unsigned char cluster;
a934a00a 338 unsigned char discard_zeroes_data;
c78afc62 339 unsigned char raid_partial_stripes_expensive;
797476b8 340 enum blk_zoned_model zoned;
025146e1
MP
341};
342
6a0cb1bc
HR
343#ifdef CONFIG_BLK_DEV_ZONED
344
345struct blk_zone_report_hdr {
346 unsigned int nr_zones;
347 u8 padding[60];
348};
349
350extern int blkdev_report_zones(struct block_device *bdev,
351 sector_t sector, struct blk_zone *zones,
352 unsigned int *nr_zones, gfp_t gfp_mask);
353extern int blkdev_reset_zones(struct block_device *bdev, sector_t sectors,
354 sector_t nr_sectors, gfp_t gfp_mask);
355
3ed05a98
ST
356extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
357 unsigned int cmd, unsigned long arg);
358extern int blkdev_reset_zones_ioctl(struct block_device *bdev, fmode_t mode,
359 unsigned int cmd, unsigned long arg);
360
361#else /* CONFIG_BLK_DEV_ZONED */
362
363static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
364 fmode_t mode, unsigned int cmd,
365 unsigned long arg)
366{
367 return -ENOTTY;
368}
369
370static inline int blkdev_reset_zones_ioctl(struct block_device *bdev,
371 fmode_t mode, unsigned int cmd,
372 unsigned long arg)
373{
374 return -ENOTTY;
375}
376
6a0cb1bc
HR
377#endif /* CONFIG_BLK_DEV_ZONED */
378
d7b76301 379struct request_queue {
1da177e4
LT
380 /*
381 * Together with queue_head for cacheline sharing
382 */
383 struct list_head queue_head;
384 struct request *last_merge;
b374d18a 385 struct elevator_queue *elevator;
8a5ecdd4
TH
386 int nr_rqs[2]; /* # allocated [a]sync rqs */
387 int nr_rqs_elvpriv; /* # allocated rqs w/ elvpriv */
1da177e4 388
87760e5e
JA
389 struct rq_wb *rq_wb;
390
1da177e4 391 /*
a051661c
TH
392 * If blkcg is not used, @q->root_rl serves all requests. If blkcg
393 * is used, root blkg allocates from @q->root_rl and all other
394 * blkgs from their own blkg->rl. Which one to use should be
395 * determined using bio_request_list().
1da177e4 396 */
a051661c 397 struct request_list root_rl;
1da177e4
LT
398
399 request_fn_proc *request_fn;
1da177e4
LT
400 make_request_fn *make_request_fn;
401 prep_rq_fn *prep_rq_fn;
28018c24 402 unprep_rq_fn *unprep_rq_fn;
ff856bad 403 softirq_done_fn *softirq_done_fn;
242f9dcb 404 rq_timed_out_fn *rq_timed_out_fn;
2fb98e84 405 dma_drain_needed_fn *dma_drain_needed;
ef9e3fac 406 lld_busy_fn *lld_busy_fn;
6d247d7f
CH
407 init_rq_fn *init_rq_fn;
408 exit_rq_fn *exit_rq_fn;
1da177e4 409
f8a5b122 410 const struct blk_mq_ops *mq_ops;
320ae51f
JA
411
412 unsigned int *mq_map;
413
414 /* sw queues */
e6cdb092 415 struct blk_mq_ctx __percpu *queue_ctx;
320ae51f
JA
416 unsigned int nr_queues;
417
d278d4a8
JA
418 unsigned int queue_depth;
419
320ae51f
JA
420 /* hw dispatch queues */
421 struct blk_mq_hw_ctx **queue_hw_ctx;
422 unsigned int nr_hw_queues;
423
8922e16c
TH
424 /*
425 * Dispatch queue sorting
426 */
1b47f531 427 sector_t end_sector;
8922e16c 428 struct request *boundary_rq;
8922e16c 429
1da177e4 430 /*
3cca6dc1 431 * Delayed queue handling
1da177e4 432 */
3cca6dc1 433 struct delayed_work delay_work;
1da177e4 434
dc3b17cc 435 struct backing_dev_info *backing_dev_info;
1da177e4
LT
436
437 /*
438 * The queue owner gets to use this for whatever they like.
439 * ll_rw_blk doesn't touch it.
440 */
441 void *queuedata;
442
1da177e4 443 /*
d7b76301 444 * various queue flags, see QUEUE_* below
1da177e4 445 */
d7b76301 446 unsigned long queue_flags;
1da177e4 447
a73f730d
TH
448 /*
449 * ida allocated id for this queue. Used to index queues from
450 * ioctx.
451 */
452 int id;
453
1da177e4 454 /*
d7b76301 455 * queue needs bounce pages for pages above this limit
1da177e4 456 */
d7b76301 457 gfp_t bounce_gfp;
1da177e4
LT
458
459 /*
152587de
JA
460 * protects queue structures from reentrancy. ->__queue_lock should
461 * _never_ be used directly, it is queue private. always use
462 * ->queue_lock.
1da177e4 463 */
152587de 464 spinlock_t __queue_lock;
1da177e4
LT
465 spinlock_t *queue_lock;
466
467 /*
468 * queue kobject
469 */
470 struct kobject kobj;
471
320ae51f
JA
472 /*
473 * mq queue kobject
474 */
475 struct kobject mq_kobj;
476
ac6fc48c
DW
477#ifdef CONFIG_BLK_DEV_INTEGRITY
478 struct blk_integrity integrity;
479#endif /* CONFIG_BLK_DEV_INTEGRITY */
480
47fafbc7 481#ifdef CONFIG_PM
6c954667
LM
482 struct device *dev;
483 int rpm_status;
484 unsigned int nr_pending;
485#endif
486
1da177e4
LT
487 /*
488 * queue settings
489 */
490 unsigned long nr_requests; /* Max # of requests */
491 unsigned int nr_congestion_on;
492 unsigned int nr_congestion_off;
493 unsigned int nr_batching;
494
fa0ccd83 495 unsigned int dma_drain_size;
d7b76301 496 void *dma_drain_buffer;
e3790c7d 497 unsigned int dma_pad_mask;
1da177e4
LT
498 unsigned int dma_alignment;
499
500 struct blk_queue_tag *queue_tags;
6eca9004 501 struct list_head tag_busy_list;
1da177e4 502
15853af9 503 unsigned int nr_sorted;
0a7ae2ff 504 unsigned int in_flight[2];
cf43e6be
JA
505
506 struct blk_rq_stat rq_stats[2];
507
24faf6f6
BVA
508 /*
509 * Number of active block driver functions for which blk_drain_queue()
510 * must wait. Must be incremented around functions that unlock the
511 * queue_lock internally, e.g. scsi_request_fn().
512 */
513 unsigned int request_fn_active;
1da177e4 514
242f9dcb 515 unsigned int rq_timeout;
64f1c21e 516 int poll_nsec;
242f9dcb 517 struct timer_list timeout;
287922eb 518 struct work_struct timeout_work;
242f9dcb
JA
519 struct list_head timeout_list;
520
a612fddf 521 struct list_head icq_list;
4eef3049 522#ifdef CONFIG_BLK_CGROUP
a2b1693b 523 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
3c798398 524 struct blkcg_gq *root_blkg;
03aa264a 525 struct list_head blkg_list;
4eef3049 526#endif
a612fddf 527
025146e1
MP
528 struct queue_limits limits;
529
1da177e4
LT
530 /*
531 * sg stuff
532 */
533 unsigned int sg_timeout;
534 unsigned int sg_reserved_size;
1946089a 535 int node;
6c5c9341 536#ifdef CONFIG_BLK_DEV_IO_TRACE
2056a782 537 struct blk_trace *blk_trace;
6c5c9341 538#endif
1da177e4 539 /*
4913efe4 540 * for flush operations
1da177e4 541 */
7c94e1c1 542 struct blk_flush_queue *fq;
483f4afc 543
6fca6a61
CH
544 struct list_head requeue_list;
545 spinlock_t requeue_lock;
2849450a 546 struct delayed_work requeue_work;
6fca6a61 547
483f4afc 548 struct mutex sysfs_lock;
d351af01 549
d732580b 550 int bypass_depth;
4ecd4fef 551 atomic_t mq_freeze_depth;
d732580b 552
d351af01 553#if defined(CONFIG_BLK_DEV_BSG)
aa387cc8
MC
554 bsg_job_fn *bsg_job_fn;
555 int bsg_job_size;
d351af01
FT
556 struct bsg_class_device bsg_dev;
557#endif
e43473b7
VG
558
559#ifdef CONFIG_BLK_DEV_THROTTLING
560 /* Throttle data */
561 struct throtl_data *td;
562#endif
548bc8e1 563 struct rcu_head rcu_head;
320ae51f 564 wait_queue_head_t mq_freeze_wq;
3ef28e83 565 struct percpu_ref q_usage_counter;
320ae51f 566 struct list_head all_q_node;
0d2602ca
JA
567
568 struct blk_mq_tag_set *tag_set;
569 struct list_head tag_set_list;
54efd50b 570 struct bio_set *bio_split;
4593fdbe 571
07e4fead
OS
572#ifdef CONFIG_DEBUG_FS
573 struct dentry *debugfs_dir;
574 struct dentry *mq_debugfs_dir;
575#endif
576
4593fdbe 577 bool mq_sysfs_init_done;
6d247d7f
CH
578
579 size_t cmd_size;
580 void *rq_alloc_data;
1da177e4
LT
581};
582
1da177e4
LT
583#define QUEUE_FLAG_QUEUED 1 /* uses generic tag queueing */
584#define QUEUE_FLAG_STOPPED 2 /* queue is stopped */
1faa16d2
JA
585#define QUEUE_FLAG_SYNCFULL 3 /* read queue has been filled */
586#define QUEUE_FLAG_ASYNCFULL 4 /* write queue has been filled */
3f3299d5 587#define QUEUE_FLAG_DYING 5 /* queue being torn down */
d732580b 588#define QUEUE_FLAG_BYPASS 6 /* act as dumb FIFO queue */
c21e6beb
JA
589#define QUEUE_FLAG_BIDI 7 /* queue supports bidi requests */
590#define QUEUE_FLAG_NOMERGES 8 /* disable merge attempts */
5757a6d7 591#define QUEUE_FLAG_SAME_COMP 9 /* complete on same CPU-group */
c21e6beb
JA
592#define QUEUE_FLAG_FAIL_IO 10 /* fake timeout */
593#define QUEUE_FLAG_STACKABLE 11 /* supports request stacking */
594#define QUEUE_FLAG_NONROT 12 /* non-rotational device (SSD) */
88e740f1 595#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
c21e6beb
JA
596#define QUEUE_FLAG_IO_STAT 13 /* do IO stats */
597#define QUEUE_FLAG_DISCARD 14 /* supports DISCARD */
598#define QUEUE_FLAG_NOXMERGES 15 /* No extended merges */
599#define QUEUE_FLAG_ADD_RANDOM 16 /* Contributes to random pool */
288dab8a 600#define QUEUE_FLAG_SECERASE 17 /* supports secure erase */
5757a6d7 601#define QUEUE_FLAG_SAME_FORCE 18 /* force complete on same CPU */
c246e80d 602#define QUEUE_FLAG_DEAD 19 /* queue tear-down finished */
320ae51f 603#define QUEUE_FLAG_INIT_DONE 20 /* queue is initialized */
05f1dd53 604#define QUEUE_FLAG_NO_SG_MERGE 21 /* don't attempt to merge SG segments*/
05229bee 605#define QUEUE_FLAG_POLL 22 /* IO polling enabled if set */
93e9d8e8
JA
606#define QUEUE_FLAG_WC 23 /* Write back caching */
607#define QUEUE_FLAG_FUA 24 /* device supports FUA writes */
c888a8f9 608#define QUEUE_FLAG_FLUSH_NQ 25 /* flush not queueuable */
163d4baa 609#define QUEUE_FLAG_DAX 26 /* device supports DAX */
cf43e6be 610#define QUEUE_FLAG_STATS 27 /* track rq completion times */
50e1dab8 611#define QUEUE_FLAG_RESTART 28 /* queue needs restart at completion */
bc58ba94
JA
612
613#define QUEUE_FLAG_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
01e97f6b 614 (1 << QUEUE_FLAG_STACKABLE) | \
e2e1a148
JA
615 (1 << QUEUE_FLAG_SAME_COMP) | \
616 (1 << QUEUE_FLAG_ADD_RANDOM))
797e7dbb 617
94eddfbe 618#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
ad9cf3bb 619 (1 << QUEUE_FLAG_STACKABLE) | \
8e0b60b9
CH
620 (1 << QUEUE_FLAG_SAME_COMP) | \
621 (1 << QUEUE_FLAG_POLL))
94eddfbe 622
8bcb6c7d 623static inline void queue_lockdep_assert_held(struct request_queue *q)
8f45c1a5 624{
8bcb6c7d
AK
625 if (q->queue_lock)
626 lockdep_assert_held(q->queue_lock);
8f45c1a5
LT
627}
628
75ad23bc
NP
629static inline void queue_flag_set_unlocked(unsigned int flag,
630 struct request_queue *q)
631{
632 __set_bit(flag, &q->queue_flags);
633}
634
e48ec690
JA
635static inline int queue_flag_test_and_clear(unsigned int flag,
636 struct request_queue *q)
637{
8bcb6c7d 638 queue_lockdep_assert_held(q);
e48ec690
JA
639
640 if (test_bit(flag, &q->queue_flags)) {
641 __clear_bit(flag, &q->queue_flags);
642 return 1;
643 }
644
645 return 0;
646}
647
648static inline int queue_flag_test_and_set(unsigned int flag,
649 struct request_queue *q)
650{
8bcb6c7d 651 queue_lockdep_assert_held(q);
e48ec690
JA
652
653 if (!test_bit(flag, &q->queue_flags)) {
654 __set_bit(flag, &q->queue_flags);
655 return 0;
656 }
657
658 return 1;
659}
660
75ad23bc
NP
661static inline void queue_flag_set(unsigned int flag, struct request_queue *q)
662{
8bcb6c7d 663 queue_lockdep_assert_held(q);
75ad23bc
NP
664 __set_bit(flag, &q->queue_flags);
665}
666
667static inline void queue_flag_clear_unlocked(unsigned int flag,
668 struct request_queue *q)
669{
670 __clear_bit(flag, &q->queue_flags);
671}
672
0a7ae2ff
JA
673static inline int queue_in_flight(struct request_queue *q)
674{
675 return q->in_flight[0] + q->in_flight[1];
676}
677
75ad23bc
NP
678static inline void queue_flag_clear(unsigned int flag, struct request_queue *q)
679{
8bcb6c7d 680 queue_lockdep_assert_held(q);
75ad23bc
NP
681 __clear_bit(flag, &q->queue_flags);
682}
683
1da177e4
LT
684#define blk_queue_tagged(q) test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
685#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
3f3299d5 686#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
c246e80d 687#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
d732580b 688#define blk_queue_bypass(q) test_bit(QUEUE_FLAG_BYPASS, &(q)->queue_flags)
320ae51f 689#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
ac9fafa1 690#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
488991e2
AB
691#define blk_queue_noxmerges(q) \
692 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
a68bbddb 693#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
bc58ba94 694#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
e2e1a148 695#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
4ee5eaf4
KU
696#define blk_queue_stackable(q) \
697 test_bit(QUEUE_FLAG_STACKABLE, &(q)->queue_flags)
c15227de 698#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
288dab8a
CH
699#define blk_queue_secure_erase(q) \
700 (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
163d4baa 701#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
1da177e4 702
33659ebb
CH
703#define blk_noretry_request(rq) \
704 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
705 REQ_FAILFAST_DRIVER))
706
57292b58
CH
707static inline bool blk_account_rq(struct request *rq)
708{
709 return (rq->rq_flags & RQF_STARTED) && !blk_rq_is_passthrough(rq);
710}
33659ebb 711
ab780f1e 712#define blk_rq_cpu_valid(rq) ((rq)->cpu != -1)
abae1fde 713#define blk_bidi_rq(rq) ((rq)->next_rq != NULL)
336cdb40
KU
714/* rq->queuelist of dequeued request must be list_empty() */
715#define blk_queued_rq(rq) (!list_empty(&(rq)->queuelist))
1da177e4
LT
716
717#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
718
4e1b2d52 719#define rq_data_dir(rq) (op_is_write(req_op(rq)) ? WRITE : READ)
1da177e4 720
49fd524f
JA
721/*
722 * Driver can handle struct request, if it either has an old style
723 * request_fn defined, or is blk-mq based.
724 */
725static inline bool queue_is_rq_based(struct request_queue *q)
726{
727 return q->request_fn || q->mq_ops;
728}
729
e692cb66
MP
730static inline unsigned int blk_queue_cluster(struct request_queue *q)
731{
732 return q->limits.cluster;
733}
734
797476b8
DLM
735static inline enum blk_zoned_model
736blk_queue_zoned_model(struct request_queue *q)
737{
738 return q->limits.zoned;
739}
740
741static inline bool blk_queue_is_zoned(struct request_queue *q)
742{
743 switch (blk_queue_zoned_model(q)) {
744 case BLK_ZONED_HA:
745 case BLK_ZONED_HM:
746 return true;
747 default:
748 return false;
749 }
750}
751
f99e8648 752static inline unsigned int blk_queue_zone_sectors(struct request_queue *q)
6a0cb1bc
HR
753{
754 return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
755}
756
1faa16d2
JA
757static inline bool rq_is_sync(struct request *rq)
758{
ef295ecf 759 return op_is_sync(rq->cmd_flags);
1faa16d2
JA
760}
761
5b788ce3 762static inline bool blk_rl_full(struct request_list *rl, bool sync)
1da177e4 763{
5b788ce3
TH
764 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
765
766 return rl->flags & flag;
1da177e4
LT
767}
768
5b788ce3 769static inline void blk_set_rl_full(struct request_list *rl, bool sync)
1da177e4 770{
5b788ce3
TH
771 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
772
773 rl->flags |= flag;
1da177e4
LT
774}
775
5b788ce3 776static inline void blk_clear_rl_full(struct request_list *rl, bool sync)
1da177e4 777{
5b788ce3
TH
778 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
779
780 rl->flags &= ~flag;
1da177e4
LT
781}
782
e2a60da7
MP
783static inline bool rq_mergeable(struct request *rq)
784{
57292b58 785 if (blk_rq_is_passthrough(rq))
e2a60da7 786 return false;
1da177e4 787
3a5e02ce
MC
788 if (req_op(rq) == REQ_OP_FLUSH)
789 return false;
790
a6f0788e
CK
791 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
792 return false;
793
e2a60da7 794 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
e8064021
CH
795 return false;
796 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
e2a60da7
MP
797 return false;
798
799 return true;
800}
1da177e4 801
4363ac7c
MP
802static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
803{
804 if (bio_data(a) == bio_data(b))
805 return true;
806
807 return false;
808}
809
d278d4a8
JA
810static inline unsigned int blk_queue_depth(struct request_queue *q)
811{
812 if (q->queue_depth)
813 return q->queue_depth;
814
815 return q->nr_requests;
816}
817
1da177e4
LT
818/*
819 * q->prep_rq_fn return values
820 */
0fb5b1fb
MP
821enum {
822 BLKPREP_OK, /* serve it */
823 BLKPREP_KILL, /* fatal error, kill, return -EIO */
824 BLKPREP_DEFER, /* leave on queue */
825 BLKPREP_INVALID, /* invalid command, kill, return -EREMOTEIO */
826};
1da177e4
LT
827
828extern unsigned long blk_max_low_pfn, blk_max_pfn;
829
830/*
831 * standard bounce addresses:
832 *
833 * BLK_BOUNCE_HIGH : bounce all highmem pages
834 * BLK_BOUNCE_ANY : don't bounce anything
835 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
836 */
2472892a
AK
837
838#if BITS_PER_LONG == 32
1da177e4 839#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
2472892a
AK
840#else
841#define BLK_BOUNCE_HIGH -1ULL
842#endif
843#define BLK_BOUNCE_ANY (-1ULL)
bfe17231 844#define BLK_BOUNCE_ISA (DMA_BIT_MASK(24))
1da177e4 845
3d6392cf
JA
846/*
847 * default timeout for SG_IO if none specified
848 */
849#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
f2f1fa78 850#define BLK_MIN_SG_TIMEOUT (7 * HZ)
3d6392cf 851
2a7326b5 852#ifdef CONFIG_BOUNCE
1da177e4 853extern int init_emergency_isa_pool(void);
165125e1 854extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
1da177e4
LT
855#else
856static inline int init_emergency_isa_pool(void)
857{
858 return 0;
859}
165125e1 860static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
1da177e4
LT
861{
862}
863#endif /* CONFIG_MMU */
864
152e283f
FT
865struct rq_map_data {
866 struct page **pages;
867 int page_order;
868 int nr_entries;
56c451f4 869 unsigned long offset;
97ae77a1 870 int null_mapped;
ecb554a8 871 int from_user;
152e283f
FT
872};
873
5705f702 874struct req_iterator {
7988613b 875 struct bvec_iter iter;
5705f702
N
876 struct bio *bio;
877};
878
879/* This should not be used directly - use rq_for_each_segment */
1e428079
JA
880#define for_each_bio(_bio) \
881 for (; _bio; _bio = _bio->bi_next)
5705f702 882#define __rq_for_each_bio(_bio, rq) \
1da177e4
LT
883 if ((rq->bio)) \
884 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
885
5705f702
N
886#define rq_for_each_segment(bvl, _rq, _iter) \
887 __rq_for_each_bio(_iter.bio, _rq) \
7988613b 888 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
5705f702 889
4550dd6c 890#define rq_iter_last(bvec, _iter) \
7988613b 891 (_iter.bio->bi_next == NULL && \
4550dd6c 892 bio_iter_last(bvec, _iter.iter))
5705f702 893
2d4dc890
IL
894#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
895# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
896#endif
897#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
898extern void rq_flush_dcache_pages(struct request *rq);
899#else
900static inline void rq_flush_dcache_pages(struct request *rq)
901{
902}
903#endif
904
2af3a815
TK
905#ifdef CONFIG_PRINTK
906#define vfs_msg(sb, level, fmt, ...) \
907 __vfs_msg(sb, level, fmt, ##__VA_ARGS__)
908#else
909#define vfs_msg(sb, level, fmt, ...) \
910do { \
911 no_printk(fmt, ##__VA_ARGS__); \
912 __vfs_msg(sb, "", " "); \
913} while (0)
914#endif
915
1da177e4
LT
916extern int blk_register_queue(struct gendisk *disk);
917extern void blk_unregister_queue(struct gendisk *disk);
dece1635 918extern blk_qc_t generic_make_request(struct bio *bio);
2a4aa30c 919extern void blk_rq_init(struct request_queue *q, struct request *rq);
1da177e4 920extern void blk_put_request(struct request *);
165125e1 921extern void __blk_put_request(struct request_queue *, struct request *);
165125e1 922extern struct request *blk_get_request(struct request_queue *, int, gfp_t);
165125e1 923extern void blk_requeue_request(struct request_queue *, struct request *);
ef9e3fac 924extern int blk_lld_busy(struct request_queue *q);
78d8e58a
MS
925extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
926 struct bio_set *bs, gfp_t gfp_mask,
927 int (*bio_ctr)(struct bio *, struct bio *, void *),
928 void *data);
929extern void blk_rq_unprep_clone(struct request *rq);
82124d60
KU
930extern int blk_insert_cloned_request(struct request_queue *q,
931 struct request *rq);
98d61d5b 932extern int blk_rq_append_bio(struct request *rq, struct bio *bio);
3cca6dc1 933extern void blk_delay_queue(struct request_queue *, unsigned long);
54efd50b
KO
934extern void blk_queue_split(struct request_queue *, struct bio **,
935 struct bio_set *);
165125e1 936extern void blk_recount_segments(struct request_queue *, struct bio *);
0bfc96cb 937extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
577ebb37
PB
938extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
939 unsigned int, void __user *);
74f3c8af
AV
940extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
941 unsigned int, void __user *);
e915e872
AV
942extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
943 struct scsi_ioctl_command __user *);
3fcfab16 944
6f3b0e8b 945extern int blk_queue_enter(struct request_queue *q, bool nowait);
2e6edc95 946extern void blk_queue_exit(struct request_queue *q);
165125e1 947extern void blk_start_queue(struct request_queue *q);
21491412 948extern void blk_start_queue_async(struct request_queue *q);
165125e1 949extern void blk_stop_queue(struct request_queue *q);
1da177e4 950extern void blk_sync_queue(struct request_queue *q);
165125e1 951extern void __blk_stop_queue(struct request_queue *q);
24ecfbe2 952extern void __blk_run_queue(struct request_queue *q);
a7928c15 953extern void __blk_run_queue_uncond(struct request_queue *q);
165125e1 954extern void blk_run_queue(struct request_queue *);
c21e6beb 955extern void blk_run_queue_async(struct request_queue *q);
6a83e74d 956extern void blk_mq_quiesce_queue(struct request_queue *q);
a3bce90e 957extern int blk_rq_map_user(struct request_queue *, struct request *,
152e283f
FT
958 struct rq_map_data *, void __user *, unsigned long,
959 gfp_t);
8e5cfc45 960extern int blk_rq_unmap_user(struct bio *);
165125e1
JA
961extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
962extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
26e49cfc
KO
963 struct rq_map_data *, const struct iov_iter *,
964 gfp_t);
165125e1 965extern int blk_execute_rq(struct request_queue *, struct gendisk *,
994ca9a1 966 struct request *, int);
165125e1 967extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
15fc858a 968 struct request *, int, rq_end_io_fn *);
6e39b69e 969
bbd7bb70 970bool blk_mq_poll(struct request_queue *q, blk_qc_t cookie);
05229bee 971
165125e1 972static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
1da177e4 973{
ff9ea323 974 return bdev->bd_disk->queue; /* this is never NULL */
1da177e4
LT
975}
976
5efccd17 977/*
80a761fd
TH
978 * blk_rq_pos() : the current sector
979 * blk_rq_bytes() : bytes left in the entire request
980 * blk_rq_cur_bytes() : bytes left in the current segment
981 * blk_rq_err_bytes() : bytes left till the next error boundary
982 * blk_rq_sectors() : sectors left in the entire request
983 * blk_rq_cur_sectors() : sectors left in the current segment
5efccd17 984 */
5b93629b
TH
985static inline sector_t blk_rq_pos(const struct request *rq)
986{
a2dec7b3 987 return rq->__sector;
2e46e8b2
TH
988}
989
990static inline unsigned int blk_rq_bytes(const struct request *rq)
991{
a2dec7b3 992 return rq->__data_len;
5b93629b
TH
993}
994
2e46e8b2
TH
995static inline int blk_rq_cur_bytes(const struct request *rq)
996{
997 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
998}
5efccd17 999
80a761fd
TH
1000extern unsigned int blk_rq_err_bytes(const struct request *rq);
1001
5b93629b
TH
1002static inline unsigned int blk_rq_sectors(const struct request *rq)
1003{
2e46e8b2 1004 return blk_rq_bytes(rq) >> 9;
5b93629b
TH
1005}
1006
1007static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
1008{
2e46e8b2 1009 return blk_rq_cur_bytes(rq) >> 9;
5b93629b
TH
1010}
1011
2e3258ec
CH
1012/*
1013 * Some commands like WRITE SAME have a payload or data transfer size which
1014 * is different from the size of the request. Any driver that supports such
1015 * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
1016 * calculate the data transfer size.
1017 */
1018static inline unsigned int blk_rq_payload_bytes(struct request *rq)
1019{
1020 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1021 return rq->special_vec.bv_len;
1022 return blk_rq_bytes(rq);
1023}
1024
f31dc1cd 1025static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
8fe0d473 1026 int op)
f31dc1cd 1027{
7afafc8a 1028 if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
871dd928 1029 return min(q->limits.max_discard_sectors, UINT_MAX >> 9);
f31dc1cd 1030
8fe0d473 1031 if (unlikely(op == REQ_OP_WRITE_SAME))
4363ac7c
MP
1032 return q->limits.max_write_same_sectors;
1033
a6f0788e
CK
1034 if (unlikely(op == REQ_OP_WRITE_ZEROES))
1035 return q->limits.max_write_zeroes_sectors;
1036
f31dc1cd
MP
1037 return q->limits.max_sectors;
1038}
1039
762380ad
JA
1040/*
1041 * Return maximum size of a request at given offset. Only valid for
1042 * file system requests.
1043 */
1044static inline unsigned int blk_max_size_offset(struct request_queue *q,
1045 sector_t offset)
1046{
1047 if (!q->limits.chunk_sectors)
736ed4de 1048 return q->limits.max_sectors;
762380ad
JA
1049
1050 return q->limits.chunk_sectors -
1051 (offset & (q->limits.chunk_sectors - 1));
1052}
1053
17007f39
DLM
1054static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
1055 sector_t offset)
f31dc1cd
MP
1056{
1057 struct request_queue *q = rq->q;
1058
57292b58 1059 if (blk_rq_is_passthrough(rq))
f31dc1cd
MP
1060 return q->limits.max_hw_sectors;
1061
7afafc8a
AH
1062 if (!q->limits.chunk_sectors ||
1063 req_op(rq) == REQ_OP_DISCARD ||
1064 req_op(rq) == REQ_OP_SECURE_ERASE)
8fe0d473 1065 return blk_queue_get_max_sectors(q, req_op(rq));
762380ad 1066
17007f39 1067 return min(blk_max_size_offset(q, offset),
8fe0d473 1068 blk_queue_get_max_sectors(q, req_op(rq)));
f31dc1cd
MP
1069}
1070
75afb352
JN
1071static inline unsigned int blk_rq_count_bios(struct request *rq)
1072{
1073 unsigned int nr_bios = 0;
1074 struct bio *bio;
1075
1076 __rq_for_each_bio(bio, rq)
1077 nr_bios++;
1078
1079 return nr_bios;
1080}
1081
5dc8b362
AM
1082/*
1083 * blk_rq_set_prio - associate a request with prio from ioc
1084 * @rq: request of interest
1085 * @ioc: target iocontext
1086 *
1087 * Assocate request prio with ioc prio so request based drivers
1088 * can leverage priority information.
1089 */
1090static inline void blk_rq_set_prio(struct request *rq, struct io_context *ioc)
1091{
1092 if (ioc)
1093 rq->ioprio = ioc->ioprio;
1094}
1095
9934c8c0
TH
1096/*
1097 * Request issue related functions.
1098 */
1099extern struct request *blk_peek_request(struct request_queue *q);
1100extern void blk_start_request(struct request *rq);
1101extern struct request *blk_fetch_request(struct request_queue *q);
1102
1da177e4 1103/*
2e60e022
TH
1104 * Request completion related functions.
1105 *
1106 * blk_update_request() completes given number of bytes and updates
1107 * the request without completing it.
1108 *
f06d9a2b
TH
1109 * blk_end_request() and friends. __blk_end_request() must be called
1110 * with the request queue spinlock acquired.
1da177e4
LT
1111 *
1112 * Several drivers define their own end_request and call
3bcddeac
KU
1113 * blk_end_request() for parts of the original function.
1114 * This prevents code duplication in drivers.
1da177e4 1115 */
2e60e022
TH
1116extern bool blk_update_request(struct request *rq, int error,
1117 unsigned int nr_bytes);
12120077 1118extern void blk_finish_request(struct request *rq, int error);
b1f74493
FT
1119extern bool blk_end_request(struct request *rq, int error,
1120 unsigned int nr_bytes);
1121extern void blk_end_request_all(struct request *rq, int error);
1122extern bool blk_end_request_cur(struct request *rq, int error);
80a761fd 1123extern bool blk_end_request_err(struct request *rq, int error);
b1f74493
FT
1124extern bool __blk_end_request(struct request *rq, int error,
1125 unsigned int nr_bytes);
1126extern void __blk_end_request_all(struct request *rq, int error);
1127extern bool __blk_end_request_cur(struct request *rq, int error);
80a761fd 1128extern bool __blk_end_request_err(struct request *rq, int error);
2e60e022 1129
ff856bad 1130extern void blk_complete_request(struct request *);
242f9dcb
JA
1131extern void __blk_complete_request(struct request *);
1132extern void blk_abort_request(struct request *);
28018c24 1133extern void blk_unprep_request(struct request *);
ff856bad 1134
1da177e4
LT
1135/*
1136 * Access functions for manipulating queue properties
1137 */
165125e1 1138extern struct request_queue *blk_init_queue_node(request_fn_proc *rfn,
1946089a 1139 spinlock_t *lock, int node_id);
165125e1 1140extern struct request_queue *blk_init_queue(request_fn_proc *, spinlock_t *);
5ea708d1 1141extern int blk_init_allocated_queue(struct request_queue *);
165125e1
JA
1142extern void blk_cleanup_queue(struct request_queue *);
1143extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
1144extern void blk_queue_bounce_limit(struct request_queue *, u64);
086fa5ff 1145extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
762380ad 1146extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
8a78362c 1147extern void blk_queue_max_segments(struct request_queue *, unsigned short);
165125e1 1148extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
67efc925
CH
1149extern void blk_queue_max_discard_sectors(struct request_queue *q,
1150 unsigned int max_discard_sectors);
4363ac7c
MP
1151extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1152 unsigned int max_write_same_sectors);
a6f0788e
CK
1153extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1154 unsigned int max_write_same_sectors);
e1defc4f 1155extern void blk_queue_logical_block_size(struct request_queue *, unsigned short);
892b6f90 1156extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
c72758f3
MP
1157extern void blk_queue_alignment_offset(struct request_queue *q,
1158 unsigned int alignment);
7c958e32 1159extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
c72758f3 1160extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
3c5820c7 1161extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
c72758f3 1162extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
d278d4a8 1163extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
e475bba2 1164extern void blk_set_default_limits(struct queue_limits *lim);
b1bd055d 1165extern void blk_set_stacking_limits(struct queue_limits *lim);
c72758f3
MP
1166extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1167 sector_t offset);
17be8c24
MP
1168extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1169 sector_t offset);
c72758f3
MP
1170extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1171 sector_t offset);
165125e1 1172extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
e3790c7d 1173extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
27f8221a 1174extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
2fb98e84
TH
1175extern int blk_queue_dma_drain(struct request_queue *q,
1176 dma_drain_needed_fn *dma_drain_needed,
1177 void *buf, unsigned int size);
ef9e3fac 1178extern void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn);
165125e1 1179extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
03100aad 1180extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
165125e1 1181extern void blk_queue_prep_rq(struct request_queue *, prep_rq_fn *pfn);
28018c24 1182extern void blk_queue_unprep_rq(struct request_queue *, unprep_rq_fn *ufn);
165125e1 1183extern void blk_queue_dma_alignment(struct request_queue *, int);
11c3e689 1184extern void blk_queue_update_dma_alignment(struct request_queue *, int);
165125e1 1185extern void blk_queue_softirq_done(struct request_queue *, softirq_done_fn *);
242f9dcb
JA
1186extern void blk_queue_rq_timed_out(struct request_queue *, rq_timed_out_fn *);
1187extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
f3876930 1188extern void blk_queue_flush_queueable(struct request_queue *q, bool queueable);
93e9d8e8 1189extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
1da177e4 1190extern struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev);
1da177e4 1191
f9d03f96
CH
1192static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1193{
1194 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1195 return 1;
1196 return rq->nr_phys_segments;
1197}
1198
165125e1 1199extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
1da177e4 1200extern void blk_dump_rq_flags(struct request *, char *);
1da177e4 1201extern long nr_blockdev_pages(void);
1da177e4 1202
09ac46c4 1203bool __must_check blk_get_queue(struct request_queue *);
165125e1
JA
1204struct request_queue *blk_alloc_queue(gfp_t);
1205struct request_queue *blk_alloc_queue_node(gfp_t, int);
1206extern void blk_put_queue(struct request_queue *);
3f21c265 1207extern void blk_set_queue_dying(struct request_queue *);
1da177e4 1208
6c954667
LM
1209/*
1210 * block layer runtime pm functions
1211 */
47fafbc7 1212#ifdef CONFIG_PM
6c954667
LM
1213extern void blk_pm_runtime_init(struct request_queue *q, struct device *dev);
1214extern int blk_pre_runtime_suspend(struct request_queue *q);
1215extern void blk_post_runtime_suspend(struct request_queue *q, int err);
1216extern void blk_pre_runtime_resume(struct request_queue *q);
1217extern void blk_post_runtime_resume(struct request_queue *q, int err);
d07ab6d1 1218extern void blk_set_runtime_active(struct request_queue *q);
6c954667
LM
1219#else
1220static inline void blk_pm_runtime_init(struct request_queue *q,
1221 struct device *dev) {}
1222static inline int blk_pre_runtime_suspend(struct request_queue *q)
1223{
1224 return -ENOSYS;
1225}
1226static inline void blk_post_runtime_suspend(struct request_queue *q, int err) {}
1227static inline void blk_pre_runtime_resume(struct request_queue *q) {}
1228static inline void blk_post_runtime_resume(struct request_queue *q, int err) {}
9a05e754 1229static inline void blk_set_runtime_active(struct request_queue *q) {}
6c954667
LM
1230#endif
1231
316cc67d 1232/*
75df7136
SJ
1233 * blk_plug permits building a queue of related requests by holding the I/O
1234 * fragments for a short period. This allows merging of sequential requests
1235 * into single larger request. As the requests are moved from a per-task list to
1236 * the device's request_queue in a batch, this results in improved scalability
1237 * as the lock contention for request_queue lock is reduced.
1238 *
1239 * It is ok not to disable preemption when adding the request to the plug list
1240 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1241 * the plug list when the task sleeps by itself. For details, please see
1242 * schedule() where blk_schedule_flush_plug() is called.
316cc67d 1243 */
73c10101 1244struct blk_plug {
75df7136 1245 struct list_head list; /* requests */
320ae51f 1246 struct list_head mq_list; /* blk-mq requests */
75df7136 1247 struct list_head cb_list; /* md requires an unplug callback */
73c10101 1248};
55c022bb 1249#define BLK_MAX_REQUEST_COUNT 16
50d24c34 1250#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
55c022bb 1251
9cbb1750 1252struct blk_plug_cb;
74018dc3 1253typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
048c9374
N
1254struct blk_plug_cb {
1255 struct list_head list;
9cbb1750
N
1256 blk_plug_cb_fn callback;
1257 void *data;
048c9374 1258};
9cbb1750
N
1259extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1260 void *data, int size);
73c10101
JA
1261extern void blk_start_plug(struct blk_plug *);
1262extern void blk_finish_plug(struct blk_plug *);
f6603783 1263extern void blk_flush_plug_list(struct blk_plug *, bool);
73c10101
JA
1264
1265static inline void blk_flush_plug(struct task_struct *tsk)
1266{
1267 struct blk_plug *plug = tsk->plug;
1268
a237c1c5
JA
1269 if (plug)
1270 blk_flush_plug_list(plug, false);
1271}
1272
1273static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1274{
1275 struct blk_plug *plug = tsk->plug;
1276
88b996cd 1277 if (plug)
f6603783 1278 blk_flush_plug_list(plug, true);
73c10101
JA
1279}
1280
1281static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1282{
1283 struct blk_plug *plug = tsk->plug;
1284
320ae51f
JA
1285 return plug &&
1286 (!list_empty(&plug->list) ||
1287 !list_empty(&plug->mq_list) ||
1288 !list_empty(&plug->cb_list));
73c10101
JA
1289}
1290
1da177e4
LT
1291/*
1292 * tag stuff
1293 */
165125e1
JA
1294extern int blk_queue_start_tag(struct request_queue *, struct request *);
1295extern struct request *blk_queue_find_tag(struct request_queue *, int);
1296extern void blk_queue_end_tag(struct request_queue *, struct request *);
ee1b6f7a 1297extern int blk_queue_init_tags(struct request_queue *, int, struct blk_queue_tag *, int);
165125e1
JA
1298extern void blk_queue_free_tags(struct request_queue *);
1299extern int blk_queue_resize_tags(struct request_queue *, int);
1300extern void blk_queue_invalidate_tags(struct request_queue *);
ee1b6f7a 1301extern struct blk_queue_tag *blk_init_tags(int, int);
492dfb48 1302extern void blk_free_tags(struct blk_queue_tag *);
1da177e4 1303
f583f492
DS
1304static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
1305 int tag)
1306{
1307 if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
1308 return NULL;
1309 return bqt->tag_index[tag];
1310}
dd3932ed 1311
e950fdf7
CH
1312
1313#define BLKDEV_DISCARD_SECURE (1 << 0) /* issue a secure erase */
1314#define BLKDEV_DISCARD_ZERO (1 << 1) /* must reliably zero data */
dd3932ed
CH
1315
1316extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
fbd9b09a
DM
1317extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1318 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
38f25255 1319extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
288dab8a 1320 sector_t nr_sects, gfp_t gfp_mask, int flags,
469e3216 1321 struct bio **biop);
4363ac7c
MP
1322extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1323 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
e73c23ff
CK
1324extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1325 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
1326 bool discard);
3f14d792 1327extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
d93ba7a5 1328 sector_t nr_sects, gfp_t gfp_mask, bool discard);
2cf6d26a
CH
1329static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1330 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
fb2dce86 1331{
2cf6d26a
CH
1332 return blkdev_issue_discard(sb->s_bdev, block << (sb->s_blocksize_bits - 9),
1333 nr_blocks << (sb->s_blocksize_bits - 9),
1334 gfp_mask, flags);
fb2dce86 1335}
e6fa0be6 1336static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
a107e5a3 1337 sector_t nr_blocks, gfp_t gfp_mask)
e6fa0be6
LC
1338{
1339 return blkdev_issue_zeroout(sb->s_bdev,
1340 block << (sb->s_blocksize_bits - 9),
1341 nr_blocks << (sb->s_blocksize_bits - 9),
d93ba7a5 1342 gfp_mask, true);
e6fa0be6 1343}
1da177e4 1344
018e0446 1345extern int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm);
0b07de85 1346
eb28d31b
MP
1347enum blk_default_limits {
1348 BLK_MAX_SEGMENTS = 128,
1349 BLK_SAFE_MAX_SECTORS = 255,
d2be537c 1350 BLK_DEF_MAX_SECTORS = 2560,
eb28d31b
MP
1351 BLK_MAX_SEGMENT_SIZE = 65536,
1352 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1353};
0e435ac2 1354
1da177e4
LT
1355#define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
1356
ae03bf63
MP
1357static inline unsigned long queue_bounce_pfn(struct request_queue *q)
1358{
025146e1 1359 return q->limits.bounce_pfn;
ae03bf63
MP
1360}
1361
1362static inline unsigned long queue_segment_boundary(struct request_queue *q)
1363{
025146e1 1364 return q->limits.seg_boundary_mask;
ae03bf63
MP
1365}
1366
03100aad
KB
1367static inline unsigned long queue_virt_boundary(struct request_queue *q)
1368{
1369 return q->limits.virt_boundary_mask;
1370}
1371
ae03bf63
MP
1372static inline unsigned int queue_max_sectors(struct request_queue *q)
1373{
025146e1 1374 return q->limits.max_sectors;
ae03bf63
MP
1375}
1376
1377static inline unsigned int queue_max_hw_sectors(struct request_queue *q)
1378{
025146e1 1379 return q->limits.max_hw_sectors;
ae03bf63
MP
1380}
1381
8a78362c 1382static inline unsigned short queue_max_segments(struct request_queue *q)
ae03bf63 1383{
8a78362c 1384 return q->limits.max_segments;
ae03bf63
MP
1385}
1386
1387static inline unsigned int queue_max_segment_size(struct request_queue *q)
1388{
025146e1 1389 return q->limits.max_segment_size;
ae03bf63
MP
1390}
1391
e1defc4f 1392static inline unsigned short queue_logical_block_size(struct request_queue *q)
1da177e4
LT
1393{
1394 int retval = 512;
1395
025146e1
MP
1396 if (q && q->limits.logical_block_size)
1397 retval = q->limits.logical_block_size;
1da177e4
LT
1398
1399 return retval;
1400}
1401
e1defc4f 1402static inline unsigned short bdev_logical_block_size(struct block_device *bdev)
1da177e4 1403{
e1defc4f 1404 return queue_logical_block_size(bdev_get_queue(bdev));
1da177e4
LT
1405}
1406
c72758f3
MP
1407static inline unsigned int queue_physical_block_size(struct request_queue *q)
1408{
1409 return q->limits.physical_block_size;
1410}
1411
892b6f90 1412static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
ac481c20
MP
1413{
1414 return queue_physical_block_size(bdev_get_queue(bdev));
1415}
1416
c72758f3
MP
1417static inline unsigned int queue_io_min(struct request_queue *q)
1418{
1419 return q->limits.io_min;
1420}
1421
ac481c20
MP
1422static inline int bdev_io_min(struct block_device *bdev)
1423{
1424 return queue_io_min(bdev_get_queue(bdev));
1425}
1426
c72758f3
MP
1427static inline unsigned int queue_io_opt(struct request_queue *q)
1428{
1429 return q->limits.io_opt;
1430}
1431
ac481c20
MP
1432static inline int bdev_io_opt(struct block_device *bdev)
1433{
1434 return queue_io_opt(bdev_get_queue(bdev));
1435}
1436
c72758f3
MP
1437static inline int queue_alignment_offset(struct request_queue *q)
1438{
ac481c20 1439 if (q->limits.misaligned)
c72758f3
MP
1440 return -1;
1441
ac481c20 1442 return q->limits.alignment_offset;
c72758f3
MP
1443}
1444
e03a72e1 1445static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
81744ee4
MP
1446{
1447 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
b8839b8c 1448 unsigned int alignment = sector_div(sector, granularity >> 9) << 9;
81744ee4 1449
b8839b8c 1450 return (granularity + lim->alignment_offset - alignment) % granularity;
c72758f3
MP
1451}
1452
ac481c20
MP
1453static inline int bdev_alignment_offset(struct block_device *bdev)
1454{
1455 struct request_queue *q = bdev_get_queue(bdev);
1456
1457 if (q->limits.misaligned)
1458 return -1;
1459
1460 if (bdev != bdev->bd_contains)
1461 return bdev->bd_part->alignment_offset;
1462
1463 return q->limits.alignment_offset;
1464}
1465
86b37281
MP
1466static inline int queue_discard_alignment(struct request_queue *q)
1467{
1468 if (q->limits.discard_misaligned)
1469 return -1;
1470
1471 return q->limits.discard_alignment;
1472}
1473
e03a72e1 1474static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
86b37281 1475{
59771079 1476 unsigned int alignment, granularity, offset;
dd3d145d 1477
a934a00a
MP
1478 if (!lim->max_discard_sectors)
1479 return 0;
1480
59771079
LT
1481 /* Why are these in bytes, not sectors? */
1482 alignment = lim->discard_alignment >> 9;
1483 granularity = lim->discard_granularity >> 9;
1484 if (!granularity)
1485 return 0;
1486
1487 /* Offset of the partition start in 'granularity' sectors */
1488 offset = sector_div(sector, granularity);
1489
1490 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1491 offset = (granularity + alignment - offset) % granularity;
1492
1493 /* Turn it back into bytes, gaah */
1494 return offset << 9;
86b37281
MP
1495}
1496
c6e66634
PB
1497static inline int bdev_discard_alignment(struct block_device *bdev)
1498{
1499 struct request_queue *q = bdev_get_queue(bdev);
1500
1501 if (bdev != bdev->bd_contains)
1502 return bdev->bd_part->discard_alignment;
1503
1504 return q->limits.discard_alignment;
1505}
1506
98262f27
MP
1507static inline unsigned int queue_discard_zeroes_data(struct request_queue *q)
1508{
a934a00a 1509 if (q->limits.max_discard_sectors && q->limits.discard_zeroes_data == 1)
98262f27
MP
1510 return 1;
1511
1512 return 0;
1513}
1514
1515static inline unsigned int bdev_discard_zeroes_data(struct block_device *bdev)
1516{
1517 return queue_discard_zeroes_data(bdev_get_queue(bdev));
1518}
1519
4363ac7c
MP
1520static inline unsigned int bdev_write_same(struct block_device *bdev)
1521{
1522 struct request_queue *q = bdev_get_queue(bdev);
1523
1524 if (q)
1525 return q->limits.max_write_same_sectors;
1526
1527 return 0;
1528}
1529
a6f0788e
CK
1530static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1531{
1532 struct request_queue *q = bdev_get_queue(bdev);
1533
1534 if (q)
1535 return q->limits.max_write_zeroes_sectors;
1536
1537 return 0;
1538}
1539
797476b8
DLM
1540static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1541{
1542 struct request_queue *q = bdev_get_queue(bdev);
1543
1544 if (q)
1545 return blk_queue_zoned_model(q);
1546
1547 return BLK_ZONED_NONE;
1548}
1549
1550static inline bool bdev_is_zoned(struct block_device *bdev)
1551{
1552 struct request_queue *q = bdev_get_queue(bdev);
1553
1554 if (q)
1555 return blk_queue_is_zoned(q);
1556
1557 return false;
1558}
1559
f99e8648 1560static inline unsigned int bdev_zone_sectors(struct block_device *bdev)
6a0cb1bc
HR
1561{
1562 struct request_queue *q = bdev_get_queue(bdev);
1563
1564 if (q)
f99e8648 1565 return blk_queue_zone_sectors(q);
6a0cb1bc
HR
1566
1567 return 0;
1568}
1569
165125e1 1570static inline int queue_dma_alignment(struct request_queue *q)
1da177e4 1571{
482eb689 1572 return q ? q->dma_alignment : 511;
1da177e4
LT
1573}
1574
14417799 1575static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
87904074
FT
1576 unsigned int len)
1577{
1578 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
14417799 1579 return !(addr & alignment) && !(len & alignment);
87904074
FT
1580}
1581
1da177e4
LT
1582/* assumes size > 256 */
1583static inline unsigned int blksize_bits(unsigned int size)
1584{
1585 unsigned int bits = 8;
1586 do {
1587 bits++;
1588 size >>= 1;
1589 } while (size > 256);
1590 return bits;
1591}
1592
2befb9e3 1593static inline unsigned int block_size(struct block_device *bdev)
1da177e4
LT
1594{
1595 return bdev->bd_block_size;
1596}
1597
f3876930 1598static inline bool queue_flush_queueable(struct request_queue *q)
1599{
c888a8f9 1600 return !test_bit(QUEUE_FLAG_FLUSH_NQ, &q->queue_flags);
f3876930 1601}
1602
1da177e4
LT
1603typedef struct {struct page *v;} Sector;
1604
1605unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
1606
1607static inline void put_dev_sector(Sector p)
1608{
09cbfeaf 1609 put_page(p.v);
1da177e4
LT
1610}
1611
e0af2917
ML
1612static inline bool __bvec_gap_to_prev(struct request_queue *q,
1613 struct bio_vec *bprv, unsigned int offset)
1614{
1615 return offset ||
1616 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
1617}
1618
03100aad
KB
1619/*
1620 * Check if adding a bio_vec after bprv with offset would create a gap in
1621 * the SG list. Most drivers don't care about this, but some do.
1622 */
1623static inline bool bvec_gap_to_prev(struct request_queue *q,
1624 struct bio_vec *bprv, unsigned int offset)
1625{
1626 if (!queue_virt_boundary(q))
1627 return false;
e0af2917 1628 return __bvec_gap_to_prev(q, bprv, offset);
03100aad
KB
1629}
1630
729204ef
ML
1631/*
1632 * Check if the two bvecs from two bios can be merged to one segment.
1633 * If yes, no need to check gap between the two bios since the 1st bio
1634 * and the 1st bvec in the 2nd bio can be handled in one segment.
1635 */
1636static inline bool bios_segs_mergeable(struct request_queue *q,
1637 struct bio *prev, struct bio_vec *prev_last_bv,
1638 struct bio_vec *next_first_bv)
1639{
1640 if (!BIOVEC_PHYS_MERGEABLE(prev_last_bv, next_first_bv))
1641 return false;
1642 if (!BIOVEC_SEG_BOUNDARY(q, prev_last_bv, next_first_bv))
1643 return false;
1644 if (prev->bi_seg_back_size + next_first_bv->bv_len >
1645 queue_max_segment_size(q))
1646 return false;
1647 return true;
1648}
1649
5e7c4274
JA
1650static inline bool bio_will_gap(struct request_queue *q, struct bio *prev,
1651 struct bio *next)
1652{
25e71a99
ML
1653 if (bio_has_data(prev) && queue_virt_boundary(q)) {
1654 struct bio_vec pb, nb;
1655
1656 bio_get_last_bvec(prev, &pb);
1657 bio_get_first_bvec(next, &nb);
5e7c4274 1658
729204ef
ML
1659 if (!bios_segs_mergeable(q, prev, &pb, &nb))
1660 return __bvec_gap_to_prev(q, &pb, nb.bv_offset);
25e71a99
ML
1661 }
1662
1663 return false;
5e7c4274
JA
1664}
1665
1666static inline bool req_gap_back_merge(struct request *req, struct bio *bio)
1667{
1668 return bio_will_gap(req->q, req->biotail, bio);
1669}
1670
1671static inline bool req_gap_front_merge(struct request *req, struct bio *bio)
1672{
1673 return bio_will_gap(req->q, bio, req->bio);
1674}
1675
59c3d45e 1676int kblockd_schedule_work(struct work_struct *work);
ee63cfa7 1677int kblockd_schedule_work_on(int cpu, struct work_struct *work);
59c3d45e 1678int kblockd_schedule_delayed_work(struct delayed_work *dwork, unsigned long delay);
8ab14595 1679int kblockd_schedule_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1da177e4 1680
9195291e 1681#ifdef CONFIG_BLK_CGROUP
28f4197e
JA
1682/*
1683 * This should not be using sched_clock(). A real patch is in progress
1684 * to fix this up, until that is in place we need to disable preemption
1685 * around sched_clock() in this function and set_io_start_time_ns().
1686 */
9195291e
DS
1687static inline void set_start_time_ns(struct request *req)
1688{
28f4197e 1689 preempt_disable();
9195291e 1690 req->start_time_ns = sched_clock();
28f4197e 1691 preempt_enable();
9195291e
DS
1692}
1693
1694static inline void set_io_start_time_ns(struct request *req)
1695{
28f4197e 1696 preempt_disable();
9195291e 1697 req->io_start_time_ns = sched_clock();
28f4197e 1698 preempt_enable();
9195291e 1699}
84c124da
DS
1700
1701static inline uint64_t rq_start_time_ns(struct request *req)
1702{
1703 return req->start_time_ns;
1704}
1705
1706static inline uint64_t rq_io_start_time_ns(struct request *req)
1707{
1708 return req->io_start_time_ns;
1709}
9195291e
DS
1710#else
1711static inline void set_start_time_ns(struct request *req) {}
1712static inline void set_io_start_time_ns(struct request *req) {}
84c124da
DS
1713static inline uint64_t rq_start_time_ns(struct request *req)
1714{
1715 return 0;
1716}
1717static inline uint64_t rq_io_start_time_ns(struct request *req)
1718{
1719 return 0;
1720}
9195291e
DS
1721#endif
1722
1da177e4
LT
1723#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1724 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1725#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1726 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1727
7ba1ba12
MP
1728#if defined(CONFIG_BLK_DEV_INTEGRITY)
1729
8288f496
MP
1730enum blk_integrity_flags {
1731 BLK_INTEGRITY_VERIFY = 1 << 0,
1732 BLK_INTEGRITY_GENERATE = 1 << 1,
3aec2f41 1733 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
aae7df50 1734 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
8288f496 1735};
7ba1ba12 1736
18593088 1737struct blk_integrity_iter {
7ba1ba12
MP
1738 void *prot_buf;
1739 void *data_buf;
3be91c4a 1740 sector_t seed;
7ba1ba12 1741 unsigned int data_size;
3be91c4a 1742 unsigned short interval;
7ba1ba12
MP
1743 const char *disk_name;
1744};
1745
18593088 1746typedef int (integrity_processing_fn) (struct blk_integrity_iter *);
7ba1ba12 1747
0f8087ec
MP
1748struct blk_integrity_profile {
1749 integrity_processing_fn *generate_fn;
1750 integrity_processing_fn *verify_fn;
1751 const char *name;
1752};
7ba1ba12 1753
25520d55 1754extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
7ba1ba12 1755extern void blk_integrity_unregister(struct gendisk *);
ad7fce93 1756extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
13f05c8d
MP
1757extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1758 struct scatterlist *);
1759extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
4eaf99be
MP
1760extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1761 struct request *);
1762extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1763 struct bio *);
7ba1ba12 1764
25520d55 1765static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
b04accc4 1766{
ac6fc48c 1767 struct blk_integrity *bi = &disk->queue->integrity;
25520d55
MP
1768
1769 if (!bi->profile)
1770 return NULL;
1771
1772 return bi;
b04accc4
JA
1773}
1774
25520d55
MP
1775static inline
1776struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
b02739b0 1777{
25520d55 1778 return blk_get_integrity(bdev->bd_disk);
b02739b0
MP
1779}
1780
180b2f95 1781static inline bool blk_integrity_rq(struct request *rq)
7ba1ba12 1782{
180b2f95 1783 return rq->cmd_flags & REQ_INTEGRITY;
7ba1ba12
MP
1784}
1785
13f05c8d
MP
1786static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1787 unsigned int segs)
1788{
1789 q->limits.max_integrity_segments = segs;
1790}
1791
1792static inline unsigned short
1793queue_max_integrity_segments(struct request_queue *q)
1794{
1795 return q->limits.max_integrity_segments;
1796}
1797
7f39add3
SG
1798static inline bool integrity_req_gap_back_merge(struct request *req,
1799 struct bio *next)
1800{
1801 struct bio_integrity_payload *bip = bio_integrity(req->bio);
1802 struct bio_integrity_payload *bip_next = bio_integrity(next);
1803
1804 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1805 bip_next->bip_vec[0].bv_offset);
1806}
1807
1808static inline bool integrity_req_gap_front_merge(struct request *req,
1809 struct bio *bio)
1810{
1811 struct bio_integrity_payload *bip = bio_integrity(bio);
1812 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
1813
1814 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1815 bip_next->bip_vec[0].bv_offset);
1816}
1817
7ba1ba12
MP
1818#else /* CONFIG_BLK_DEV_INTEGRITY */
1819
fd83240a
SR
1820struct bio;
1821struct block_device;
1822struct gendisk;
1823struct blk_integrity;
1824
1825static inline int blk_integrity_rq(struct request *rq)
1826{
1827 return 0;
1828}
1829static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1830 struct bio *b)
1831{
1832 return 0;
1833}
1834static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1835 struct bio *b,
1836 struct scatterlist *s)
1837{
1838 return 0;
1839}
1840static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1841{
61a04e5b 1842 return NULL;
fd83240a
SR
1843}
1844static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1845{
1846 return NULL;
1847}
1848static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1849{
1850 return 0;
1851}
25520d55 1852static inline void blk_integrity_register(struct gendisk *d,
fd83240a
SR
1853 struct blk_integrity *b)
1854{
fd83240a
SR
1855}
1856static inline void blk_integrity_unregister(struct gendisk *d)
1857{
1858}
1859static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1860 unsigned int segs)
1861{
1862}
1863static inline unsigned short queue_max_integrity_segments(struct request_queue *q)
1864{
1865 return 0;
1866}
4eaf99be
MP
1867static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1868 struct request *r1,
1869 struct request *r2)
fd83240a 1870{
cb1a5ab6 1871 return true;
fd83240a 1872}
4eaf99be
MP
1873static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1874 struct request *r,
1875 struct bio *b)
fd83240a 1876{
cb1a5ab6 1877 return true;
fd83240a 1878}
25520d55 1879
7f39add3
SG
1880static inline bool integrity_req_gap_back_merge(struct request *req,
1881 struct bio *next)
1882{
1883 return false;
1884}
1885static inline bool integrity_req_gap_front_merge(struct request *req,
1886 struct bio *bio)
1887{
1888 return false;
1889}
7ba1ba12
MP
1890
1891#endif /* CONFIG_BLK_DEV_INTEGRITY */
1892
b2e0d162
DW
1893/**
1894 * struct blk_dax_ctl - control and output parameters for ->direct_access
1895 * @sector: (input) offset relative to a block_device
1896 * @addr: (output) kernel virtual address for @sector populated by driver
1897 * @pfn: (output) page frame number for @addr populated by driver
1898 * @size: (input) number of bytes requested
1899 */
1900struct blk_dax_ctl {
1901 sector_t sector;
7a9eb206 1902 void *addr;
b2e0d162 1903 long size;
34c0fd54 1904 pfn_t pfn;
b2e0d162
DW
1905};
1906
08f85851 1907struct block_device_operations {
d4430d62 1908 int (*open) (struct block_device *, fmode_t);
db2a144b 1909 void (*release) (struct gendisk *, fmode_t);
c11f0c0b 1910 int (*rw_page)(struct block_device *, sector_t, struct page *, bool);
d4430d62
AV
1911 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1912 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
7a9eb206
DW
1913 long (*direct_access)(struct block_device *, sector_t, void **, pfn_t *,
1914 long);
77ea887e
TH
1915 unsigned int (*check_events) (struct gendisk *disk,
1916 unsigned int clearing);
1917 /* ->media_changed() is DEPRECATED, use ->check_events() instead */
08f85851 1918 int (*media_changed) (struct gendisk *);
c3e33e04 1919 void (*unlock_native_capacity) (struct gendisk *);
08f85851
AV
1920 int (*revalidate_disk) (struct gendisk *);
1921 int (*getgeo)(struct block_device *, struct hd_geometry *);
b3a27d05
NG
1922 /* this callback is with swap_lock and sometimes page table lock held */
1923 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
08f85851 1924 struct module *owner;
bbd3e064 1925 const struct pr_ops *pr_ops;
08f85851
AV
1926};
1927
633a08b8
AV
1928extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1929 unsigned long);
47a191fd
MW
1930extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1931extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1932 struct writeback_control *);
b2e0d162 1933extern long bdev_direct_access(struct block_device *, struct blk_dax_ctl *);
2d96afc8 1934extern int bdev_dax_supported(struct super_block *, int);
a8078b1f 1935extern bool bdev_dax_capable(struct block_device *);
9361401e 1936#else /* CONFIG_BLOCK */
ac13a829
FF
1937
1938struct block_device;
1939
9361401e
DH
1940/*
1941 * stubs for when the block layer is configured out
1942 */
1943#define buffer_heads_over_limit 0
1944
9361401e
DH
1945static inline long nr_blockdev_pages(void)
1946{
1947 return 0;
1948}
1949
1f940bdf
JA
1950struct blk_plug {
1951};
1952
1953static inline void blk_start_plug(struct blk_plug *plug)
73c10101
JA
1954{
1955}
1956
1f940bdf 1957static inline void blk_finish_plug(struct blk_plug *plug)
73c10101
JA
1958{
1959}
1960
1f940bdf 1961static inline void blk_flush_plug(struct task_struct *task)
73c10101
JA
1962{
1963}
1964
a237c1c5
JA
1965static inline void blk_schedule_flush_plug(struct task_struct *task)
1966{
1967}
1968
1969
73c10101
JA
1970static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1971{
1972 return false;
1973}
1974
ac13a829
FF
1975static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
1976 sector_t *error_sector)
1977{
1978 return 0;
1979}
1980
9361401e
DH
1981#endif /* CONFIG_BLOCK */
1982
1da177e4 1983#endif