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