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