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