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