Documentation: Document the blk-crypto framework
[linux-2.6-block.git] / include / linux / blkdev.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_BLKDEV_H
3#define _LINUX_BLKDEV_H
4
85fd0bc9 5#include <linux/sched.h>
e6017571 6#include <linux/sched/clock.h>
85fd0bc9 7
f5ff8422
JA
8#ifdef CONFIG_BLOCK
9
1da177e4
LT
10#include <linux/major.h>
11#include <linux/genhd.h>
12#include <linux/list.h>
320ae51f 13#include <linux/llist.h>
1da177e4
LT
14#include <linux/timer.h>
15#include <linux/workqueue.h>
16#include <linux/pagemap.h>
66114cad 17#include <linux/backing-dev-defs.h>
1da177e4
LT
18#include <linux/wait.h>
19#include <linux/mempool.h>
34c0fd54 20#include <linux/pfn.h>
1da177e4 21#include <linux/bio.h>
1da177e4 22#include <linux/stringify.h>
3e6053d7 23#include <linux/gfp.h>
d351af01 24#include <linux/bsg.h>
c7c22e4d 25#include <linux/smp.h>
548bc8e1 26#include <linux/rcupdate.h>
add703fd 27#include <linux/percpu-refcount.h>
84be456f 28#include <linux/scatterlist.h>
6a0cb1bc 29#include <linux/blkzoned.h>
1da177e4 30
de477254 31struct module;
21b2f0c8
CH
32struct scsi_ioctl_command;
33
1da177e4 34struct request_queue;
1da177e4 35struct elevator_queue;
2056a782 36struct blk_trace;
3d6392cf
JA
37struct request;
38struct sg_io_hdr;
aa387cc8 39struct bsg_job;
3c798398 40struct blkcg_gq;
7c94e1c1 41struct blk_flush_queue;
bbd3e064 42struct pr_ops;
a7905043 43struct rq_qos;
34dbad5d
OS
44struct blk_queue_stats;
45struct blk_stat_callback;
1da177e4
LT
46
47#define BLKDEV_MIN_RQ 4
48#define BLKDEV_MAX_RQ 128 /* Default maximum */
49
096392e0 50/* Must be consistent with blk_mq_poll_stats_bkt() */
0206319f
SB
51#define BLK_MQ_POLL_STATS_BKTS 16
52
29ece8b4
YY
53/* Doing classic polling */
54#define BLK_MQ_POLL_CLASSIC -1
55
8bd435b3
TH
56/*
57 * Maximum number of blkcg policies allowed to be registered concurrently.
58 * Defined here to simplify include dependency.
59 */
01c5f85a 60#define BLKCG_MAX_POLS 5
8bd435b3 61
2a842aca 62typedef void (rq_end_io_fn)(struct request *, blk_status_t);
1da177e4 63
e8064021
CH
64/*
65 * request flags */
66typedef __u32 __bitwise req_flags_t;
67
68/* elevator knows about this request */
69#define RQF_SORTED ((__force req_flags_t)(1 << 0))
70/* drive already may have started this one */
71#define RQF_STARTED ((__force req_flags_t)(1 << 1))
e8064021
CH
72/* may not be passed by ioscheduler */
73#define RQF_SOFTBARRIER ((__force req_flags_t)(1 << 3))
74/* request for flush sequence */
75#define RQF_FLUSH_SEQ ((__force req_flags_t)(1 << 4))
76/* merge of different types, fail separately */
77#define RQF_MIXED_MERGE ((__force req_flags_t)(1 << 5))
78/* track inflight for MQ */
79#define RQF_MQ_INFLIGHT ((__force req_flags_t)(1 << 6))
80/* don't call prep for this one */
81#define RQF_DONTPREP ((__force req_flags_t)(1 << 7))
82/* set for "ide_preempt" requests and also for requests for which the SCSI
83 "quiesce" state must be ignored. */
84#define RQF_PREEMPT ((__force req_flags_t)(1 << 8))
e8064021
CH
85/* vaguely specified driver internal error. Ignored by the block layer */
86#define RQF_FAILED ((__force req_flags_t)(1 << 10))
87/* don't warn about errors */
88#define RQF_QUIET ((__force req_flags_t)(1 << 11))
89/* elevator private data attached */
90#define RQF_ELVPRIV ((__force req_flags_t)(1 << 12))
4822e902 91/* account into disk and partition IO statistics */
e8064021
CH
92#define RQF_IO_STAT ((__force req_flags_t)(1 << 13))
93/* request came from our alloc pool */
94#define RQF_ALLOCED ((__force req_flags_t)(1 << 14))
95/* runtime pm request */
96#define RQF_PM ((__force req_flags_t)(1 << 15))
97/* on IO scheduler merge hash */
98#define RQF_HASHED ((__force req_flags_t)(1 << 16))
4822e902 99/* track IO completion time */
cf43e6be 100#define RQF_STATS ((__force req_flags_t)(1 << 17))
f9d03f96
CH
101/* Look at ->special_vec for the actual data payload instead of the
102 bio chain. */
103#define RQF_SPECIAL_PAYLOAD ((__force req_flags_t)(1 << 18))
6cc77e9c
CH
104/* The per-zone write lock is held for this request */
105#define RQF_ZONE_WRITE_LOCKED ((__force req_flags_t)(1 << 19))
76a86f9d 106/* already slept for hybrid poll */
12f5b931 107#define RQF_MQ_POLL_SLEPT ((__force req_flags_t)(1 << 20))
da661267
CH
108/* ->timeout has been called, don't expire again */
109#define RQF_TIMED_OUT ((__force req_flags_t)(1 << 21))
e8064021
CH
110
111/* flags that prevent us from merging requests: */
112#define RQF_NOMERGE_FLAGS \
f9d03f96 113 (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
e8064021 114
12f5b931
KB
115/*
116 * Request state for blk-mq.
117 */
118enum mq_rq_state {
119 MQ_RQ_IDLE = 0,
120 MQ_RQ_IN_FLIGHT = 1,
121 MQ_RQ_COMPLETE = 2,
122};
123
1da177e4 124/*
af76e555
CH
125 * Try to put the fields that are referenced together in the same cacheline.
126 *
127 * If you modify this structure, make sure to update blk_rq_init() and
128 * especially blk_mq_rq_ctx_init() to take care of the added fields.
1da177e4
LT
129 */
130struct request {
165125e1 131 struct request_queue *q;
320ae51f 132 struct blk_mq_ctx *mq_ctx;
ea4f995e 133 struct blk_mq_hw_ctx *mq_hctx;
e6a1c874 134
ef295ecf 135 unsigned int cmd_flags; /* op and common flags */
e8064021 136 req_flags_t rq_flags;
d486f1f2 137
2f578aaf 138 int tag;
d486f1f2
JA
139 int internal_tag;
140
a2dec7b3 141 /* the following two fields are internal, NEVER access directly */
a2dec7b3 142 unsigned int __data_len; /* total data len */
181fdde3 143 sector_t __sector; /* sector cursor */
1da177e4
LT
144
145 struct bio *bio;
146 struct bio *biotail;
147
7c3fb70f
JA
148 struct list_head queuelist;
149
360f92c2
JA
150 /*
151 * The hash is used inside the scheduler, and killed once the
152 * request reaches the dispatch list. The ipi_list is only used
153 * to queue the request for softirq completion, which is long
154 * after the request has been unhashed (and even removed from
155 * the dispatch list).
156 */
157 union {
158 struct hlist_node hash; /* merge hash */
159 struct list_head ipi_list;
160 };
161
e6a1c874
JA
162 /*
163 * The rb_node is only used inside the io scheduler, requests
164 * are pruned when moved to the dispatch queue. So let the
c186794d 165 * completion_data share space with the rb_node.
e6a1c874
JA
166 */
167 union {
168 struct rb_node rb_node; /* sort/lookup */
f9d03f96 169 struct bio_vec special_vec;
c186794d 170 void *completion_data;
e26738e0 171 int error_count; /* for legacy drivers, don't use */
e6a1c874 172 };
9817064b 173
ff7d145f 174 /*
7f1dc8a2 175 * Three pointers are available for the IO schedulers, if they need
c186794d
MS
176 * more they have to dynamically allocate it. Flush requests are
177 * never put on the IO scheduler. So let the flush fields share
a612fddf 178 * space with the elevator data.
ff7d145f 179 */
c186794d 180 union {
a612fddf
TH
181 struct {
182 struct io_cq *icq;
183 void *priv[2];
184 } elv;
185
c186794d
MS
186 struct {
187 unsigned int seq;
188 struct list_head list;
4853abaa 189 rq_end_io_fn *saved_end_io;
c186794d
MS
190 } flush;
191 };
ff7d145f 192
8f34ee75 193 struct gendisk *rq_disk;
09e099d4 194 struct hd_struct *part;
6f816b4b
TH
195#ifdef CONFIG_BLK_RQ_ALLOC_TIME
196 /* Time that the first bio started allocating this request. */
197 u64 alloc_time_ns;
198#endif
199 /* Time that this request was allocated for this IO. */
522a7775 200 u64 start_time_ns;
544ccc8d
OS
201 /* Time that I/O was submitted to the device. */
202 u64 io_start_time_ns;
203
204#ifdef CONFIG_BLK_WBT
205 unsigned short wbt_flags;
206#endif
3d244306
HT
207 /*
208 * rq sectors used for blk stats. It has the same value
209 * with blk_rq_sectors(rq), except that it never be zeroed
210 * by completion.
211 */
212 unsigned short stats_sectors;
544ccc8d
OS
213
214 /*
215 * Number of scatter-gather DMA addr+len pairs after
1da177e4
LT
216 * physical address coalescing is performed.
217 */
218 unsigned short nr_phys_segments;
7c3fb70f 219
13f05c8d
MP
220#if defined(CONFIG_BLK_DEV_INTEGRITY)
221 unsigned short nr_integrity_segments;
222#endif
1da177e4 223
7c3fb70f 224 unsigned short write_hint;
8f34ee75
JA
225 unsigned short ioprio;
226
12f5b931
KB
227 enum mq_rq_state state;
228 refcount_t ref;
1d9bd516 229
0b7576d8 230 unsigned int timeout;
079076b3 231 unsigned long deadline;
cb6934f8 232
7c3fb70f 233 union {
0a4b6e2f 234 struct __call_single_data csd;
7c3fb70f
JA
235 u64 fifo_time;
236 };
237
1da177e4 238 /*
c00895ab 239 * completion callback.
1da177e4
LT
240 */
241 rq_end_io_fn *end_io;
242 void *end_io_data;
243};
244
14cb0dc6
ML
245static inline bool blk_op_is_scsi(unsigned int op)
246{
247 return op == REQ_OP_SCSI_IN || op == REQ_OP_SCSI_OUT;
248}
249
250static inline bool blk_op_is_private(unsigned int op)
251{
252 return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
253}
254
aebf526b
CH
255static inline bool blk_rq_is_scsi(struct request *rq)
256{
14cb0dc6 257 return blk_op_is_scsi(req_op(rq));
aebf526b
CH
258}
259
260static inline bool blk_rq_is_private(struct request *rq)
261{
14cb0dc6 262 return blk_op_is_private(req_op(rq));
aebf526b
CH
263}
264
57292b58
CH
265static inline bool blk_rq_is_passthrough(struct request *rq)
266{
aebf526b 267 return blk_rq_is_scsi(rq) || blk_rq_is_private(rq);
57292b58
CH
268}
269
14cb0dc6
ML
270static inline bool bio_is_passthrough(struct bio *bio)
271{
272 unsigned op = bio_op(bio);
273
274 return blk_op_is_scsi(op) || blk_op_is_private(op);
275}
276
766ca442
FLVC
277static inline unsigned short req_get_ioprio(struct request *req)
278{
279 return req->ioprio;
280}
281
1da177e4
LT
282#include <linux/elevator.h>
283
320ae51f
JA
284struct blk_queue_ctx;
285
dece1635 286typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
1da177e4
LT
287
288struct bio_vec;
1da177e4 289
242f9dcb 290enum blk_eh_timer_return {
88b0cfad
CH
291 BLK_EH_DONE, /* drivers has completed the command */
292 BLK_EH_RESET_TIMER, /* reset timer and try again */
242f9dcb
JA
293};
294
1da177e4
LT
295enum blk_queue_state {
296 Queue_down,
297 Queue_up,
298};
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 325 unsigned int physical_block_size;
ad6bf88a 326 unsigned int logical_block_size;
c72758f3
MP
327 unsigned int alignment_offset;
328 unsigned int io_min;
329 unsigned int io_opt;
67efc925 330 unsigned int max_discard_sectors;
0034af03 331 unsigned int max_hw_discard_sectors;
4363ac7c 332 unsigned int max_write_same_sectors;
a6f0788e 333 unsigned int max_write_zeroes_sectors;
0512a75b 334 unsigned int max_zone_append_sectors;
86b37281
MP
335 unsigned int discard_granularity;
336 unsigned int discard_alignment;
025146e1 337
8a78362c 338 unsigned short max_segments;
13f05c8d 339 unsigned short max_integrity_segments;
1e739730 340 unsigned short max_discard_segments;
025146e1 341
c72758f3 342 unsigned char misaligned;
86b37281 343 unsigned char discard_misaligned;
c78afc62 344 unsigned char raid_partial_stripes_expensive;
797476b8 345 enum blk_zoned_model zoned;
025146e1
MP
346};
347
d4100351
CH
348typedef int (*report_zones_cb)(struct blk_zone *zone, unsigned int idx,
349 void *data);
350
6a0cb1bc
HR
351#ifdef CONFIG_BLK_DEV_ZONED
352
d4100351
CH
353#define BLK_ALL_ZONES ((unsigned int)-1)
354int blkdev_report_zones(struct block_device *bdev, sector_t sector,
355 unsigned int nr_zones, report_zones_cb cb, void *data);
9b38bb4b 356unsigned int blkdev_nr_zones(struct gendisk *disk);
6c1b1da5
AJ
357extern int blkdev_zone_mgmt(struct block_device *bdev, enum req_opf op,
358 sector_t sectors, sector_t nr_sectors,
359 gfp_t gfp_mask);
e732671a
DLM
360int blk_revalidate_disk_zones(struct gendisk *disk,
361 void (*update_driver_data)(struct gendisk *disk));
6a0cb1bc 362
3ed05a98
ST
363extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
364 unsigned int cmd, unsigned long arg);
e876df1f
AJ
365extern int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
366 unsigned int cmd, unsigned long arg);
3ed05a98
ST
367
368#else /* CONFIG_BLK_DEV_ZONED */
369
9b38bb4b 370static inline unsigned int blkdev_nr_zones(struct gendisk *disk)
a91e1380
DLM
371{
372 return 0;
373}
bf505456 374
3ed05a98
ST
375static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
376 fmode_t mode, unsigned int cmd,
377 unsigned long arg)
378{
379 return -ENOTTY;
380}
381
e876df1f
AJ
382static inline int blkdev_zone_mgmt_ioctl(struct block_device *bdev,
383 fmode_t mode, unsigned int cmd,
384 unsigned long arg)
3ed05a98
ST
385{
386 return -ENOTTY;
387}
388
6a0cb1bc
HR
389#endif /* CONFIG_BLK_DEV_ZONED */
390
d7b76301 391struct request_queue {
1da177e4 392 struct request *last_merge;
b374d18a 393 struct elevator_queue *elevator;
1da177e4 394
34dbad5d 395 struct blk_queue_stats *stats;
a7905043 396 struct rq_qos *rq_qos;
87760e5e 397
1da177e4 398 make_request_fn *make_request_fn;
1da177e4 399
f8a5b122 400 const struct blk_mq_ops *mq_ops;
320ae51f 401
320ae51f 402 /* sw queues */
e6cdb092 403 struct blk_mq_ctx __percpu *queue_ctx;
320ae51f 404
d278d4a8
JA
405 unsigned int queue_depth;
406
320ae51f
JA
407 /* hw dispatch queues */
408 struct blk_mq_hw_ctx **queue_hw_ctx;
409 unsigned int nr_hw_queues;
410
dc3b17cc 411 struct backing_dev_info *backing_dev_info;
1da177e4
LT
412
413 /*
414 * The queue owner gets to use this for whatever they like.
415 * ll_rw_blk doesn't touch it.
416 */
417 void *queuedata;
418
1da177e4 419 /*
d7b76301 420 * various queue flags, see QUEUE_* below
1da177e4 421 */
d7b76301 422 unsigned long queue_flags;
cd84a62e
BVA
423 /*
424 * Number of contexts that have called blk_set_pm_only(). If this
425 * counter is above zero then only RQF_PM and RQF_PREEMPT requests are
426 * processed.
427 */
428 atomic_t pm_only;
1da177e4 429
a73f730d
TH
430 /*
431 * ida allocated id for this queue. Used to index queues from
432 * ioctx.
433 */
434 int id;
435
1da177e4 436 /*
d7b76301 437 * queue needs bounce pages for pages above this limit
1da177e4 438 */
d7b76301 439 gfp_t bounce_gfp;
1da177e4 440
0d945c1f 441 spinlock_t queue_lock;
1da177e4
LT
442
443 /*
444 * queue kobject
445 */
446 struct kobject kobj;
447
320ae51f
JA
448 /*
449 * mq queue kobject
450 */
1db4909e 451 struct kobject *mq_kobj;
320ae51f 452
ac6fc48c
DW
453#ifdef CONFIG_BLK_DEV_INTEGRITY
454 struct blk_integrity integrity;
455#endif /* CONFIG_BLK_DEV_INTEGRITY */
456
47fafbc7 457#ifdef CONFIG_PM
6c954667
LM
458 struct device *dev;
459 int rpm_status;
460 unsigned int nr_pending;
461#endif
462
1da177e4
LT
463 /*
464 * queue settings
465 */
466 unsigned long nr_requests; /* Max # of requests */
1da177e4 467
e3790c7d 468 unsigned int dma_pad_mask;
1da177e4
LT
469 unsigned int dma_alignment;
470
242f9dcb 471 unsigned int rq_timeout;
64f1c21e 472 int poll_nsec;
34dbad5d
OS
473
474 struct blk_stat_callback *poll_cb;
0206319f 475 struct blk_rq_stat poll_stat[BLK_MQ_POLL_STATS_BKTS];
34dbad5d 476
242f9dcb 477 struct timer_list timeout;
287922eb 478 struct work_struct timeout_work;
242f9dcb 479
a612fddf 480 struct list_head icq_list;
4eef3049 481#ifdef CONFIG_BLK_CGROUP
a2b1693b 482 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
3c798398 483 struct blkcg_gq *root_blkg;
03aa264a 484 struct list_head blkg_list;
4eef3049 485#endif
a612fddf 486
025146e1
MP
487 struct queue_limits limits;
488
68c43f13
DLM
489 unsigned int required_elevator_features;
490
6a5ac984 491#ifdef CONFIG_BLK_DEV_ZONED
6cc77e9c
CH
492 /*
493 * Zoned block device information for request dispatch control.
494 * nr_zones is the total number of zones of the device. This is always
f216fdd7
CH
495 * 0 for regular block devices. conv_zones_bitmap is a bitmap of nr_zones
496 * bits which indicates if a zone is conventional (bit set) or
497 * sequential (bit clear). seq_zones_wlock is a bitmap of nr_zones
6cc77e9c
CH
498 * bits which indicates if a zone is write locked, that is, if a write
499 * request targeting the zone was dispatched. All three fields are
500 * initialized by the low level device driver (e.g. scsi/sd.c).
501 * Stacking drivers (device mappers) may or may not initialize
502 * these fields.
ccce20fc
BVA
503 *
504 * Reads of this information must be protected with blk_queue_enter() /
505 * blk_queue_exit(). Modifying this information is only allowed while
506 * no requests are being processed. See also blk_mq_freeze_queue() and
507 * blk_mq_unfreeze_queue().
6cc77e9c
CH
508 */
509 unsigned int nr_zones;
f216fdd7 510 unsigned long *conv_zones_bitmap;
6cc77e9c 511 unsigned long *seq_zones_wlock;
6a5ac984 512#endif /* CONFIG_BLK_DEV_ZONED */
6cc77e9c 513
1da177e4
LT
514 /*
515 * sg stuff
516 */
517 unsigned int sg_timeout;
518 unsigned int sg_reserved_size;
1946089a 519 int node;
6c5c9341 520#ifdef CONFIG_BLK_DEV_IO_TRACE
c780e86d 521 struct blk_trace __rcu *blk_trace;
5acb3cc2 522 struct mutex blk_trace_mutex;
6c5c9341 523#endif
1da177e4 524 /*
4913efe4 525 * for flush operations
1da177e4 526 */
7c94e1c1 527 struct blk_flush_queue *fq;
483f4afc 528
6fca6a61
CH
529 struct list_head requeue_list;
530 spinlock_t requeue_lock;
2849450a 531 struct delayed_work requeue_work;
6fca6a61 532
483f4afc 533 struct mutex sysfs_lock;
cecf5d87 534 struct mutex sysfs_dir_lock;
d351af01 535
2f8f1336
ML
536 /*
537 * for reusing dead hctx instance in case of updating
538 * nr_hw_queues
539 */
540 struct list_head unused_hctx_list;
541 spinlock_t unused_hctx_lock;
542
7996a8b5 543 int mq_freeze_depth;
d732580b 544
d351af01
FT
545#if defined(CONFIG_BLK_DEV_BSG)
546 struct bsg_class_device bsg_dev;
547#endif
e43473b7
VG
548
549#ifdef CONFIG_BLK_DEV_THROTTLING
550 /* Throttle data */
551 struct throtl_data *td;
552#endif
548bc8e1 553 struct rcu_head rcu_head;
320ae51f 554 wait_queue_head_t mq_freeze_wq;
7996a8b5
BL
555 /*
556 * Protect concurrent access to q_usage_counter by
557 * percpu_ref_kill() and percpu_ref_reinit().
558 */
559 struct mutex mq_freeze_lock;
3ef28e83 560 struct percpu_ref q_usage_counter;
0d2602ca
JA
561
562 struct blk_mq_tag_set *tag_set;
563 struct list_head tag_set_list;
338aa96d 564 struct bio_set bio_split;
4593fdbe 565
03796c14 566#ifdef CONFIG_BLK_DEBUG_FS
07e4fead 567 struct dentry *debugfs_dir;
d332ce09 568 struct dentry *sched_debugfs_dir;
cc56694f 569 struct dentry *rqos_debugfs_dir;
07e4fead
OS
570#endif
571
4593fdbe 572 bool mq_sysfs_init_done;
6d247d7f
CH
573
574 size_t cmd_size;
dc9edc44
BVA
575
576 struct work_struct release_work;
f793dfd3
JA
577
578#define BLK_MAX_WRITE_HINTS 5
579 u64 write_hints[BLK_MAX_WRITE_HINTS];
1da177e4
LT
580};
581
eca7abf3
JA
582#define QUEUE_FLAG_STOPPED 0 /* queue is stopped */
583#define QUEUE_FLAG_DYING 1 /* queue being torn down */
eca7abf3
JA
584#define QUEUE_FLAG_NOMERGES 3 /* disable merge attempts */
585#define QUEUE_FLAG_SAME_COMP 4 /* complete on same CPU-group */
586#define QUEUE_FLAG_FAIL_IO 5 /* fake timeout */
587#define QUEUE_FLAG_NONROT 6 /* non-rotational device (SSD) */
588#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
589#define QUEUE_FLAG_IO_STAT 7 /* do disk/partitions IO accounting */
590#define QUEUE_FLAG_DISCARD 8 /* supports DISCARD */
591#define QUEUE_FLAG_NOXMERGES 9 /* No extended merges */
592#define QUEUE_FLAG_ADD_RANDOM 10 /* Contributes to random pool */
593#define QUEUE_FLAG_SECERASE 11 /* supports secure erase */
594#define QUEUE_FLAG_SAME_FORCE 12 /* force complete on same CPU */
595#define QUEUE_FLAG_DEAD 13 /* queue tear-down finished */
596#define QUEUE_FLAG_INIT_DONE 14 /* queue is initialized */
eca7abf3
JA
597#define QUEUE_FLAG_POLL 16 /* IO polling enabled if set */
598#define QUEUE_FLAG_WC 17 /* Write back caching */
599#define QUEUE_FLAG_FUA 18 /* device supports FUA writes */
600#define QUEUE_FLAG_DAX 19 /* device supports DAX */
601#define QUEUE_FLAG_STATS 20 /* track IO start and completion times */
602#define QUEUE_FLAG_POLL_STATS 21 /* collecting stats for hybrid polling */
603#define QUEUE_FLAG_REGISTERED 22 /* queue has been registered to a disk */
604#define QUEUE_FLAG_SCSI_PASSTHROUGH 23 /* queue supports SCSI commands */
605#define QUEUE_FLAG_QUIESCED 24 /* queue has been quiesced */
606#define QUEUE_FLAG_PCI_P2PDMA 25 /* device supports PCI p2p requests */
e84e8f06 607#define QUEUE_FLAG_ZONE_RESETALL 26 /* supports Zone Reset All */
6f816b4b 608#define QUEUE_FLAG_RQ_ALLOC_TIME 27 /* record rq->alloc_time_ns */
797e7dbb 609
94eddfbe 610#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
6e0de611 611 (1 << QUEUE_FLAG_SAME_COMP))
94eddfbe 612
8814ce8a
BVA
613void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
614void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
615bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
8814ce8a 616
1da177e4 617#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
3f3299d5 618#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
c246e80d 619#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
320ae51f 620#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
ac9fafa1 621#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
488991e2
AB
622#define blk_queue_noxmerges(q) \
623 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
a68bbddb 624#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
bc58ba94 625#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
e2e1a148 626#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
c15227de 627#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
e84e8f06
CK
628#define blk_queue_zone_resetall(q) \
629 test_bit(QUEUE_FLAG_ZONE_RESETALL, &(q)->queue_flags)
288dab8a
CH
630#define blk_queue_secure_erase(q) \
631 (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
163d4baa 632#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
9efc160f
BVA
633#define blk_queue_scsi_passthrough(q) \
634 test_bit(QUEUE_FLAG_SCSI_PASSTHROUGH, &(q)->queue_flags)
49d92c0d
LG
635#define blk_queue_pci_p2pdma(q) \
636 test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
6f816b4b
TH
637#ifdef CONFIG_BLK_RQ_ALLOC_TIME
638#define blk_queue_rq_alloc_time(q) \
639 test_bit(QUEUE_FLAG_RQ_ALLOC_TIME, &(q)->queue_flags)
640#else
641#define blk_queue_rq_alloc_time(q) false
642#endif
1da177e4 643
33659ebb
CH
644#define blk_noretry_request(rq) \
645 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
646 REQ_FAILFAST_DRIVER))
f4560ffe 647#define blk_queue_quiesced(q) test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
cd84a62e 648#define blk_queue_pm_only(q) atomic_read(&(q)->pm_only)
0ce91444 649#define blk_queue_fua(q) test_bit(QUEUE_FLAG_FUA, &(q)->queue_flags)
58c898ba 650#define blk_queue_registered(q) test_bit(QUEUE_FLAG_REGISTERED, &(q)->queue_flags)
c9254f2d 651
cd84a62e
BVA
652extern void blk_set_pm_only(struct request_queue *q);
653extern void blk_clear_pm_only(struct request_queue *q);
33659ebb 654
57292b58
CH
655static inline bool blk_account_rq(struct request *rq)
656{
657 return (rq->rq_flags & RQF_STARTED) && !blk_rq_is_passthrough(rq);
658}
33659ebb 659
1da177e4
LT
660#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
661
4e1b2d52 662#define rq_data_dir(rq) (op_is_write(req_op(rq)) ? WRITE : READ)
1da177e4 663
9d9de535
CH
664#define rq_dma_dir(rq) \
665 (op_is_write(req_op(rq)) ? DMA_TO_DEVICE : DMA_FROM_DEVICE)
666
3ab3a031
CH
667#define dma_map_bvec(dev, bv, dir, attrs) \
668 dma_map_page_attrs(dev, (bv)->bv_page, (bv)->bv_offset, (bv)->bv_len, \
669 (dir), (attrs))
670
344e9ffc 671static inline bool queue_is_mq(struct request_queue *q)
49fd524f 672{
a1ce35fa 673 return q->mq_ops;
49fd524f
JA
674}
675
797476b8
DLM
676static inline enum blk_zoned_model
677blk_queue_zoned_model(struct request_queue *q)
678{
679 return q->limits.zoned;
680}
681
682static inline bool blk_queue_is_zoned(struct request_queue *q)
683{
684 switch (blk_queue_zoned_model(q)) {
685 case BLK_ZONED_HA:
686 case BLK_ZONED_HM:
687 return true;
688 default:
689 return false;
690 }
691}
692
113ab72e 693static inline sector_t blk_queue_zone_sectors(struct request_queue *q)
6a0cb1bc
HR
694{
695 return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
696}
697
6a5ac984 698#ifdef CONFIG_BLK_DEV_ZONED
965b652e
DLM
699static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
700{
701 return blk_queue_is_zoned(q) ? q->nr_zones : 0;
702}
703
6cc77e9c
CH
704static inline unsigned int blk_queue_zone_no(struct request_queue *q,
705 sector_t sector)
706{
707 if (!blk_queue_is_zoned(q))
708 return 0;
709 return sector >> ilog2(q->limits.chunk_sectors);
710}
711
712static inline bool blk_queue_zone_is_seq(struct request_queue *q,
713 sector_t sector)
714{
f216fdd7 715 if (!blk_queue_is_zoned(q))
6cc77e9c 716 return false;
f216fdd7
CH
717 if (!q->conv_zones_bitmap)
718 return true;
719 return !test_bit(blk_queue_zone_no(q, sector), q->conv_zones_bitmap);
6cc77e9c 720}
965b652e
DLM
721#else /* CONFIG_BLK_DEV_ZONED */
722static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
723{
724 return 0;
725}
02992df8
JT
726static inline bool blk_queue_zone_is_seq(struct request_queue *q,
727 sector_t sector)
728{
729 return false;
730}
731static inline unsigned int blk_queue_zone_no(struct request_queue *q,
732 sector_t sector)
733{
734 return 0;
735}
6a5ac984 736#endif /* CONFIG_BLK_DEV_ZONED */
6cc77e9c 737
1faa16d2
JA
738static inline bool rq_is_sync(struct request *rq)
739{
ef295ecf 740 return op_is_sync(rq->cmd_flags);
1faa16d2
JA
741}
742
e2a60da7
MP
743static inline bool rq_mergeable(struct request *rq)
744{
57292b58 745 if (blk_rq_is_passthrough(rq))
e2a60da7 746 return false;
1da177e4 747
3a5e02ce
MC
748 if (req_op(rq) == REQ_OP_FLUSH)
749 return false;
750
a6f0788e
CK
751 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
752 return false;
753
0512a75b
KB
754 if (req_op(rq) == REQ_OP_ZONE_APPEND)
755 return false;
756
e2a60da7 757 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
e8064021
CH
758 return false;
759 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
e2a60da7
MP
760 return false;
761
762 return true;
763}
1da177e4 764
4363ac7c
MP
765static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
766{
efbeccdb
CH
767 if (bio_page(a) == bio_page(b) &&
768 bio_offset(a) == bio_offset(b))
4363ac7c
MP
769 return true;
770
771 return false;
772}
773
d278d4a8
JA
774static inline unsigned int blk_queue_depth(struct request_queue *q)
775{
776 if (q->queue_depth)
777 return q->queue_depth;
778
779 return q->nr_requests;
780}
781
1da177e4
LT
782extern unsigned long blk_max_low_pfn, blk_max_pfn;
783
784/*
785 * standard bounce addresses:
786 *
787 * BLK_BOUNCE_HIGH : bounce all highmem pages
788 * BLK_BOUNCE_ANY : don't bounce anything
789 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
790 */
2472892a
AK
791
792#if BITS_PER_LONG == 32
1da177e4 793#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
2472892a
AK
794#else
795#define BLK_BOUNCE_HIGH -1ULL
796#endif
797#define BLK_BOUNCE_ANY (-1ULL)
bfe17231 798#define BLK_BOUNCE_ISA (DMA_BIT_MASK(24))
1da177e4 799
3d6392cf
JA
800/*
801 * default timeout for SG_IO if none specified
802 */
803#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
f2f1fa78 804#define BLK_MIN_SG_TIMEOUT (7 * HZ)
3d6392cf 805
152e283f
FT
806struct rq_map_data {
807 struct page **pages;
808 int page_order;
809 int nr_entries;
56c451f4 810 unsigned long offset;
97ae77a1 811 int null_mapped;
ecb554a8 812 int from_user;
152e283f
FT
813};
814
5705f702 815struct req_iterator {
7988613b 816 struct bvec_iter iter;
5705f702
N
817 struct bio *bio;
818};
819
820/* This should not be used directly - use rq_for_each_segment */
1e428079
JA
821#define for_each_bio(_bio) \
822 for (; _bio; _bio = _bio->bi_next)
5705f702 823#define __rq_for_each_bio(_bio, rq) \
1da177e4
LT
824 if ((rq->bio)) \
825 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
826
5705f702
N
827#define rq_for_each_segment(bvl, _rq, _iter) \
828 __rq_for_each_bio(_iter.bio, _rq) \
7988613b 829 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
5705f702 830
d18d9174
ML
831#define rq_for_each_bvec(bvl, _rq, _iter) \
832 __rq_for_each_bio(_iter.bio, _rq) \
833 bio_for_each_bvec(bvl, _iter.bio, _iter.iter)
834
4550dd6c 835#define rq_iter_last(bvec, _iter) \
7988613b 836 (_iter.bio->bi_next == NULL && \
4550dd6c 837 bio_iter_last(bvec, _iter.iter))
5705f702 838
2d4dc890
IL
839#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
840# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
841#endif
842#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
843extern void rq_flush_dcache_pages(struct request *rq);
844#else
845static inline void rq_flush_dcache_pages(struct request *rq)
846{
847}
848#endif
849
1da177e4
LT
850extern int blk_register_queue(struct gendisk *disk);
851extern void blk_unregister_queue(struct gendisk *disk);
dece1635 852extern blk_qc_t generic_make_request(struct bio *bio);
f421e1d9 853extern blk_qc_t direct_make_request(struct bio *bio);
2a4aa30c 854extern void blk_rq_init(struct request_queue *q, struct request *rq);
1da177e4 855extern void blk_put_request(struct request *);
cd6ce148 856extern struct request *blk_get_request(struct request_queue *, unsigned int op,
ff005a06 857 blk_mq_req_flags_t flags);
ef9e3fac 858extern int blk_lld_busy(struct request_queue *q);
78d8e58a
MS
859extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
860 struct bio_set *bs, gfp_t gfp_mask,
861 int (*bio_ctr)(struct bio *, struct bio *, void *),
862 void *data);
863extern void blk_rq_unprep_clone(struct request *rq);
2a842aca 864extern blk_status_t blk_insert_cloned_request(struct request_queue *q,
82124d60 865 struct request *rq);
0abc2a10 866extern int blk_rq_append_bio(struct request *rq, struct bio **bio);
af67c31f 867extern void blk_queue_split(struct request_queue *, struct bio **);
0bfc96cb 868extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
577ebb37
PB
869extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
870 unsigned int, void __user *);
74f3c8af
AV
871extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
872 unsigned int, void __user *);
e915e872
AV
873extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
874 struct scsi_ioctl_command __user *);
98aaaec4
AB
875extern int get_sg_io_hdr(struct sg_io_hdr *hdr, const void __user *argp);
876extern int put_sg_io_hdr(const struct sg_io_hdr *hdr, void __user *argp);
3fcfab16 877
9a95e4ef 878extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
2e6edc95 879extern void blk_queue_exit(struct request_queue *q);
1da177e4 880extern void blk_sync_queue(struct request_queue *q);
a3bce90e 881extern int blk_rq_map_user(struct request_queue *, struct request *,
152e283f
FT
882 struct rq_map_data *, void __user *, unsigned long,
883 gfp_t);
8e5cfc45 884extern int blk_rq_unmap_user(struct bio *);
165125e1
JA
885extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
886extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
26e49cfc
KO
887 struct rq_map_data *, const struct iov_iter *,
888 gfp_t);
b7819b92 889extern void blk_execute_rq(struct request_queue *, struct gendisk *,
994ca9a1 890 struct request *, int);
165125e1 891extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
15fc858a 892 struct request *, int, rq_end_io_fn *);
6e39b69e 893
e47bc4ed
CK
894/* Helper to convert REQ_OP_XXX to its string format XXX */
895extern const char *blk_op_str(unsigned int op);
896
2a842aca
CH
897int blk_status_to_errno(blk_status_t status);
898blk_status_t errno_to_blk_status(int errno);
899
0a1b8b87 900int blk_poll(struct request_queue *q, blk_qc_t cookie, bool spin);
05229bee 901
165125e1 902static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
1da177e4 903{
ff9ea323 904 return bdev->bd_disk->queue; /* this is never NULL */
1da177e4
LT
905}
906
233bde21
BVA
907/*
908 * The basic unit of block I/O is a sector. It is used in a number of contexts
909 * in Linux (blk, bio, genhd). The size of one sector is 512 = 2**9
910 * bytes. Variables of type sector_t represent an offset or size that is a
911 * multiple of 512 bytes. Hence these two constants.
912 */
913#ifndef SECTOR_SHIFT
914#define SECTOR_SHIFT 9
915#endif
916#ifndef SECTOR_SIZE
917#define SECTOR_SIZE (1 << SECTOR_SHIFT)
918#endif
919
5efccd17 920/*
80a761fd
TH
921 * blk_rq_pos() : the current sector
922 * blk_rq_bytes() : bytes left in the entire request
923 * blk_rq_cur_bytes() : bytes left in the current segment
924 * blk_rq_err_bytes() : bytes left till the next error boundary
925 * blk_rq_sectors() : sectors left in the entire request
926 * blk_rq_cur_sectors() : sectors left in the current segment
3d244306 927 * blk_rq_stats_sectors() : sectors of the entire request used for stats
5efccd17 928 */
5b93629b
TH
929static inline sector_t blk_rq_pos(const struct request *rq)
930{
a2dec7b3 931 return rq->__sector;
2e46e8b2
TH
932}
933
934static inline unsigned int blk_rq_bytes(const struct request *rq)
935{
a2dec7b3 936 return rq->__data_len;
5b93629b
TH
937}
938
2e46e8b2
TH
939static inline int blk_rq_cur_bytes(const struct request *rq)
940{
941 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
942}
5efccd17 943
80a761fd
TH
944extern unsigned int blk_rq_err_bytes(const struct request *rq);
945
5b93629b
TH
946static inline unsigned int blk_rq_sectors(const struct request *rq)
947{
233bde21 948 return blk_rq_bytes(rq) >> SECTOR_SHIFT;
5b93629b
TH
949}
950
951static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
952{
233bde21 953 return blk_rq_cur_bytes(rq) >> SECTOR_SHIFT;
5b93629b
TH
954}
955
3d244306
HT
956static inline unsigned int blk_rq_stats_sectors(const struct request *rq)
957{
958 return rq->stats_sectors;
959}
960
6a5ac984 961#ifdef CONFIG_BLK_DEV_ZONED
02694e86
CK
962
963/* Helper to convert BLK_ZONE_ZONE_XXX to its string format XXX */
964const char *blk_zone_cond_str(enum blk_zone_cond zone_cond);
965
6cc77e9c
CH
966static inline unsigned int blk_rq_zone_no(struct request *rq)
967{
968 return blk_queue_zone_no(rq->q, blk_rq_pos(rq));
969}
970
971static inline unsigned int blk_rq_zone_is_seq(struct request *rq)
972{
973 return blk_queue_zone_is_seq(rq->q, blk_rq_pos(rq));
974}
6a5ac984 975#endif /* CONFIG_BLK_DEV_ZONED */
6cc77e9c 976
2e3258ec
CH
977/*
978 * Some commands like WRITE SAME have a payload or data transfer size which
979 * is different from the size of the request. Any driver that supports such
980 * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
981 * calculate the data transfer size.
982 */
983static inline unsigned int blk_rq_payload_bytes(struct request *rq)
984{
985 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
986 return rq->special_vec.bv_len;
987 return blk_rq_bytes(rq);
988}
989
3aef3cae
CH
990/*
991 * Return the first full biovec in the request. The caller needs to check that
992 * there are any bvecs before calling this helper.
993 */
994static inline struct bio_vec req_bvec(struct request *rq)
995{
996 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
997 return rq->special_vec;
998 return mp_bvec_iter_bvec(rq->bio->bi_io_vec, rq->bio->bi_iter);
999}
1000
f31dc1cd 1001static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
8fe0d473 1002 int op)
f31dc1cd 1003{
7afafc8a 1004 if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
233bde21
BVA
1005 return min(q->limits.max_discard_sectors,
1006 UINT_MAX >> SECTOR_SHIFT);
f31dc1cd 1007
8fe0d473 1008 if (unlikely(op == REQ_OP_WRITE_SAME))
4363ac7c
MP
1009 return q->limits.max_write_same_sectors;
1010
a6f0788e
CK
1011 if (unlikely(op == REQ_OP_WRITE_ZEROES))
1012 return q->limits.max_write_zeroes_sectors;
1013
f31dc1cd
MP
1014 return q->limits.max_sectors;
1015}
1016
762380ad
JA
1017/*
1018 * Return maximum size of a request at given offset. Only valid for
1019 * file system requests.
1020 */
1021static inline unsigned int blk_max_size_offset(struct request_queue *q,
1022 sector_t offset)
1023{
1024 if (!q->limits.chunk_sectors)
736ed4de 1025 return q->limits.max_sectors;
762380ad 1026
15bfd21f
KB
1027 return min(q->limits.max_sectors, (unsigned int)(q->limits.chunk_sectors -
1028 (offset & (q->limits.chunk_sectors - 1))));
762380ad
JA
1029}
1030
17007f39
DLM
1031static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
1032 sector_t offset)
f31dc1cd
MP
1033{
1034 struct request_queue *q = rq->q;
1035
57292b58 1036 if (blk_rq_is_passthrough(rq))
f31dc1cd
MP
1037 return q->limits.max_hw_sectors;
1038
7afafc8a
AH
1039 if (!q->limits.chunk_sectors ||
1040 req_op(rq) == REQ_OP_DISCARD ||
1041 req_op(rq) == REQ_OP_SECURE_ERASE)
8fe0d473 1042 return blk_queue_get_max_sectors(q, req_op(rq));
762380ad 1043
17007f39 1044 return min(blk_max_size_offset(q, offset),
8fe0d473 1045 blk_queue_get_max_sectors(q, req_op(rq)));
f31dc1cd
MP
1046}
1047
75afb352
JN
1048static inline unsigned int blk_rq_count_bios(struct request *rq)
1049{
1050 unsigned int nr_bios = 0;
1051 struct bio *bio;
1052
1053 __rq_for_each_bio(bio, rq)
1054 nr_bios++;
1055
1056 return nr_bios;
1057}
1058
ef71de8b
CH
1059void blk_steal_bios(struct bio_list *list, struct request *rq);
1060
1da177e4 1061/*
2e60e022
TH
1062 * Request completion related functions.
1063 *
1064 * blk_update_request() completes given number of bytes and updates
1065 * the request without completing it.
1da177e4 1066 */
2a842aca 1067extern bool blk_update_request(struct request *rq, blk_status_t error,
2e60e022 1068 unsigned int nr_bytes);
2e60e022 1069
242f9dcb
JA
1070extern void __blk_complete_request(struct request *);
1071extern void blk_abort_request(struct request *);
ff856bad 1072
1da177e4
LT
1073/*
1074 * Access functions for manipulating queue properties
1075 */
165125e1 1076extern void blk_cleanup_queue(struct request_queue *);
165125e1 1077extern void blk_queue_bounce_limit(struct request_queue *, u64);
086fa5ff 1078extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
762380ad 1079extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
8a78362c 1080extern void blk_queue_max_segments(struct request_queue *, unsigned short);
1e739730
CH
1081extern void blk_queue_max_discard_segments(struct request_queue *,
1082 unsigned short);
165125e1 1083extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
67efc925
CH
1084extern void blk_queue_max_discard_sectors(struct request_queue *q,
1085 unsigned int max_discard_sectors);
4363ac7c
MP
1086extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1087 unsigned int max_write_same_sectors);
a6f0788e
CK
1088extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1089 unsigned int max_write_same_sectors);
ad6bf88a 1090extern void blk_queue_logical_block_size(struct request_queue *, unsigned int);
0512a75b
KB
1091extern void blk_queue_max_zone_append_sectors(struct request_queue *q,
1092 unsigned int max_zone_append_sectors);
892b6f90 1093extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
c72758f3
MP
1094extern void blk_queue_alignment_offset(struct request_queue *q,
1095 unsigned int alignment);
7c958e32 1096extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
c72758f3 1097extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
3c5820c7 1098extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
c72758f3 1099extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
d278d4a8 1100extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
e475bba2 1101extern void blk_set_default_limits(struct queue_limits *lim);
b1bd055d 1102extern void blk_set_stacking_limits(struct queue_limits *lim);
c72758f3
MP
1103extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1104 sector_t offset);
17be8c24
MP
1105extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1106 sector_t offset);
c72758f3
MP
1107extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1108 sector_t offset);
165125e1 1109extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
27f8221a 1110extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
165125e1 1111extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
03100aad 1112extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
165125e1 1113extern void blk_queue_dma_alignment(struct request_queue *, int);
11c3e689 1114extern void blk_queue_update_dma_alignment(struct request_queue *, int);
242f9dcb 1115extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
93e9d8e8 1116extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
68c43f13
DLM
1117extern void blk_queue_required_elevator_features(struct request_queue *q,
1118 unsigned int features);
45147fb5
YS
1119extern bool blk_queue_can_use_dma_map_merging(struct request_queue *q,
1120 struct device *dev);
1da177e4 1121
1e739730
CH
1122/*
1123 * Number of physical segments as sent to the device.
1124 *
1125 * Normally this is the number of discontiguous data segments sent by the
1126 * submitter. But for data-less command like discard we might have no
1127 * actual data segments submitted, but the driver might have to add it's
1128 * own special payload. In that case we still return 1 here so that this
1129 * special payload will be mapped.
1130 */
f9d03f96
CH
1131static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1132{
1133 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1134 return 1;
1135 return rq->nr_phys_segments;
1136}
1137
1e739730
CH
1138/*
1139 * Number of discard segments (or ranges) the driver needs to fill in.
1140 * Each discard bio merged into a request is counted as one segment.
1141 */
1142static inline unsigned short blk_rq_nr_discard_segments(struct request *rq)
1143{
1144 return max_t(unsigned short, rq->nr_phys_segments, 1);
1145}
1146
89de1504
CH
1147int __blk_rq_map_sg(struct request_queue *q, struct request *rq,
1148 struct scatterlist *sglist, struct scatterlist **last_sg);
1149static inline int blk_rq_map_sg(struct request_queue *q, struct request *rq,
1150 struct scatterlist *sglist)
1151{
1152 struct scatterlist *last_sg = NULL;
1153
1154 return __blk_rq_map_sg(q, rq, sglist, &last_sg);
1155}
1da177e4 1156extern void blk_dump_rq_flags(struct request *, char *);
1da177e4 1157extern long nr_blockdev_pages(void);
1da177e4 1158
09ac46c4 1159bool __must_check blk_get_queue(struct request_queue *);
3d745ea5 1160struct request_queue *blk_alloc_queue(make_request_fn make_request, int node_id);
165125e1 1161extern void blk_put_queue(struct request_queue *);
3f21c265 1162extern void blk_set_queue_dying(struct request_queue *);
1da177e4 1163
316cc67d 1164/*
75df7136
SJ
1165 * blk_plug permits building a queue of related requests by holding the I/O
1166 * fragments for a short period. This allows merging of sequential requests
1167 * into single larger request. As the requests are moved from a per-task list to
1168 * the device's request_queue in a batch, this results in improved scalability
1169 * as the lock contention for request_queue lock is reduced.
1170 *
1171 * It is ok not to disable preemption when adding the request to the plug list
1172 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1173 * the plug list when the task sleeps by itself. For details, please see
1174 * schedule() where blk_schedule_flush_plug() is called.
316cc67d 1175 */
73c10101 1176struct blk_plug {
320ae51f 1177 struct list_head mq_list; /* blk-mq requests */
75df7136 1178 struct list_head cb_list; /* md requires an unplug callback */
5f0ed774 1179 unsigned short rq_count;
ce5b009c 1180 bool multiple_queues;
73c10101 1181};
55c022bb 1182#define BLK_MAX_REQUEST_COUNT 16
50d24c34 1183#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
55c022bb 1184
9cbb1750 1185struct blk_plug_cb;
74018dc3 1186typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
048c9374
N
1187struct blk_plug_cb {
1188 struct list_head list;
9cbb1750
N
1189 blk_plug_cb_fn callback;
1190 void *data;
048c9374 1191};
9cbb1750
N
1192extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1193 void *data, int size);
73c10101
JA
1194extern void blk_start_plug(struct blk_plug *);
1195extern void blk_finish_plug(struct blk_plug *);
f6603783 1196extern void blk_flush_plug_list(struct blk_plug *, bool);
73c10101
JA
1197
1198static inline void blk_flush_plug(struct task_struct *tsk)
1199{
1200 struct blk_plug *plug = tsk->plug;
1201
a237c1c5
JA
1202 if (plug)
1203 blk_flush_plug_list(plug, false);
1204}
1205
1206static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1207{
1208 struct blk_plug *plug = tsk->plug;
1209
88b996cd 1210 if (plug)
f6603783 1211 blk_flush_plug_list(plug, true);
73c10101
JA
1212}
1213
1214static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1215{
1216 struct blk_plug *plug = tsk->plug;
1217
320ae51f 1218 return plug &&
a1ce35fa 1219 (!list_empty(&plug->mq_list) ||
320ae51f 1220 !list_empty(&plug->cb_list));
73c10101
JA
1221}
1222
71ac860a
ML
1223extern void blk_io_schedule(void);
1224
ee472d83
CH
1225extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
1226extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1227 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
e950fdf7
CH
1228
1229#define BLKDEV_DISCARD_SECURE (1 << 0) /* issue a secure erase */
dd3932ed 1230
fbd9b09a
DM
1231extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1232 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
38f25255 1233extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
288dab8a 1234 sector_t nr_sects, gfp_t gfp_mask, int flags,
469e3216 1235 struct bio **biop);
ee472d83
CH
1236
1237#define BLKDEV_ZERO_NOUNMAP (1 << 0) /* do not free blocks */
cb365b96 1238#define BLKDEV_ZERO_NOFALLBACK (1 << 1) /* don't write explicit zeroes */
ee472d83 1239
e73c23ff
CK
1240extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1241 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
ee472d83 1242 unsigned flags);
3f14d792 1243extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
ee472d83
CH
1244 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1245
2cf6d26a
CH
1246static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1247 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
fb2dce86 1248{
233bde21
BVA
1249 return blkdev_issue_discard(sb->s_bdev,
1250 block << (sb->s_blocksize_bits -
1251 SECTOR_SHIFT),
1252 nr_blocks << (sb->s_blocksize_bits -
1253 SECTOR_SHIFT),
2cf6d26a 1254 gfp_mask, flags);
fb2dce86 1255}
e6fa0be6 1256static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
a107e5a3 1257 sector_t nr_blocks, gfp_t gfp_mask)
e6fa0be6
LC
1258{
1259 return blkdev_issue_zeroout(sb->s_bdev,
233bde21
BVA
1260 block << (sb->s_blocksize_bits -
1261 SECTOR_SHIFT),
1262 nr_blocks << (sb->s_blocksize_bits -
1263 SECTOR_SHIFT),
ee472d83 1264 gfp_mask, 0);
e6fa0be6 1265}
1da177e4 1266
f00c4d80 1267extern int blk_verify_command(unsigned char *cmd, fmode_t mode);
0b07de85 1268
eb28d31b
MP
1269enum blk_default_limits {
1270 BLK_MAX_SEGMENTS = 128,
1271 BLK_SAFE_MAX_SECTORS = 255,
d2be537c 1272 BLK_DEF_MAX_SECTORS = 2560,
eb28d31b
MP
1273 BLK_MAX_SEGMENT_SIZE = 65536,
1274 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1275};
0e435ac2 1276
af2c68fe 1277static inline unsigned long queue_segment_boundary(const struct request_queue *q)
ae03bf63 1278{
025146e1 1279 return q->limits.seg_boundary_mask;
ae03bf63
MP
1280}
1281
af2c68fe 1282static inline unsigned long queue_virt_boundary(const struct request_queue *q)
03100aad
KB
1283{
1284 return q->limits.virt_boundary_mask;
1285}
1286
af2c68fe 1287static inline unsigned int queue_max_sectors(const struct request_queue *q)
ae03bf63 1288{
025146e1 1289 return q->limits.max_sectors;
ae03bf63
MP
1290}
1291
af2c68fe 1292static inline unsigned int queue_max_hw_sectors(const struct request_queue *q)
ae03bf63 1293{
025146e1 1294 return q->limits.max_hw_sectors;
ae03bf63
MP
1295}
1296
af2c68fe 1297static inline unsigned short queue_max_segments(const struct request_queue *q)
ae03bf63 1298{
8a78362c 1299 return q->limits.max_segments;
ae03bf63
MP
1300}
1301
af2c68fe 1302static inline unsigned short queue_max_discard_segments(const struct request_queue *q)
1e739730
CH
1303{
1304 return q->limits.max_discard_segments;
1305}
1306
af2c68fe 1307static inline unsigned int queue_max_segment_size(const struct request_queue *q)
ae03bf63 1308{
025146e1 1309 return q->limits.max_segment_size;
ae03bf63
MP
1310}
1311
0512a75b
KB
1312static inline unsigned int queue_max_zone_append_sectors(const struct request_queue *q)
1313{
1314 return q->limits.max_zone_append_sectors;
1315}
1316
ad6bf88a 1317static inline unsigned queue_logical_block_size(const struct request_queue *q)
1da177e4
LT
1318{
1319 int retval = 512;
1320
025146e1
MP
1321 if (q && q->limits.logical_block_size)
1322 retval = q->limits.logical_block_size;
1da177e4
LT
1323
1324 return retval;
1325}
1326
ad6bf88a 1327static inline unsigned int bdev_logical_block_size(struct block_device *bdev)
1da177e4 1328{
e1defc4f 1329 return queue_logical_block_size(bdev_get_queue(bdev));
1da177e4
LT
1330}
1331
af2c68fe 1332static inline unsigned int queue_physical_block_size(const struct request_queue *q)
c72758f3
MP
1333{
1334 return q->limits.physical_block_size;
1335}
1336
892b6f90 1337static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
ac481c20
MP
1338{
1339 return queue_physical_block_size(bdev_get_queue(bdev));
1340}
1341
af2c68fe 1342static inline unsigned int queue_io_min(const struct request_queue *q)
c72758f3
MP
1343{
1344 return q->limits.io_min;
1345}
1346
ac481c20
MP
1347static inline int bdev_io_min(struct block_device *bdev)
1348{
1349 return queue_io_min(bdev_get_queue(bdev));
1350}
1351
af2c68fe 1352static inline unsigned int queue_io_opt(const struct request_queue *q)
c72758f3
MP
1353{
1354 return q->limits.io_opt;
1355}
1356
ac481c20
MP
1357static inline int bdev_io_opt(struct block_device *bdev)
1358{
1359 return queue_io_opt(bdev_get_queue(bdev));
1360}
1361
af2c68fe 1362static inline int queue_alignment_offset(const struct request_queue *q)
c72758f3 1363{
ac481c20 1364 if (q->limits.misaligned)
c72758f3
MP
1365 return -1;
1366
ac481c20 1367 return q->limits.alignment_offset;
c72758f3
MP
1368}
1369
e03a72e1 1370static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
81744ee4
MP
1371{
1372 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
233bde21
BVA
1373 unsigned int alignment = sector_div(sector, granularity >> SECTOR_SHIFT)
1374 << SECTOR_SHIFT;
81744ee4 1375
b8839b8c 1376 return (granularity + lim->alignment_offset - alignment) % granularity;
c72758f3
MP
1377}
1378
ac481c20
MP
1379static inline int bdev_alignment_offset(struct block_device *bdev)
1380{
1381 struct request_queue *q = bdev_get_queue(bdev);
1382
1383 if (q->limits.misaligned)
1384 return -1;
1385
1386 if (bdev != bdev->bd_contains)
1387 return bdev->bd_part->alignment_offset;
1388
1389 return q->limits.alignment_offset;
1390}
1391
af2c68fe 1392static inline int queue_discard_alignment(const struct request_queue *q)
86b37281
MP
1393{
1394 if (q->limits.discard_misaligned)
1395 return -1;
1396
1397 return q->limits.discard_alignment;
1398}
1399
e03a72e1 1400static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
86b37281 1401{
59771079 1402 unsigned int alignment, granularity, offset;
dd3d145d 1403
a934a00a
MP
1404 if (!lim->max_discard_sectors)
1405 return 0;
1406
59771079 1407 /* Why are these in bytes, not sectors? */
233bde21
BVA
1408 alignment = lim->discard_alignment >> SECTOR_SHIFT;
1409 granularity = lim->discard_granularity >> SECTOR_SHIFT;
59771079
LT
1410 if (!granularity)
1411 return 0;
1412
1413 /* Offset of the partition start in 'granularity' sectors */
1414 offset = sector_div(sector, granularity);
1415
1416 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1417 offset = (granularity + alignment - offset) % granularity;
1418
1419 /* Turn it back into bytes, gaah */
233bde21 1420 return offset << SECTOR_SHIFT;
86b37281
MP
1421}
1422
c6e66634
PB
1423static inline int bdev_discard_alignment(struct block_device *bdev)
1424{
1425 struct request_queue *q = bdev_get_queue(bdev);
1426
1427 if (bdev != bdev->bd_contains)
1428 return bdev->bd_part->discard_alignment;
1429
1430 return q->limits.discard_alignment;
1431}
1432
4363ac7c
MP
1433static inline unsigned int bdev_write_same(struct block_device *bdev)
1434{
1435 struct request_queue *q = bdev_get_queue(bdev);
1436
1437 if (q)
1438 return q->limits.max_write_same_sectors;
1439
1440 return 0;
1441}
1442
a6f0788e
CK
1443static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1444{
1445 struct request_queue *q = bdev_get_queue(bdev);
1446
1447 if (q)
1448 return q->limits.max_write_zeroes_sectors;
1449
1450 return 0;
1451}
1452
797476b8
DLM
1453static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1454{
1455 struct request_queue *q = bdev_get_queue(bdev);
1456
1457 if (q)
1458 return blk_queue_zoned_model(q);
1459
1460 return BLK_ZONED_NONE;
1461}
1462
1463static inline bool bdev_is_zoned(struct block_device *bdev)
1464{
1465 struct request_queue *q = bdev_get_queue(bdev);
1466
1467 if (q)
1468 return blk_queue_is_zoned(q);
1469
1470 return false;
1471}
1472
113ab72e 1473static inline sector_t bdev_zone_sectors(struct block_device *bdev)
6a0cb1bc
HR
1474{
1475 struct request_queue *q = bdev_get_queue(bdev);
1476
1477 if (q)
f99e8648 1478 return blk_queue_zone_sectors(q);
6cc77e9c
CH
1479 return 0;
1480}
6a0cb1bc 1481
af2c68fe 1482static inline int queue_dma_alignment(const struct request_queue *q)
1da177e4 1483{
482eb689 1484 return q ? q->dma_alignment : 511;
1da177e4
LT
1485}
1486
14417799 1487static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
87904074
FT
1488 unsigned int len)
1489{
1490 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
14417799 1491 return !(addr & alignment) && !(len & alignment);
87904074
FT
1492}
1493
1da177e4
LT
1494/* assumes size > 256 */
1495static inline unsigned int blksize_bits(unsigned int size)
1496{
1497 unsigned int bits = 8;
1498 do {
1499 bits++;
1500 size >>= 1;
1501 } while (size > 256);
1502 return bits;
1503}
1504
2befb9e3 1505static inline unsigned int block_size(struct block_device *bdev)
1da177e4
LT
1506{
1507 return bdev->bd_block_size;
1508}
1509
59c3d45e 1510int kblockd_schedule_work(struct work_struct *work);
818cd1cb 1511int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1da177e4 1512
1da177e4
LT
1513#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1514 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1515#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1516 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1517
7ba1ba12
MP
1518#if defined(CONFIG_BLK_DEV_INTEGRITY)
1519
8288f496
MP
1520enum blk_integrity_flags {
1521 BLK_INTEGRITY_VERIFY = 1 << 0,
1522 BLK_INTEGRITY_GENERATE = 1 << 1,
3aec2f41 1523 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
aae7df50 1524 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
8288f496 1525};
7ba1ba12 1526
18593088 1527struct blk_integrity_iter {
7ba1ba12
MP
1528 void *prot_buf;
1529 void *data_buf;
3be91c4a 1530 sector_t seed;
7ba1ba12 1531 unsigned int data_size;
3be91c4a 1532 unsigned short interval;
7ba1ba12
MP
1533 const char *disk_name;
1534};
1535
4e4cbee9 1536typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
54d4e6ab
MG
1537typedef void (integrity_prepare_fn) (struct request *);
1538typedef void (integrity_complete_fn) (struct request *, unsigned int);
7ba1ba12 1539
0f8087ec
MP
1540struct blk_integrity_profile {
1541 integrity_processing_fn *generate_fn;
1542 integrity_processing_fn *verify_fn;
54d4e6ab
MG
1543 integrity_prepare_fn *prepare_fn;
1544 integrity_complete_fn *complete_fn;
0f8087ec
MP
1545 const char *name;
1546};
7ba1ba12 1547
25520d55 1548extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
7ba1ba12 1549extern void blk_integrity_unregister(struct gendisk *);
ad7fce93 1550extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
13f05c8d
MP
1551extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1552 struct scatterlist *);
1553extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
4eaf99be
MP
1554extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1555 struct request *);
1556extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1557 struct bio *);
7ba1ba12 1558
25520d55 1559static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
b04accc4 1560{
ac6fc48c 1561 struct blk_integrity *bi = &disk->queue->integrity;
25520d55
MP
1562
1563 if (!bi->profile)
1564 return NULL;
1565
1566 return bi;
b04accc4
JA
1567}
1568
25520d55
MP
1569static inline
1570struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
b02739b0 1571{
25520d55 1572 return blk_get_integrity(bdev->bd_disk);
b02739b0
MP
1573}
1574
180b2f95 1575static inline bool blk_integrity_rq(struct request *rq)
7ba1ba12 1576{
180b2f95 1577 return rq->cmd_flags & REQ_INTEGRITY;
7ba1ba12
MP
1578}
1579
13f05c8d
MP
1580static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1581 unsigned int segs)
1582{
1583 q->limits.max_integrity_segments = segs;
1584}
1585
1586static inline unsigned short
af2c68fe 1587queue_max_integrity_segments(const struct request_queue *q)
13f05c8d
MP
1588{
1589 return q->limits.max_integrity_segments;
1590}
1591
359f6427
GE
1592/**
1593 * bio_integrity_intervals - Return number of integrity intervals for a bio
1594 * @bi: blk_integrity profile for device
1595 * @sectors: Size of the bio in 512-byte sectors
1596 *
1597 * Description: The block layer calculates everything in 512 byte
1598 * sectors but integrity metadata is done in terms of the data integrity
1599 * interval size of the storage device. Convert the block layer sectors
1600 * to the appropriate number of integrity intervals.
1601 */
1602static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1603 unsigned int sectors)
1604{
1605 return sectors >> (bi->interval_exp - 9);
1606}
1607
1608static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1609 unsigned int sectors)
1610{
1611 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
1612}
1613
2a876f5e
CH
1614/*
1615 * Return the first bvec that contains integrity data. Only drivers that are
1616 * limited to a single integrity segment should use this helper.
1617 */
1618static inline struct bio_vec *rq_integrity_vec(struct request *rq)
1619{
1620 if (WARN_ON_ONCE(queue_max_integrity_segments(rq->q) > 1))
1621 return NULL;
1622 return rq->bio->bi_integrity->bip_vec;
1623}
1624
7ba1ba12
MP
1625#else /* CONFIG_BLK_DEV_INTEGRITY */
1626
fd83240a
SR
1627struct bio;
1628struct block_device;
1629struct gendisk;
1630struct blk_integrity;
1631
1632static inline int blk_integrity_rq(struct request *rq)
1633{
1634 return 0;
1635}
1636static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1637 struct bio *b)
1638{
1639 return 0;
1640}
1641static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1642 struct bio *b,
1643 struct scatterlist *s)
1644{
1645 return 0;
1646}
1647static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1648{
61a04e5b 1649 return NULL;
fd83240a
SR
1650}
1651static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1652{
1653 return NULL;
1654}
1655static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1656{
1657 return 0;
1658}
25520d55 1659static inline void blk_integrity_register(struct gendisk *d,
fd83240a
SR
1660 struct blk_integrity *b)
1661{
fd83240a
SR
1662}
1663static inline void blk_integrity_unregister(struct gendisk *d)
1664{
1665}
1666static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1667 unsigned int segs)
1668{
1669}
af2c68fe 1670static inline unsigned short queue_max_integrity_segments(const struct request_queue *q)
fd83240a
SR
1671{
1672 return 0;
1673}
4eaf99be
MP
1674static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1675 struct request *r1,
1676 struct request *r2)
fd83240a 1677{
cb1a5ab6 1678 return true;
fd83240a 1679}
4eaf99be
MP
1680static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1681 struct request *r,
1682 struct bio *b)
fd83240a 1683{
cb1a5ab6 1684 return true;
fd83240a 1685}
25520d55 1686
359f6427
GE
1687static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1688 unsigned int sectors)
1689{
1690 return 0;
1691}
1692
1693static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1694 unsigned int sectors)
1695{
1696 return 0;
1697}
1698
2a876f5e
CH
1699static inline struct bio_vec *rq_integrity_vec(struct request *rq)
1700{
1701 return NULL;
1702}
1703
7ba1ba12
MP
1704#endif /* CONFIG_BLK_DEV_INTEGRITY */
1705
08f85851 1706struct block_device_operations {
d4430d62 1707 int (*open) (struct block_device *, fmode_t);
db2a144b 1708 void (*release) (struct gendisk *, fmode_t);
3f289dcb 1709 int (*rw_page)(struct block_device *, sector_t, struct page *, unsigned int);
d4430d62
AV
1710 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1711 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
77ea887e
TH
1712 unsigned int (*check_events) (struct gendisk *disk,
1713 unsigned int clearing);
1714 /* ->media_changed() is DEPRECATED, use ->check_events() instead */
08f85851 1715 int (*media_changed) (struct gendisk *);
c3e33e04 1716 void (*unlock_native_capacity) (struct gendisk *);
08f85851
AV
1717 int (*revalidate_disk) (struct gendisk *);
1718 int (*getgeo)(struct block_device *, struct hd_geometry *);
b3a27d05
NG
1719 /* this callback is with swap_lock and sometimes page table lock held */
1720 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
e76239a3 1721 int (*report_zones)(struct gendisk *, sector_t sector,
d4100351 1722 unsigned int nr_zones, report_zones_cb cb, void *data);
348e114b 1723 char *(*devnode)(struct gendisk *disk, umode_t *mode);
08f85851 1724 struct module *owner;
bbd3e064 1725 const struct pr_ops *pr_ops;
08f85851
AV
1726};
1727
ee6a129d
AB
1728#ifdef CONFIG_COMPAT
1729extern int blkdev_compat_ptr_ioctl(struct block_device *, fmode_t,
1730 unsigned int, unsigned long);
1731#else
1732#define blkdev_compat_ptr_ioctl NULL
1733#endif
1734
633a08b8
AV
1735extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1736 unsigned long);
47a191fd
MW
1737extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1738extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1739 struct writeback_control *);
6cc77e9c
CH
1740
1741#ifdef CONFIG_BLK_DEV_ZONED
1742bool blk_req_needs_zone_write_lock(struct request *rq);
1392d370 1743bool blk_req_zone_write_trylock(struct request *rq);
6cc77e9c
CH
1744void __blk_req_zone_write_lock(struct request *rq);
1745void __blk_req_zone_write_unlock(struct request *rq);
1746
1747static inline void blk_req_zone_write_lock(struct request *rq)
1748{
1749 if (blk_req_needs_zone_write_lock(rq))
1750 __blk_req_zone_write_lock(rq);
1751}
1752
1753static inline void blk_req_zone_write_unlock(struct request *rq)
1754{
1755 if (rq->rq_flags & RQF_ZONE_WRITE_LOCKED)
1756 __blk_req_zone_write_unlock(rq);
1757}
1758
1759static inline bool blk_req_zone_is_write_locked(struct request *rq)
1760{
1761 return rq->q->seq_zones_wlock &&
1762 test_bit(blk_rq_zone_no(rq), rq->q->seq_zones_wlock);
1763}
1764
1765static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1766{
1767 if (!blk_req_needs_zone_write_lock(rq))
1768 return true;
1769 return !blk_req_zone_is_write_locked(rq);
1770}
1771#else
1772static inline bool blk_req_needs_zone_write_lock(struct request *rq)
1773{
1774 return false;
1775}
1776
1777static inline void blk_req_zone_write_lock(struct request *rq)
1778{
1779}
1780
1781static inline void blk_req_zone_write_unlock(struct request *rq)
1782{
1783}
1784static inline bool blk_req_zone_is_write_locked(struct request *rq)
1785{
1786 return false;
1787}
1788
1789static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1790{
1791 return true;
1792}
1793#endif /* CONFIG_BLK_DEV_ZONED */
1794
9361401e 1795#else /* CONFIG_BLOCK */
ac13a829
FF
1796
1797struct block_device;
1798
9361401e
DH
1799/*
1800 * stubs for when the block layer is configured out
1801 */
1802#define buffer_heads_over_limit 0
1803
9361401e
DH
1804static inline long nr_blockdev_pages(void)
1805{
1806 return 0;
1807}
1808
1f940bdf
JA
1809struct blk_plug {
1810};
1811
1812static inline void blk_start_plug(struct blk_plug *plug)
73c10101
JA
1813{
1814}
1815
1f940bdf 1816static inline void blk_finish_plug(struct blk_plug *plug)
73c10101
JA
1817{
1818}
1819
1f940bdf 1820static inline void blk_flush_plug(struct task_struct *task)
73c10101
JA
1821{
1822}
1823
a237c1c5
JA
1824static inline void blk_schedule_flush_plug(struct task_struct *task)
1825{
1826}
1827
1828
73c10101
JA
1829static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1830{
1831 return false;
1832}
1833
ac13a829
FF
1834static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
1835 sector_t *error_sector)
1836{
1837 return 0;
1838}
1839
9361401e
DH
1840#endif /* CONFIG_BLOCK */
1841
0619317f
JA
1842static inline void blk_wake_io_task(struct task_struct *waiter)
1843{
1844 /*
1845 * If we're polling, the task itself is doing the completions. For
1846 * that case, we don't need to signal a wakeup, it's enough to just
1847 * mark us as RUNNING.
1848 */
1849 if (waiter == current)
1850 __set_current_state(TASK_RUNNING);
1851 else
1852 wake_up_process(waiter);
1853}
1854
1da177e4 1855#endif