blob: 73f4f4f1df9275586efc85fb2afd895cb6be6d30 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _LINUX_BLKDEV_H
3#define _LINUX_BLKDEV_H
4
Russell King85fd0bc2012-05-14 08:29:23 +02005#include <linux/sched.h>
Ingo Molnare6017572017-02-01 16:36:40 +01006#include <linux/sched/clock.h>
Russell King85fd0bc2012-05-14 08:29:23 +02007
Jens Axboef5ff8422007-09-21 09:19:54 +02008#ifdef CONFIG_BLOCK
9
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/major.h>
11#include <linux/genhd.h>
12#include <linux/list.h>
Jens Axboe320ae512013-10-24 09:20:05 +010013#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/timer.h>
15#include <linux/workqueue.h>
16#include <linux/pagemap.h>
Tejun Heo66114ca2015-05-22 17:13:32 -040017#include <linux/backing-dev-defs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/wait.h>
19#include <linux/mempool.h>
Dan Williams34c0fd52016-01-15 16:56:14 -080020#include <linux/pfn.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/bio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/stringify.h>
Hugh Dickins3e6053d2008-09-11 10:57:55 +020023#include <linux/gfp.h>
FUJITA Tomonorid351af02007-07-09 12:40:35 +020024#include <linux/bsg.h>
Jens Axboec7c22e42008-09-13 20:26:01 +020025#include <linux/smp.h>
Tejun Heo548bc8e2013-01-09 08:05:13 -080026#include <linux/rcupdate.h>
Tejun Heoadd703f2014-07-01 10:34:38 -060027#include <linux/percpu-refcount.h>
Christoph Hellwig84be4562015-05-01 12:46:15 +020028#include <linux/scatterlist.h>
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +090029#include <linux/blkzoned.h>
Ming Leie6249cd2020-05-03 09:54:22 +080030#include <linux/sched/sysctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Paul Gortmakerde477252011-05-26 13:46:22 -040032struct module;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +010033struct scsi_ioctl_command;
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036struct elevator_queue;
Jens Axboe2056a782006-03-23 20:00:26 +010037struct blk_trace;
Jens Axboe3d6392c2007-07-09 12:38:05 +020038struct request;
39struct sg_io_hdr;
Mike Christieaa387cc2011-07-31 22:05:09 +020040struct bsg_job;
Tejun Heo3c798392012-04-16 13:57:25 -070041struct blkcg_gq;
Ming Lei7c94e1c2014-09-25 23:23:43 +080042struct blk_flush_queue;
Christoph Hellwigbbd3e062015-10-15 14:10:48 +020043struct pr_ops;
Josef Bacika7905042018-07-03 09:32:35 -060044struct rq_qos;
Omar Sandoval34dbad52017-03-21 08:56:08 -070045struct blk_queue_stats;
46struct blk_stat_callback;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48#define BLKDEV_MIN_RQ 4
49#define BLKDEV_MAX_RQ 128 /* Default maximum */
50
Minwoo Im096392e2018-02-15 23:53:17 +090051/* Must be consistent with blk_mq_poll_stats_bkt() */
Stephen Bates02063192017-04-20 16:59:11 -060052#define BLK_MQ_POLL_STATS_BKTS 16
53
Yufen Yu29ece8b2019-03-18 22:44:41 +080054/* Doing classic polling */
55#define BLK_MQ_POLL_CLASSIC -1
56
Tejun Heo8bd435b2012-04-13 13:11:28 -070057/*
58 * Maximum number of blkcg policies allowed to be registered concurrently.
59 * Defined here to simplify include dependency.
60 */
Jens Axboe01c5f852018-09-11 10:59:53 -060061#define BLKCG_MAX_POLS 5
Tejun Heo8bd435b2012-04-13 13:11:28 -070062
Christoph Hellwig2a842ac2017-06-03 09:38:04 +020063typedef void (rq_end_io_fn)(struct request *, blk_status_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Jens Axboe4aff5e22006-08-10 08:44:47 +020065/*
Christoph Hellwige8064022016-10-20 15:12:13 +020066 * request flags */
67typedef __u32 __bitwise req_flags_t;
68
69/* elevator knows about this request */
70#define RQF_SORTED ((__force req_flags_t)(1 << 0))
71/* drive already may have started this one */
72#define RQF_STARTED ((__force req_flags_t)(1 << 1))
Christoph Hellwige8064022016-10-20 15:12:13 +020073/* may not be passed by ioscheduler */
74#define RQF_SOFTBARRIER ((__force req_flags_t)(1 << 3))
75/* request for flush sequence */
76#define RQF_FLUSH_SEQ ((__force req_flags_t)(1 << 4))
77/* merge of different types, fail separately */
78#define RQF_MIXED_MERGE ((__force req_flags_t)(1 << 5))
79/* track inflight for MQ */
80#define RQF_MQ_INFLIGHT ((__force req_flags_t)(1 << 6))
81/* don't call prep for this one */
82#define RQF_DONTPREP ((__force req_flags_t)(1 << 7))
83/* set for "ide_preempt" requests and also for requests for which the SCSI
84 "quiesce" state must be ignored. */
85#define RQF_PREEMPT ((__force req_flags_t)(1 << 8))
Christoph Hellwige8064022016-10-20 15:12:13 +020086/* vaguely specified driver internal error. Ignored by the block layer */
87#define RQF_FAILED ((__force req_flags_t)(1 << 10))
88/* don't warn about errors */
89#define RQF_QUIET ((__force req_flags_t)(1 << 11))
90/* elevator private data attached */
91#define RQF_ELVPRIV ((__force req_flags_t)(1 << 12))
Konstantin Khlebnikov4822e902018-10-11 10:07:06 +030092/* account into disk and partition IO statistics */
Christoph Hellwige8064022016-10-20 15:12:13 +020093#define RQF_IO_STAT ((__force req_flags_t)(1 << 13))
94/* request came from our alloc pool */
95#define RQF_ALLOCED ((__force req_flags_t)(1 << 14))
96/* runtime pm request */
97#define RQF_PM ((__force req_flags_t)(1 << 15))
98/* on IO scheduler merge hash */
99#define RQF_HASHED ((__force req_flags_t)(1 << 16))
Konstantin Khlebnikov4822e902018-10-11 10:07:06 +0300100/* track IO completion time */
Jens Axboecf43e6b2016-11-07 21:32:37 -0700101#define RQF_STATS ((__force req_flags_t)(1 << 17))
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700102/* Look at ->special_vec for the actual data payload instead of the
103 bio chain. */
104#define RQF_SPECIAL_PAYLOAD ((__force req_flags_t)(1 << 18))
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900105/* The per-zone write lock is held for this request */
106#define RQF_ZONE_WRITE_LOCKED ((__force req_flags_t)(1 << 19))
Jens Axboe76a86f92018-01-10 11:30:56 -0700107/* already slept for hybrid poll */
Keith Busch12f5b932018-05-29 15:52:28 +0200108#define RQF_MQ_POLL_SLEPT ((__force req_flags_t)(1 << 20))
Christoph Hellwigda661262018-06-14 13:58:45 +0200109/* ->timeout has been called, don't expire again */
110#define RQF_TIMED_OUT ((__force req_flags_t)(1 << 21))
Christoph Hellwige8064022016-10-20 15:12:13 +0200111
112/* flags that prevent us from merging requests: */
113#define RQF_NOMERGE_FLAGS \
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700114 (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
Christoph Hellwige8064022016-10-20 15:12:13 +0200115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116/*
Keith Busch12f5b932018-05-29 15:52:28 +0200117 * Request state for blk-mq.
118 */
119enum mq_rq_state {
120 MQ_RQ_IDLE = 0,
121 MQ_RQ_IN_FLIGHT = 1,
122 MQ_RQ_COMPLETE = 2,
123};
124
125/*
Christoph Hellwigaf76e552014-05-06 12:12:45 +0200126 * Try to put the fields that are referenced together in the same cacheline.
127 *
128 * If you modify this structure, make sure to update blk_rq_init() and
129 * especially blk_mq_rq_ctx_init() to take care of the added fields.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 */
131struct request {
Jens Axboe165125e2007-07-24 09:28:11 +0200132 struct request_queue *q;
Jens Axboe320ae512013-10-24 09:20:05 +0100133 struct blk_mq_ctx *mq_ctx;
Jens Axboeea4f9952018-10-29 15:06:13 -0600134 struct blk_mq_hw_ctx *mq_hctx;
Jens Axboee6a1c872006-08-10 09:00:21 +0200135
Christoph Hellwigef295ec2016-10-28 08:48:16 -0600136 unsigned int cmd_flags; /* op and common flags */
Christoph Hellwige8064022016-10-20 15:12:13 +0200137 req_flags_t rq_flags;
Jens Axboed486f1f2017-01-31 12:34:41 -0700138
Minwoo Im2f578aa2019-06-09 05:15:51 +0900139 int tag;
Jens Axboed486f1f2017-01-31 12:34:41 -0700140 int internal_tag;
141
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900142 /* the following two fields are internal, NEVER access directly */
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900143 unsigned int __data_len; /* total data len */
Richard Kennedy181fdde2010-03-19 08:58:16 +0100144 sector_t __sector; /* sector cursor */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146 struct bio *bio;
147 struct bio *biotail;
148
Jens Axboe7c3fb702018-01-10 11:46:39 -0700149 struct list_head queuelist;
150
Jens Axboe360f92c2014-04-09 20:27:01 -0600151 /*
152 * The hash is used inside the scheduler, and killed once the
153 * request reaches the dispatch list. The ipi_list is only used
154 * to queue the request for softirq completion, which is long
155 * after the request has been unhashed (and even removed from
156 * the dispatch list).
157 */
158 union {
159 struct hlist_node hash; /* merge hash */
160 struct list_head ipi_list;
161 };
162
Jens Axboee6a1c872006-08-10 09:00:21 +0200163 /*
164 * The rb_node is only used inside the io scheduler, requests
165 * are pruned when moved to the dispatch queue. So let the
Mike Snitzerc1867942011-02-11 11:08:00 +0100166 * completion_data share space with the rb_node.
Jens Axboee6a1c872006-08-10 09:00:21 +0200167 */
168 union {
169 struct rb_node rb_node; /* sort/lookup */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700170 struct bio_vec special_vec;
Mike Snitzerc1867942011-02-11 11:08:00 +0100171 void *completion_data;
Christoph Hellwige26738e2017-04-20 16:03:11 +0200172 int error_count; /* for legacy drivers, don't use */
Jens Axboee6a1c872006-08-10 09:00:21 +0200173 };
Jens Axboe98170642006-07-28 09:23:08 +0200174
Jens Axboeff7d1452006-07-12 14:04:37 +0200175 /*
Vivek Goyal7f1dc8a2010-04-21 17:44:16 +0200176 * Three pointers are available for the IO schedulers, if they need
Mike Snitzerc1867942011-02-11 11:08:00 +0100177 * more they have to dynamically allocate it. Flush requests are
178 * never put on the IO scheduler. So let the flush fields share
Tejun Heoa612fdd2011-12-14 00:33:41 +0100179 * space with the elevator data.
Jens Axboeff7d1452006-07-12 14:04:37 +0200180 */
Mike Snitzerc1867942011-02-11 11:08:00 +0100181 union {
Tejun Heoa612fdd2011-12-14 00:33:41 +0100182 struct {
183 struct io_cq *icq;
184 void *priv[2];
185 } elv;
186
Mike Snitzerc1867942011-02-11 11:08:00 +0100187 struct {
188 unsigned int seq;
189 struct list_head list;
Jeff Moyer4853aba2011-08-15 21:37:25 +0200190 rq_end_io_fn *saved_end_io;
Mike Snitzerc1867942011-02-11 11:08:00 +0100191 } flush;
192 };
Jens Axboeff7d1452006-07-12 14:04:37 +0200193
Jens Axboe8f34ee72006-06-13 09:02:34 +0200194 struct gendisk *rq_disk;
Jerome Marchand09e099d2011-01-05 16:57:38 +0100195 struct hd_struct *part;
Tejun Heo6f816b42019-08-28 15:05:57 -0700196#ifdef CONFIG_BLK_RQ_ALLOC_TIME
197 /* Time that the first bio started allocating this request. */
198 u64 alloc_time_ns;
199#endif
200 /* Time that this request was allocated for this IO. */
Omar Sandoval522a7772018-05-09 02:08:53 -0700201 u64 start_time_ns;
Omar Sandoval544ccc8d2018-05-09 02:08:50 -0700202 /* Time that I/O was submitted to the device. */
203 u64 io_start_time_ns;
204
205#ifdef CONFIG_BLK_WBT
206 unsigned short wbt_flags;
207#endif
Hou Tao3d244302019-05-21 15:59:03 +0800208 /*
209 * rq sectors used for blk stats. It has the same value
210 * with blk_rq_sectors(rq), except that it never be zeroed
211 * by completion.
212 */
213 unsigned short stats_sectors;
Omar Sandoval544ccc8d2018-05-09 02:08:50 -0700214
215 /*
216 * Number of scatter-gather DMA addr+len pairs after
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 * physical address coalescing is performed.
218 */
219 unsigned short nr_phys_segments;
Jens Axboe7c3fb702018-01-10 11:46:39 -0700220
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200221#if defined(CONFIG_BLK_DEV_INTEGRITY)
222 unsigned short nr_integrity_segments;
223#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Jens Axboe7c3fb702018-01-10 11:46:39 -0700225 unsigned short write_hint;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200226 unsigned short ioprio;
227
Keith Busch12f5b932018-05-29 15:52:28 +0200228 enum mq_rq_state state;
229 refcount_t ref;
Tejun Heo1d9bd512018-01-09 08:29:48 -0800230
Jens Axboe0b7576d2018-05-29 08:47:57 -0600231 unsigned int timeout;
Christoph Hellwig079076b2018-11-14 17:02:05 +0100232 unsigned long deadline;
Jens Axboe0a72e7f2018-01-09 14:23:42 -0700233
Jens Axboe7c3fb702018-01-10 11:46:39 -0700234 union {
Linus Torvalds0a4b6e22018-01-29 11:51:49 -0800235 struct __call_single_data csd;
Jens Axboe7c3fb702018-01-10 11:46:39 -0700236 u64 fifo_time;
237 };
238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 /*
Jens Axboec00895a2006-09-30 20:29:12 +0200240 * completion callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 */
242 rq_end_io_fn *end_io;
243 void *end_io_data;
244};
245
Ming Lei14cb0dc2017-12-18 15:40:43 +0800246static inline bool blk_op_is_scsi(unsigned int op)
247{
248 return op == REQ_OP_SCSI_IN || op == REQ_OP_SCSI_OUT;
249}
250
251static inline bool blk_op_is_private(unsigned int op)
252{
253 return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
254}
255
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100256static inline bool blk_rq_is_scsi(struct request *rq)
257{
Ming Lei14cb0dc2017-12-18 15:40:43 +0800258 return blk_op_is_scsi(req_op(rq));
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100259}
260
261static inline bool blk_rq_is_private(struct request *rq)
262{
Ming Lei14cb0dc2017-12-18 15:40:43 +0800263 return blk_op_is_private(req_op(rq));
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100264}
265
Christoph Hellwig57292b52017-01-31 16:57:29 +0100266static inline bool blk_rq_is_passthrough(struct request *rq)
267{
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100268 return blk_rq_is_scsi(rq) || blk_rq_is_private(rq);
Christoph Hellwig57292b52017-01-31 16:57:29 +0100269}
270
Ming Lei14cb0dc2017-12-18 15:40:43 +0800271static inline bool bio_is_passthrough(struct bio *bio)
272{
273 unsigned op = bio_op(bio);
274
275 return blk_op_is_scsi(op) || blk_op_is_private(op);
276}
277
Fernando Luis Vázquez Cao766ca442008-08-14 09:59:13 +0200278static inline unsigned short req_get_ioprio(struct request *req)
279{
280 return req->ioprio;
281}
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283#include <linux/elevator.h>
284
Jens Axboe320ae512013-10-24 09:20:05 +0100285struct blk_queue_ctx;
286
Jens Axboedece1632015-11-05 10:41:16 -0700287typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289struct bio_vec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Jens Axboe242f9dc2008-09-14 05:55:09 -0700291enum blk_eh_timer_return {
Christoph Hellwig88b0cfa2018-05-29 15:52:38 +0200292 BLK_EH_DONE, /* drivers has completed the command */
293 BLK_EH_RESET_TIMER, /* reset timer and try again */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700294};
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296enum blk_queue_state {
297 Queue_down,
298 Queue_up,
299};
300
Shaohua Liee1b6f72015-01-15 17:32:25 -0800301#define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
302#define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900304#define BLK_SCSI_MAX_CMDS (256)
305#define BLK_SCSI_CMD_PER_LONG (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
306
Damien Le Moal797476b2016-10-18 15:40:29 +0900307/*
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
Martin K. Petersen025146e2009-05-22 17:17:51 -0400316struct queue_limits {
317 unsigned long bounce_pfn;
318 unsigned long seg_boundary_mask;
Keith Busch03100aa2015-08-19 14:24:05 -0700319 unsigned long virt_boundary_mask;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400320
321 unsigned int max_hw_sectors;
Martin K. Petersenca369d52015-11-13 16:46:48 -0500322 unsigned int max_dev_sectors;
Jens Axboe762380a2014-06-05 13:38:39 -0600323 unsigned int chunk_sectors;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400324 unsigned int max_sectors;
325 unsigned int max_segment_size;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400326 unsigned int physical_block_size;
Mikulas Patockaad6bf882020-01-15 08:35:25 -0500327 unsigned int logical_block_size;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400328 unsigned int alignment_offset;
329 unsigned int io_min;
330 unsigned int io_opt;
Christoph Hellwig67efc922009-09-30 13:54:20 +0200331 unsigned int max_discard_sectors;
Jens Axboe0034af02015-07-16 09:14:26 -0600332 unsigned int max_hw_discard_sectors;
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400333 unsigned int max_write_same_sectors;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800334 unsigned int max_write_zeroes_sectors;
Keith Busch0512a752020-05-12 17:55:47 +0900335 unsigned int max_zone_append_sectors;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100336 unsigned int discard_granularity;
337 unsigned int discard_alignment;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400338
Martin K. Petersen8a783622010-02-26 00:20:39 -0500339 unsigned short max_segments;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200340 unsigned short max_integrity_segments;
Christoph Hellwig1e739732017-02-08 14:46:49 +0100341 unsigned short max_discard_segments;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400342
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400343 unsigned char misaligned;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100344 unsigned char discard_misaligned;
Kent Overstreetc78afc62013-07-11 22:39:53 -0700345 unsigned char raid_partial_stripes_expensive;
Damien Le Moal797476b2016-10-18 15:40:29 +0900346 enum blk_zoned_model zoned;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400347};
348
Christoph Hellwigd4100352019-11-11 11:39:30 +0900349typedef int (*report_zones_cb)(struct blk_zone *zone, unsigned int idx,
350 void *data);
351
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900352#ifdef CONFIG_BLK_DEV_ZONED
353
Christoph Hellwigd4100352019-11-11 11:39:30 +0900354#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);
Christoph Hellwig9b38bb42019-12-03 10:39:04 +0100357unsigned int blkdev_nr_zones(struct gendisk *disk);
Ajay Joshi6c1b1da2019-10-27 23:05:45 +0900358extern 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);
Damien Le Moalbf505452018-10-12 19:08:50 +0900361extern int blk_revalidate_disk_zones(struct gendisk *disk);
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900362
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900363extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
364 unsigned int cmd, unsigned long arg);
Ajay Joshie876df12019-10-27 23:05:46 +0900365extern int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
366 unsigned int cmd, unsigned long arg);
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900367
368#else /* CONFIG_BLK_DEV_ZONED */
369
Christoph Hellwig9b38bb42019-12-03 10:39:04 +0100370static inline unsigned int blkdev_nr_zones(struct gendisk *disk)
Damien Le Moala91e1382018-10-12 19:08:43 +0900371{
372 return 0;
373}
Damien Le Moalbf505452018-10-12 19:08:50 +0900374
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900375static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
376 fmode_t mode, unsigned int cmd,
377 unsigned long arg)
378{
379 return -ENOTTY;
380}
381
Ajay Joshie876df12019-10-27 23:05:46 +0900382static inline int blkdev_zone_mgmt_ioctl(struct block_device *bdev,
383 fmode_t mode, unsigned int cmd,
384 unsigned long arg)
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900385{
386 return -ENOTTY;
387}
388
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900389#endif /* CONFIG_BLK_DEV_ZONED */
390
Richard Kennedyd7b76302011-07-13 21:17:23 +0200391struct request_queue {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 struct request *last_merge;
Jens Axboeb374d182008-10-31 10:05:07 +0100393 struct elevator_queue *elevator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Omar Sandoval34dbad52017-03-21 08:56:08 -0700395 struct blk_queue_stats *stats;
Josef Bacika7905042018-07-03 09:32:35 -0600396 struct rq_qos *rq_qos;
Jens Axboe87760e52016-11-09 12:38:14 -0700397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 make_request_fn *make_request_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
Jens Axboef8a5b122016-12-13 09:24:51 -0700400 const struct blk_mq_ops *mq_ops;
Jens Axboe320ae512013-10-24 09:20:05 +0100401
Jens Axboe320ae512013-10-24 09:20:05 +0100402 /* sw queues */
Ming Leie6cdb092014-06-03 11:24:06 +0800403 struct blk_mq_ctx __percpu *queue_ctx;
Jens Axboe320ae512013-10-24 09:20:05 +0100404
Jens Axboed278d4a2016-03-30 10:21:08 -0600405 unsigned int queue_depth;
406
Jens Axboe320ae512013-10-24 09:20:05 +0100407 /* hw dispatch queues */
408 struct blk_mq_hw_ctx **queue_hw_ctx;
409 unsigned int nr_hw_queues;
410
Jan Karadc3b17c2017-02-02 15:56:50 +0100411 struct backing_dev_info *backing_dev_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413 /*
414 * The queue owner gets to use this for whatever they like.
415 * ll_rw_blk doesn't touch it.
416 */
417 void *queuedata;
418
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 * various queue flags, see QUEUE_* below
421 */
422 unsigned long queue_flags;
Bart Van Asschecd84a622018-09-26 14:01:04 -0700423 /*
424 * Number of contexts that have called blk_set_pm_only(). If this
425 * counter is above zero then only RQF_PM and RQF_PREEMPT requests are
426 * processed.
427 */
428 atomic_t pm_only;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430 /*
Tejun Heoa73f7302011-12-14 00:33:37 +0100431 * ida allocated id for this queue. Used to index queues from
432 * ioctx.
433 */
434 int id;
435
436 /*
Richard Kennedyd7b76302011-07-13 21:17:23 +0200437 * queue needs bounce pages for pages above this limit
438 */
439 gfp_t bounce_gfp;
440
Christoph Hellwig0d945c12018-11-15 12:17:28 -0700441 spinlock_t queue_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
443 /*
444 * queue kobject
445 */
446 struct kobject kobj;
447
Jens Axboe320ae512013-10-24 09:20:05 +0100448 /*
449 * mq queue kobject
450 */
Ming Lei1db49092018-11-20 09:44:35 +0800451 struct kobject *mq_kobj;
Jens Axboe320ae512013-10-24 09:20:05 +0100452
Dan Williamsac6fc482015-10-21 13:20:18 -0400453#ifdef CONFIG_BLK_DEV_INTEGRITY
454 struct blk_integrity integrity;
455#endif /* CONFIG_BLK_DEV_INTEGRITY */
456
Rafael J. Wysocki47fafbc2014-12-04 01:00:23 +0100457#ifdef CONFIG_PM
Lin Ming6c954662013-03-23 11:42:26 +0800458 struct device *dev;
459 int rpm_status;
460 unsigned int nr_pending;
461#endif
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 /*
464 * queue settings
465 */
466 unsigned long nr_requests; /* Max # of requests */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Tejun Heoe3790c72008-03-04 11:18:17 +0100468 unsigned int dma_pad_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 unsigned int dma_alignment;
470
Jens Axboe242f9dc2008-09-14 05:55:09 -0700471 unsigned int rq_timeout;
Jens Axboe64f1c212016-11-14 13:03:03 -0700472 int poll_nsec;
Omar Sandoval34dbad52017-03-21 08:56:08 -0700473
474 struct blk_stat_callback *poll_cb;
Stephen Bates02063192017-04-20 16:59:11 -0600475 struct blk_rq_stat poll_stat[BLK_MQ_POLL_STATS_BKTS];
Omar Sandoval34dbad52017-03-21 08:56:08 -0700476
Jens Axboe242f9dc2008-09-14 05:55:09 -0700477 struct timer_list timeout;
Christoph Hellwig287922e2015-10-30 20:57:30 +0800478 struct work_struct timeout_work;
Jens Axboe242f9dc2008-09-14 05:55:09 -0700479
Tejun Heoa612fdd2011-12-14 00:33:41 +0100480 struct list_head icq_list;
Tejun Heo4eef3042012-03-05 13:15:18 -0800481#ifdef CONFIG_BLK_CGROUP
Tejun Heoa2b16932012-04-13 13:11:33 -0700482 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
Tejun Heo3c798392012-04-16 13:57:25 -0700483 struct blkcg_gq *root_blkg;
Tejun Heo03aa2642012-03-05 13:15:19 -0800484 struct list_head blkg_list;
Tejun Heo4eef3042012-03-05 13:15:18 -0800485#endif
Tejun Heoa612fdd2011-12-14 00:33:41 +0100486
Martin K. Petersen025146e2009-05-22 17:17:51 -0400487 struct queue_limits limits;
488
Damien Le Moal68c43f12019-09-05 18:51:31 +0900489 unsigned int required_elevator_features;
490
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700491#ifdef CONFIG_BLK_DEV_ZONED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 /*
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900493 * Zoned block device information for request dispatch control.
494 * nr_zones is the total number of zones of the device. This is always
Christoph Hellwigf216fdd2019-12-03 10:39:05 +0100495 * 0 for regular block devices. conv_zones_bitmap is a bitmap of nr_zones
496 * bits which indicates if a zone is conventional (bit set) or
497 * sequential (bit clear). seq_zones_wlock is a bitmap of nr_zones
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900498 * bits which indicates if a zone is write locked, that is, if a write
499 * request targeting the zone was dispatched. All three fields are
500 * initialized by the low level device driver (e.g. scsi/sd.c).
501 * Stacking drivers (device mappers) may or may not initialize
502 * these fields.
Bart Van Asscheccce20f2018-04-16 18:04:41 -0700503 *
504 * Reads of this information must be protected with blk_queue_enter() /
505 * blk_queue_exit(). Modifying this information is only allowed while
506 * no requests are being processed. See also blk_mq_freeze_queue() and
507 * blk_mq_unfreeze_queue().
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900508 */
509 unsigned int nr_zones;
Christoph Hellwigf216fdd2019-12-03 10:39:05 +0100510 unsigned long *conv_zones_bitmap;
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900511 unsigned long *seq_zones_wlock;
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700512#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900513
514 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 * sg stuff
516 */
517 unsigned int sg_timeout;
518 unsigned int sg_reserved_size;
Christoph Lameter19460892005-06-23 00:08:19 -0700519 int node;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700520#ifdef CONFIG_BLK_DEV_IO_TRACE
Jan Karac780e862020-02-06 15:28:12 +0100521 struct blk_trace __rcu *blk_trace;
Waiman Long5acb3cc2017-09-20 13:12:20 -0600522 struct mutex blk_trace_mutex;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700523#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 /*
Tejun Heo4913efe2010-09-03 11:56:16 +0200525 * for flush operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 */
Ming Lei7c94e1c2014-09-25 23:23:43 +0800527 struct blk_flush_queue *fq;
Al Viro483f4af2006-03-18 18:34:37 -0500528
Christoph Hellwig6fca6a62014-05-28 08:08:02 -0600529 struct list_head requeue_list;
530 spinlock_t requeue_lock;
Mike Snitzer28494502016-09-14 13:28:30 -0400531 struct delayed_work requeue_work;
Christoph Hellwig6fca6a62014-05-28 08:08:02 -0600532
Al Viro483f4af2006-03-18 18:34:37 -0500533 struct mutex sysfs_lock;
Ming Leicecf5d82019-08-27 19:01:48 +0800534 struct mutex sysfs_dir_lock;
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200535
Ming Lei2f8f1332019-04-30 09:52:27 +0800536 /*
537 * for reusing dead hctx instance in case of updating
538 * nr_hw_queues
539 */
540 struct list_head unused_hctx_list;
541 spinlock_t unused_hctx_lock;
542
Bob Liu7996a8b2019-05-21 11:25:55 +0800543 int mq_freeze_depth;
Tejun Heod7325802012-03-05 13:14:58 -0800544
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200545#if defined(CONFIG_BLK_DEV_BSG)
546 struct bsg_class_device bsg_dev;
547#endif
Vivek Goyale43473b2010-09-15 17:06:35 -0400548
549#ifdef CONFIG_BLK_DEV_THROTTLING
550 /* Throttle data */
551 struct throtl_data *td;
552#endif
Tejun Heo548bc8e2013-01-09 08:05:13 -0800553 struct rcu_head rcu_head;
Jens Axboe320ae512013-10-24 09:20:05 +0100554 wait_queue_head_t mq_freeze_wq;
Bob Liu7996a8b2019-05-21 11:25:55 +0800555 /*
556 * Protect concurrent access to q_usage_counter by
557 * percpu_ref_kill() and percpu_ref_reinit().
558 */
559 struct mutex mq_freeze_lock;
Dan Williams3ef28e82015-10-21 13:20:12 -0400560 struct percpu_ref q_usage_counter;
Jens Axboe0d2602c2014-05-13 15:10:52 -0600561
562 struct blk_mq_tag_set *tag_set;
563 struct list_head tag_set_list;
Kent Overstreet338aa962018-05-20 18:25:47 -0400564 struct bio_set bio_split;
Akinobu Mita4593fdb2015-09-27 02:09:20 +0900565
Omar Sandoval03796c12017-01-31 14:53:18 -0800566#ifdef CONFIG_BLK_DEBUG_FS
Omar Sandoval07e4fea2017-01-25 08:06:40 -0800567 struct dentry *debugfs_dir;
Omar Sandovald332ce02017-05-04 08:24:40 -0600568 struct dentry *sched_debugfs_dir;
Ming Leicc566942018-12-17 09:46:00 +0800569 struct dentry *rqos_debugfs_dir;
Omar Sandoval07e4fea2017-01-25 08:06:40 -0800570#endif
571
Akinobu Mita4593fdb2015-09-27 02:09:20 +0900572 bool mq_sysfs_init_done;
Christoph Hellwig6d247d72017-01-27 09:51:45 -0700573
574 size_t cmd_size;
Bart Van Asschedc9edc42017-06-14 13:27:50 -0600575
576 struct work_struct release_work;
Jens Axboef793dfd2017-06-26 08:15:27 -0600577
578#define BLK_MAX_WRITE_HINTS 5
579 u64 write_hints[BLK_MAX_WRITE_HINTS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580};
581
Jens Axboeeca7abf2019-02-09 15:42:07 -0700582#define QUEUE_FLAG_STOPPED 0 /* queue is stopped */
583#define QUEUE_FLAG_DYING 1 /* queue being torn down */
Jens Axboeeca7abf2019-02-09 15:42:07 -0700584#define QUEUE_FLAG_NOMERGES 3 /* disable merge attempts */
585#define QUEUE_FLAG_SAME_COMP 4 /* complete on same CPU-group */
586#define QUEUE_FLAG_FAIL_IO 5 /* fake timeout */
587#define QUEUE_FLAG_NONROT 6 /* non-rotational device (SSD) */
588#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
589#define QUEUE_FLAG_IO_STAT 7 /* do disk/partitions IO accounting */
590#define QUEUE_FLAG_DISCARD 8 /* supports DISCARD */
591#define QUEUE_FLAG_NOXMERGES 9 /* No extended merges */
592#define QUEUE_FLAG_ADD_RANDOM 10 /* Contributes to random pool */
593#define QUEUE_FLAG_SECERASE 11 /* supports secure erase */
594#define QUEUE_FLAG_SAME_FORCE 12 /* force complete on same CPU */
595#define QUEUE_FLAG_DEAD 13 /* queue tear-down finished */
596#define QUEUE_FLAG_INIT_DONE 14 /* queue is initialized */
Jens Axboeeca7abf2019-02-09 15:42:07 -0700597#define QUEUE_FLAG_POLL 16 /* IO polling enabled if set */
598#define QUEUE_FLAG_WC 17 /* Write back caching */
599#define QUEUE_FLAG_FUA 18 /* device supports FUA writes */
600#define QUEUE_FLAG_DAX 19 /* device supports DAX */
601#define QUEUE_FLAG_STATS 20 /* track IO start and completion times */
602#define QUEUE_FLAG_POLL_STATS 21 /* collecting stats for hybrid polling */
603#define QUEUE_FLAG_REGISTERED 22 /* queue has been registered to a disk */
604#define QUEUE_FLAG_SCSI_PASSTHROUGH 23 /* queue supports SCSI commands */
605#define QUEUE_FLAG_QUIESCED 24 /* queue has been quiesced */
606#define QUEUE_FLAG_PCI_P2PDMA 25 /* device supports PCI p2p requests */
Chaitanya Kulkarnie84e8f02019-08-01 10:26:35 -0700607#define QUEUE_FLAG_ZONE_RESETALL 26 /* supports Zone Reset All */
Tejun Heo6f816b42019-08-28 15:05:57 -0700608#define QUEUE_FLAG_RQ_ALLOC_TIME 27 /* record rq->alloc_time_ns */
Tejun Heo797e7db2006-01-06 09:51:03 +0100609
Jens Axboe94eddfb2013-11-19 09:25:07 -0700610#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
Jens Axboe6e0de612018-12-05 06:50:40 -0700611 (1 << QUEUE_FLAG_SAME_COMP))
Jens Axboe94eddfb2013-11-19 09:25:07 -0700612
Bart Van Assche8814ce82018-03-07 17:10:04 -0800613void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
614void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
615bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
Bart Van Assche8814ce82018-03-07 17:10:04 -0800616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
Bart Van Assche3f3299d2012-11-28 13:42:38 +0100618#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
Bart Van Asschec246e802012-12-06 14:32:01 +0100619#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
Jens Axboe320ae512013-10-24 09:20:05 +0100620#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
Alan D. Brunelleac9fafa2008-04-29 14:44:19 +0200621#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
Alan D. Brunelle488991e2010-01-29 09:04:08 +0100622#define blk_queue_noxmerges(q) \
623 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
Jens Axboea68bbddba2008-09-24 13:03:33 +0200624#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
Jens Axboebc58ba92009-01-23 10:54:44 +0100625#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
Jens Axboee2e1a142010-06-09 10:42:09 +0200626#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
Christoph Hellwigc15227d2009-09-30 13:52:12 +0200627#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
Chaitanya Kulkarnie84e8f02019-08-01 10:26:35 -0700628#define blk_queue_zone_resetall(q) \
629 test_bit(QUEUE_FLAG_ZONE_RESETALL, &(q)->queue_flags)
Christoph Hellwig288dab82016-06-09 16:00:36 +0200630#define blk_queue_secure_erase(q) \
631 (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
Toshi Kani163d4ba2016-06-23 17:05:50 -0400632#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
Bart Van Assche9efc1602017-05-31 14:43:46 -0700633#define blk_queue_scsi_passthrough(q) \
634 test_bit(QUEUE_FLAG_SCSI_PASSTHROUGH, &(q)->queue_flags)
Logan Gunthorpe49d92c02018-10-04 15:27:41 -0600635#define blk_queue_pci_p2pdma(q) \
636 test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
Tejun Heo6f816b42019-08-28 15:05:57 -0700637#ifdef CONFIG_BLK_RQ_ALLOC_TIME
638#define blk_queue_rq_alloc_time(q) \
639 test_bit(QUEUE_FLAG_RQ_ALLOC_TIME, &(q)->queue_flags)
640#else
641#define blk_queue_rq_alloc_time(q) false
642#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200644#define blk_noretry_request(rq) \
645 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
646 REQ_FAILFAST_DRIVER))
Ming Leif4560ff2017-06-18 14:24:27 -0600647#define blk_queue_quiesced(q) test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
Bart Van Asschecd84a622018-09-26 14:01:04 -0700648#define blk_queue_pm_only(q) atomic_read(&(q)->pm_only)
Dave Chinner0ce91442018-04-18 14:08:27 +1000649#define blk_queue_fua(q) test_bit(QUEUE_FLAG_FUA, &(q)->queue_flags)
Ming Lei58c898b2019-08-27 19:01:47 +0800650#define blk_queue_registered(q) test_bit(QUEUE_FLAG_REGISTERED, &(q)->queue_flags)
Bart Van Asschec9254f22017-11-09 10:49:57 -0800651
Bart Van Asschecd84a622018-09-26 14:01:04 -0700652extern void blk_set_pm_only(struct request_queue *q);
653extern void blk_clear_pm_only(struct request_queue *q);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200654
Christoph Hellwig57292b52017-01-31 16:57:29 +0100655static inline bool blk_account_rq(struct request *rq)
656{
657 return (rq->rq_flags & RQF_STARTED) && !blk_rq_is_passthrough(rq);
658}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
661
Mike Christie4e1b2d522016-06-05 14:32:22 -0500662#define rq_data_dir(rq) (op_is_write(req_op(rq)) ? WRITE : READ)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Christoph Hellwig9d9de532019-03-03 08:18:30 -0700664#define rq_dma_dir(rq) \
665 (op_is_write(req_op(rq)) ? DMA_TO_DEVICE : DMA_FROM_DEVICE)
666
Christoph Hellwig3ab3a032019-03-03 08:40:36 -0700667#define dma_map_bvec(dev, bv, dir, attrs) \
668 dma_map_page_attrs(dev, (bv)->bv_page, (bv)->bv_offset, (bv)->bv_len, \
669 (dir), (attrs))
670
Jens Axboe344e9ff2018-11-15 12:22:51 -0700671static inline bool queue_is_mq(struct request_queue *q)
Jens Axboe49fd5242014-04-16 10:57:18 -0600672{
Jens Axboea1ce35f2018-10-29 10:23:51 -0600673 return q->mq_ops;
Jens Axboe49fd5242014-04-16 10:57:18 -0600674}
675
Damien Le Moal797476b2016-10-18 15:40:29 +0900676static inline enum blk_zoned_model
677blk_queue_zoned_model(struct request_queue *q)
678{
679 return q->limits.zoned;
680}
681
682static inline bool blk_queue_is_zoned(struct request_queue *q)
683{
684 switch (blk_queue_zoned_model(q)) {
685 case BLK_ZONED_HA:
686 case BLK_ZONED_HM:
687 return true;
688 default:
689 return false;
690 }
691}
692
Damien Le Moal113ab722019-07-10 13:53:10 +0900693static inline sector_t blk_queue_zone_sectors(struct request_queue *q)
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900694{
695 return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
696}
697
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700698#ifdef CONFIG_BLK_DEV_ZONED
Damien Le Moal965b6522018-10-12 19:08:48 +0900699static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
700{
701 return blk_queue_is_zoned(q) ? q->nr_zones : 0;
702}
703
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900704static inline unsigned int blk_queue_zone_no(struct request_queue *q,
705 sector_t sector)
706{
707 if (!blk_queue_is_zoned(q))
708 return 0;
709 return sector >> ilog2(q->limits.chunk_sectors);
710}
711
712static inline bool blk_queue_zone_is_seq(struct request_queue *q,
713 sector_t sector)
714{
Christoph Hellwigf216fdd2019-12-03 10:39:05 +0100715 if (!blk_queue_is_zoned(q))
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900716 return false;
Christoph Hellwigf216fdd2019-12-03 10:39:05 +0100717 if (!q->conv_zones_bitmap)
718 return true;
719 return !test_bit(blk_queue_zone_no(q, sector), q->conv_zones_bitmap);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900720}
Damien Le Moal965b6522018-10-12 19:08:48 +0900721#else /* CONFIG_BLK_DEV_ZONED */
722static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
723{
724 return 0;
725}
Johannes Thumshirn02992df82020-05-12 17:55:45 +0900726static inline bool blk_queue_zone_is_seq(struct request_queue *q,
727 sector_t sector)
728{
729 return false;
730}
731static inline unsigned int blk_queue_zone_no(struct request_queue *q,
732 sector_t sector)
733{
734 return 0;
735}
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700736#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900737
Jens Axboe1faa16d2009-04-06 14:48:01 +0200738static inline bool rq_is_sync(struct request *rq)
739{
Christoph Hellwigef295ec2016-10-28 08:48:16 -0600740 return op_is_sync(rq->cmd_flags);
Jens Axboe1faa16d2009-04-06 14:48:01 +0200741}
742
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400743static inline bool rq_mergeable(struct request *rq)
744{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100745 if (blk_rq_is_passthrough(rq))
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400746 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Mike Christie3a5e02c2016-06-05 14:32:23 -0500748 if (req_op(rq) == REQ_OP_FLUSH)
749 return false;
750
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800751 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
752 return false;
753
Keith Busch0512a752020-05-12 17:55:47 +0900754 if (req_op(rq) == REQ_OP_ZONE_APPEND)
755 return false;
756
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400757 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
758 return false;
Christoph Hellwige8064022016-10-20 15:12:13 +0200759 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
760 return false;
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400761
762 return true;
763}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400765static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
766{
Christoph Hellwigefbeccd2017-06-19 09:24:41 +0200767 if (bio_page(a) == bio_page(b) &&
768 bio_offset(a) == bio_offset(b))
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400769 return true;
770
771 return false;
772}
773
Jens Axboed278d4a2016-03-30 10:21:08 -0600774static inline unsigned int blk_queue_depth(struct request_queue *q)
775{
776 if (q->queue_depth)
777 return q->queue_depth;
778
779 return q->nr_requests;
780}
781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782extern unsigned long blk_max_low_pfn, blk_max_pfn;
783
784/*
785 * standard bounce addresses:
786 *
787 * BLK_BOUNCE_HIGH : bounce all highmem pages
788 * BLK_BOUNCE_ANY : don't bounce anything
789 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
790 */
Andi Kleen24728922008-04-21 09:51:05 +0200791
792#if BITS_PER_LONG == 32
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
Andi Kleen24728922008-04-21 09:51:05 +0200794#else
795#define BLK_BOUNCE_HIGH -1ULL
796#endif
797#define BLK_BOUNCE_ANY (-1ULL)
FUJITA Tomonoribfe17232010-05-31 15:59:03 +0900798#define BLK_BOUNCE_ISA (DMA_BIT_MASK(24))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Jens Axboe3d6392c2007-07-09 12:38:05 +0200800/*
801 * default timeout for SG_IO if none specified
802 */
803#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800804#define BLK_MIN_SG_TIMEOUT (7 * HZ)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200805
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900806struct rq_map_data {
807 struct page **pages;
808 int page_order;
809 int nr_entries;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +0900810 unsigned long offset;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +0900811 int null_mapped;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +0200812 int from_user;
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900813};
814
NeilBrown5705f702007-09-25 12:35:59 +0200815struct req_iterator {
Kent Overstreet79886132013-11-23 17:19:00 -0800816 struct bvec_iter iter;
NeilBrown5705f702007-09-25 12:35:59 +0200817 struct bio *bio;
818};
819
820/* This should not be used directly - use rq_for_each_segment */
Jens Axboe1e428072009-02-23 09:03:10 +0100821#define for_each_bio(_bio) \
822 for (; _bio; _bio = _bio->bi_next)
NeilBrown5705f702007-09-25 12:35:59 +0200823#define __rq_for_each_bio(_bio, rq) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 if ((rq->bio)) \
825 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
826
NeilBrown5705f702007-09-25 12:35:59 +0200827#define rq_for_each_segment(bvl, _rq, _iter) \
828 __rq_for_each_bio(_iter.bio, _rq) \
Kent Overstreet79886132013-11-23 17:19:00 -0800829 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
NeilBrown5705f702007-09-25 12:35:59 +0200830
Ming Leid18d9172019-02-15 19:13:11 +0800831#define rq_for_each_bvec(bvl, _rq, _iter) \
832 __rq_for_each_bio(_iter.bio, _rq) \
833 bio_for_each_bvec(bvl, _iter.bio, _iter.iter)
834
Kent Overstreet4550dd62013-08-07 14:26:21 -0700835#define rq_iter_last(bvec, _iter) \
Kent Overstreet79886132013-11-23 17:19:00 -0800836 (_iter.bio->bi_next == NULL && \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700837 bio_iter_last(bvec, _iter.iter))
NeilBrown5705f702007-09-25 12:35:59 +0200838
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100839#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
840# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
841#endif
842#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
843extern void rq_flush_dcache_pages(struct request *rq);
844#else
845static inline void rq_flush_dcache_pages(struct request *rq)
846{
847}
848#endif
849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850extern int blk_register_queue(struct gendisk *disk);
851extern void blk_unregister_queue(struct gendisk *disk);
Jens Axboedece1632015-11-05 10:41:16 -0700852extern blk_qc_t generic_make_request(struct bio *bio);
Christoph Hellwigf421e1d2017-11-02 21:29:50 +0300853extern blk_qc_t direct_make_request(struct bio *bio);
FUJITA Tomonori2a4aa302008-04-29 09:54:36 +0200854extern void blk_rq_init(struct request_queue *q, struct request *rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855extern void blk_put_request(struct request *);
Bart Van Asschecd6ce142017-06-20 11:15:39 -0700856extern struct request *blk_get_request(struct request_queue *, unsigned int op,
Christoph Hellwigff005a02018-05-09 09:54:05 +0200857 blk_mq_req_flags_t flags);
Kiyoshi Uedaef9e3fa2008-10-01 16:12:15 +0200858extern int blk_lld_busy(struct request_queue *q);
Mike Snitzer78d8e582015-06-26 10:01:13 -0400859extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
860 struct bio_set *bs, gfp_t gfp_mask,
861 int (*bio_ctr)(struct bio *, struct bio *, void *),
862 void *data);
863extern void blk_rq_unprep_clone(struct request *rq);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200864extern blk_status_t blk_insert_cloned_request(struct request_queue *q,
Kiyoshi Ueda82124d62008-09-18 10:45:38 -0400865 struct request *rq);
Jens Axboe0abc2a12017-12-18 15:40:44 +0800866extern int blk_rq_append_bio(struct request *rq, struct bio **bio);
NeilBrownaf67c312017-06-18 14:38:57 +1000867extern void blk_queue_split(struct request_queue *, struct bio **);
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100868extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100869extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
870 unsigned int, void __user *);
Al Viro74f3c8a2007-08-27 15:38:10 -0400871extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
872 unsigned int, void __user *);
Al Viroe915e872008-09-02 17:16:41 -0400873extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
874 struct scsi_ioctl_command __user *);
Arnd Bergmann98aaaec2019-03-14 17:45:18 +0100875extern int get_sg_io_hdr(struct sg_io_hdr *hdr, const void __user *argp);
876extern int put_sg_io_hdr(const struct sg_io_hdr *hdr, void __user *argp);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700877
Bart Van Assche9a95e4e2017-11-09 10:49:59 -0800878extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
Dan Williams2e6edc952015-11-19 13:29:28 -0800879extern void blk_queue_exit(struct request_queue *q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880extern void blk_sync_queue(struct request_queue *q);
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900881extern int blk_rq_map_user(struct request_queue *, struct request *,
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900882 struct rq_map_data *, void __user *, unsigned long,
883 gfp_t);
Jens Axboe8e5cfc42006-12-19 11:12:46 +0100884extern int blk_rq_unmap_user(struct bio *);
Jens Axboe165125e2007-07-24 09:28:11 +0200885extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
886extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100887 struct rq_map_data *, const struct iov_iter *,
888 gfp_t);
Christoph Hellwigb7819b92017-04-20 16:02:55 +0200889extern void blk_execute_rq(struct request_queue *, struct gendisk *,
James Bottomley 994ca9a2005-06-20 14:11:09 +0200890 struct request *, int);
Jens Axboe165125e2007-07-24 09:28:11 +0200891extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
Jens Axboe15fc8582006-01-06 10:00:50 +0100892 struct request *, int, rq_end_io_fn *);
Mike Christie6e39b692005-11-11 05:30:24 -0600893
Chaitanya Kulkarnie47bc4e2019-06-20 10:59:16 -0700894/* Helper to convert REQ_OP_XXX to its string format XXX */
895extern const char *blk_op_str(unsigned int op);
896
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200897int blk_status_to_errno(blk_status_t status);
898blk_status_t errno_to_blk_status(int errno);
899
Jens Axboe0a1b8b82018-11-26 08:24:43 -0700900int blk_poll(struct request_queue *q, blk_qc_t cookie, bool spin);
Jens Axboe05229beed2015-11-05 10:44:55 -0700901
Jens Axboe165125e2007-07-24 09:28:11 +0200902static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
Tejun Heoff9ea322014-09-08 08:03:56 +0900904 return bdev->bd_disk->queue; /* this is never NULL */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905}
906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907/*
Bart Van Assche233bde22018-03-14 15:48:06 -0700908 * The basic unit of block I/O is a sector. It is used in a number of contexts
909 * in Linux (blk, bio, genhd). The size of one sector is 512 = 2**9
910 * bytes. Variables of type sector_t represent an offset or size that is a
911 * multiple of 512 bytes. Hence these two constants.
912 */
913#ifndef SECTOR_SHIFT
914#define SECTOR_SHIFT 9
915#endif
916#ifndef SECTOR_SIZE
917#define SECTOR_SIZE (1 << SECTOR_SHIFT)
918#endif
919
920/*
Tejun Heo80a761f2009-07-03 17:48:17 +0900921 * blk_rq_pos() : the current sector
922 * blk_rq_bytes() : bytes left in the entire request
923 * blk_rq_cur_bytes() : bytes left in the current segment
924 * blk_rq_err_bytes() : bytes left till the next error boundary
925 * blk_rq_sectors() : sectors left in the entire request
926 * blk_rq_cur_sectors() : sectors left in the current segment
Hou Tao3d244302019-05-21 15:59:03 +0800927 * blk_rq_stats_sectors() : sectors of the entire request used for stats
Tejun Heo5efccd12009-04-23 11:05:18 +0900928 */
Tejun Heo5b936292009-05-07 22:24:38 +0900929static inline sector_t blk_rq_pos(const struct request *rq)
930{
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900931 return rq->__sector;
Tejun Heo5b936292009-05-07 22:24:38 +0900932}
933
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900934static inline unsigned int blk_rq_bytes(const struct request *rq)
935{
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900936 return rq->__data_len;
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900937}
938
939static inline int blk_rq_cur_bytes(const struct request *rq)
940{
941 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
942}
Tejun Heo5efccd12009-04-23 11:05:18 +0900943
Tejun Heo80a761f2009-07-03 17:48:17 +0900944extern unsigned int blk_rq_err_bytes(const struct request *rq);
945
Tejun Heo5b936292009-05-07 22:24:38 +0900946static inline unsigned int blk_rq_sectors(const struct request *rq)
947{
Bart Van Assche233bde22018-03-14 15:48:06 -0700948 return blk_rq_bytes(rq) >> SECTOR_SHIFT;
Tejun Heo5b936292009-05-07 22:24:38 +0900949}
950
951static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
952{
Bart Van Assche233bde22018-03-14 15:48:06 -0700953 return blk_rq_cur_bytes(rq) >> SECTOR_SHIFT;
Tejun Heo5b936292009-05-07 22:24:38 +0900954}
955
Hou Tao3d244302019-05-21 15:59:03 +0800956static inline unsigned int blk_rq_stats_sectors(const struct request *rq)
957{
958 return rq->stats_sectors;
959}
960
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700961#ifdef CONFIG_BLK_DEV_ZONED
Chaitanya Kulkarni02694e82020-03-25 10:49:54 -0700962
963/* Helper to convert BLK_ZONE_ZONE_XXX to its string format XXX */
964const char *blk_zone_cond_str(enum blk_zone_cond zone_cond);
965
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900966static inline unsigned int blk_rq_zone_no(struct request *rq)
967{
968 return blk_queue_zone_no(rq->q, blk_rq_pos(rq));
969}
970
971static inline unsigned int blk_rq_zone_is_seq(struct request *rq)
972{
973 return blk_queue_zone_is_seq(rq->q, blk_rq_pos(rq));
974}
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700975#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900976
Christoph Hellwig2e3258e2017-01-13 12:29:10 +0100977/*
978 * Some commands like WRITE SAME have a payload or data transfer size which
979 * is different from the size of the request. Any driver that supports such
980 * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
981 * calculate the data transfer size.
982 */
983static inline unsigned int blk_rq_payload_bytes(struct request *rq)
984{
985 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
986 return rq->special_vec.bv_len;
987 return blk_rq_bytes(rq);
988}
989
Christoph Hellwig3aef3ca2019-03-03 09:14:01 -0700990/*
991 * Return the first full biovec in the request. The caller needs to check that
992 * there are any bvecs before calling this helper.
993 */
994static inline struct bio_vec req_bvec(struct request *rq)
995{
996 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
997 return rq->special_vec;
998 return mp_bvec_iter_bvec(rq->bio->bi_io_vec, rq->bio->bi_iter);
999}
1000
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -04001001static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
Mike Christie8fe0d472016-06-05 14:32:15 -05001002 int op)
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -04001003{
Adrian Hunter7afafc82016-08-16 10:59:35 +03001004 if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
Bart Van Assche233bde22018-03-14 15:48:06 -07001005 return min(q->limits.max_discard_sectors,
1006 UINT_MAX >> SECTOR_SHIFT);
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -04001007
Mike Christie8fe0d472016-06-05 14:32:15 -05001008 if (unlikely(op == REQ_OP_WRITE_SAME))
Martin K. Petersen4363ac72012-09-18 12:19:27 -04001009 return q->limits.max_write_same_sectors;
1010
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -08001011 if (unlikely(op == REQ_OP_WRITE_ZEROES))
1012 return q->limits.max_write_zeroes_sectors;
1013
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -04001014 return q->limits.max_sectors;
1015}
1016
Jens Axboe762380a2014-06-05 13:38:39 -06001017/*
1018 * Return maximum size of a request at given offset. Only valid for
1019 * file system requests.
1020 */
1021static inline unsigned int blk_max_size_offset(struct request_queue *q,
1022 sector_t offset)
1023{
1024 if (!q->limits.chunk_sectors)
Jens Axboe736ed4d2014-06-17 22:09:29 -07001025 return q->limits.max_sectors;
Jens Axboe762380a2014-06-05 13:38:39 -06001026
Keith Busch15bfd212018-06-26 09:14:58 -06001027 return min(q->limits.max_sectors, (unsigned int)(q->limits.chunk_sectors -
1028 (offset & (q->limits.chunk_sectors - 1))));
Jens Axboe762380a2014-06-05 13:38:39 -06001029}
1030
Damien Le Moal17007f32016-07-20 21:40:47 -06001031static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
1032 sector_t offset)
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -04001033{
1034 struct request_queue *q = rq->q;
1035
Christoph Hellwig57292b52017-01-31 16:57:29 +01001036 if (blk_rq_is_passthrough(rq))
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -04001037 return q->limits.max_hw_sectors;
1038
Adrian Hunter7afafc82016-08-16 10:59:35 +03001039 if (!q->limits.chunk_sectors ||
1040 req_op(rq) == REQ_OP_DISCARD ||
1041 req_op(rq) == REQ_OP_SECURE_ERASE)
Mike Christie8fe0d472016-06-05 14:32:15 -05001042 return blk_queue_get_max_sectors(q, req_op(rq));
Jens Axboe762380a2014-06-05 13:38:39 -06001043
Damien Le Moal17007f32016-07-20 21:40:47 -06001044 return min(blk_max_size_offset(q, offset),
Mike Christie8fe0d472016-06-05 14:32:15 -05001045 blk_queue_get_max_sectors(q, req_op(rq)));
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -04001046}
1047
Jun'ichi Nomura75afb352013-09-21 13:57:47 -06001048static inline unsigned int blk_rq_count_bios(struct request *rq)
1049{
1050 unsigned int nr_bios = 0;
1051 struct bio *bio;
1052
1053 __rq_for_each_bio(bio, rq)
1054 nr_bios++;
1055
1056 return nr_bios;
1057}
1058
Christoph Hellwigef71de82017-11-02 21:29:51 +03001059void blk_steal_bios(struct bio_list *list, struct request *rq);
1060
Tejun Heo9934c8c2009-05-08 11:54:16 +09001061/*
Tejun Heo2e60e022009-04-23 11:05:18 +09001062 * Request completion related functions.
1063 *
1064 * blk_update_request() completes given number of bytes and updates
1065 * the request without completing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001067extern bool blk_update_request(struct request *rq, blk_status_t error,
Tejun Heo2e60e022009-04-23 11:05:18 +09001068 unsigned int nr_bytes);
Tejun Heo2e60e022009-04-23 11:05:18 +09001069
Jens Axboe242f9dc2008-09-14 05:55:09 -07001070extern void __blk_complete_request(struct request *);
1071extern void blk_abort_request(struct request *);
Jens Axboeff856ba2006-01-09 16:02:34 +01001072
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 * Access functions for manipulating queue properties
1075 */
Jens Axboe165125e2007-07-24 09:28:11 +02001076extern void blk_cleanup_queue(struct request_queue *);
Jens Axboe165125e2007-07-24 09:28:11 +02001077extern void blk_queue_bounce_limit(struct request_queue *, u64);
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001078extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
Jens Axboe762380a2014-06-05 13:38:39 -06001079extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001080extern void blk_queue_max_segments(struct request_queue *, unsigned short);
Christoph Hellwig1e739732017-02-08 14:46:49 +01001081extern void blk_queue_max_discard_segments(struct request_queue *,
1082 unsigned short);
Jens Axboe165125e2007-07-24 09:28:11 +02001083extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
Christoph Hellwig67efc922009-09-30 13:54:20 +02001084extern void blk_queue_max_discard_sectors(struct request_queue *q,
1085 unsigned int max_discard_sectors);
Martin K. Petersen4363ac72012-09-18 12:19:27 -04001086extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1087 unsigned int max_write_same_sectors);
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -08001088extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1089 unsigned int max_write_same_sectors);
Mikulas Patockaad6bf882020-01-15 08:35:25 -05001090extern void blk_queue_logical_block_size(struct request_queue *, unsigned int);
Keith Busch0512a752020-05-12 17:55:47 +09001091extern void blk_queue_max_zone_append_sectors(struct request_queue *q,
1092 unsigned int max_zone_append_sectors);
Martin K. Petersen892b6f92010-10-13 21:18:03 +02001093extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001094extern void blk_queue_alignment_offset(struct request_queue *q,
1095 unsigned int alignment);
Martin K. Petersen7c958e32009-07-31 11:49:11 -04001096extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001097extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
Martin K. Petersen3c5820c2009-09-11 21:54:52 +02001098extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001099extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
Jens Axboed278d4a2016-03-30 10:21:08 -06001100extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
Martin K. Petersene475bba2009-06-16 08:23:52 +02001101extern void blk_set_default_limits(struct queue_limits *lim);
Martin K. Petersenb1bd0552012-01-11 16:27:11 +01001102extern void blk_set_stacking_limits(struct queue_limits *lim);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001103extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1104 sector_t offset);
Martin K. Petersen17be8c22010-01-11 03:21:49 -05001105extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1106 sector_t offset);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001107extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1108 sector_t offset);
Jens Axboe165125e2007-07-24 09:28:11 +02001109extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
FUJITA Tomonori27f82212008-07-04 09:30:03 +02001110extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
Jens Axboe165125e2007-07-24 09:28:11 +02001111extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
Keith Busch03100aa2015-08-19 14:24:05 -07001112extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
Jens Axboe165125e2007-07-24 09:28:11 +02001113extern void blk_queue_dma_alignment(struct request_queue *, int);
James Bottomley11c3e682007-12-31 16:37:00 -06001114extern void blk_queue_update_dma_alignment(struct request_queue *, int);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001115extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
Jens Axboe93e9d8e2016-04-12 12:32:46 -06001116extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
Damien Le Moal68c43f12019-09-05 18:51:31 +09001117extern void blk_queue_required_elevator_features(struct request_queue *q,
1118 unsigned int features);
Yoshihiro Shimoda45147fb2019-08-28 21:35:42 +09001119extern bool blk_queue_can_use_dma_map_merging(struct request_queue *q,
1120 struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121
Christoph Hellwig1e739732017-02-08 14:46:49 +01001122/*
1123 * Number of physical segments as sent to the device.
1124 *
1125 * Normally this is the number of discontiguous data segments sent by the
1126 * submitter. But for data-less command like discard we might have no
1127 * actual data segments submitted, but the driver might have to add it's
1128 * own special payload. In that case we still return 1 here so that this
1129 * special payload will be mapped.
1130 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001131static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1132{
1133 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1134 return 1;
1135 return rq->nr_phys_segments;
1136}
1137
Christoph Hellwig1e739732017-02-08 14:46:49 +01001138/*
1139 * Number of discard segments (or ranges) the driver needs to fill in.
1140 * Each discard bio merged into a request is counted as one segment.
1141 */
1142static inline unsigned short blk_rq_nr_discard_segments(struct request *rq)
1143{
1144 return max_t(unsigned short, rq->nr_phys_segments, 1);
1145}
1146
Christoph Hellwig89de1502020-04-14 09:42:22 +02001147int __blk_rq_map_sg(struct request_queue *q, struct request *rq,
1148 struct scatterlist *sglist, struct scatterlist **last_sg);
1149static inline int blk_rq_map_sg(struct request_queue *q, struct request *rq,
1150 struct scatterlist *sglist)
1151{
1152 struct scatterlist *last_sg = NULL;
1153
1154 return __blk_rq_map_sg(q, rq, sglist, &last_sg);
1155}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156extern void blk_dump_rq_flags(struct request *, char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157extern long nr_blockdev_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158
Tejun Heo09ac46c2011-12-14 00:33:38 +01001159bool __must_check blk_get_queue(struct request_queue *);
Christoph Hellwig3d745ea2020-03-27 09:30:11 +01001160struct request_queue *blk_alloc_queue(make_request_fn make_request, int node_id);
Jens Axboe165125e2007-07-24 09:28:11 +02001161extern void blk_put_queue(struct request_queue *);
Jens Axboe3f21c262015-06-05 10:57:37 -06001162extern void blk_set_queue_dying(struct request_queue *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
Shaohua Li316cc672011-07-08 08:19:21 +02001164/*
Suresh Jayaraman75df7132011-09-21 10:00:16 +02001165 * blk_plug permits building a queue of related requests by holding the I/O
1166 * fragments for a short period. This allows merging of sequential requests
1167 * into single larger request. As the requests are moved from a per-task list to
1168 * the device's request_queue in a batch, this results in improved scalability
1169 * as the lock contention for request_queue lock is reduced.
1170 *
1171 * It is ok not to disable preemption when adding the request to the plug list
1172 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1173 * the plug list when the task sleeps by itself. For details, please see
1174 * schedule() where blk_schedule_flush_plug() is called.
Shaohua Li316cc672011-07-08 08:19:21 +02001175 */
Jens Axboe73c10102011-03-08 13:19:51 +01001176struct blk_plug {
Jens Axboe320ae512013-10-24 09:20:05 +01001177 struct list_head mq_list; /* blk-mq requests */
Suresh Jayaraman75df7132011-09-21 10:00:16 +02001178 struct list_head cb_list; /* md requires an unplug callback */
Jens Axboe5f0ed772018-11-23 22:04:33 -07001179 unsigned short rq_count;
Jens Axboece5b0092018-11-27 17:13:56 -07001180 bool multiple_queues;
Jens Axboe73c10102011-03-08 13:19:51 +01001181};
Shaohua Li55c022b2011-07-08 08:19:20 +02001182#define BLK_MAX_REQUEST_COUNT 16
Shaohua Li50d24c32016-11-03 17:03:53 -07001183#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
Shaohua Li55c022b2011-07-08 08:19:20 +02001184
NeilBrown9cbb1752012-07-31 09:08:14 +02001185struct blk_plug_cb;
NeilBrown74018dc2012-07-31 09:08:15 +02001186typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
NeilBrown048c9372011-04-18 09:52:22 +02001187struct blk_plug_cb {
1188 struct list_head list;
NeilBrown9cbb1752012-07-31 09:08:14 +02001189 blk_plug_cb_fn callback;
1190 void *data;
NeilBrown048c9372011-04-18 09:52:22 +02001191};
NeilBrown9cbb1752012-07-31 09:08:14 +02001192extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1193 void *data, int size);
Jens Axboe73c10102011-03-08 13:19:51 +01001194extern void blk_start_plug(struct blk_plug *);
1195extern void blk_finish_plug(struct blk_plug *);
Jens Axboef6603782011-04-15 15:49:07 +02001196extern void blk_flush_plug_list(struct blk_plug *, bool);
Jens Axboe73c10102011-03-08 13:19:51 +01001197
1198static inline void blk_flush_plug(struct task_struct *tsk)
1199{
1200 struct blk_plug *plug = tsk->plug;
1201
Christoph Hellwig88b996c2011-04-15 15:20:10 +02001202 if (plug)
Jens Axboea237c1c2011-04-16 13:27:55 +02001203 blk_flush_plug_list(plug, false);
1204}
1205
1206static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1207{
1208 struct blk_plug *plug = tsk->plug;
1209
1210 if (plug)
Jens Axboef6603782011-04-15 15:49:07 +02001211 blk_flush_plug_list(plug, true);
Jens Axboe73c10102011-03-08 13:19:51 +01001212}
1213
1214static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1215{
1216 struct blk_plug *plug = tsk->plug;
1217
Jens Axboe320ae512013-10-24 09:20:05 +01001218 return plug &&
Jens Axboea1ce35f2018-10-29 10:23:51 -06001219 (!list_empty(&plug->mq_list) ||
Jens Axboe320ae512013-10-24 09:20:05 +01001220 !list_empty(&plug->cb_list));
Jens Axboe73c10102011-03-08 13:19:51 +01001221}
1222
Christoph Hellwigee472d82017-04-05 19:21:08 +02001223extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
1224extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1225 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
Christoph Hellwige950fdf2016-07-19 11:23:33 +02001226
1227#define BLKDEV_DISCARD_SECURE (1 << 0) /* issue a secure erase */
Christoph Hellwigdd3932e2010-09-16 20:51:46 +02001228
Dmitry Monakhovfbd9b092010-04-28 17:55:06 +04001229extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1230 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
Christoph Hellwig38f25252016-04-16 14:55:28 -04001231extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
Christoph Hellwig288dab82016-06-09 16:00:36 +02001232 sector_t nr_sects, gfp_t gfp_mask, int flags,
Mike Christie469e3212016-06-05 14:31:49 -05001233 struct bio **biop);
Christoph Hellwigee472d82017-04-05 19:21:08 +02001234
1235#define BLKDEV_ZERO_NOUNMAP (1 << 0) /* do not free blocks */
Christoph Hellwigcb365b92017-04-05 19:21:10 +02001236#define BLKDEV_ZERO_NOFALLBACK (1 << 1) /* don't write explicit zeroes */
Christoph Hellwigee472d82017-04-05 19:21:08 +02001237
Chaitanya Kulkarnie73c23f2016-11-30 12:28:58 -08001238extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1239 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
Christoph Hellwigee472d82017-04-05 19:21:08 +02001240 unsigned flags);
Dmitry Monakhov3f14d792010-04-28 17:55:09 +04001241extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
Christoph Hellwigee472d82017-04-05 19:21:08 +02001242 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1243
Christoph Hellwig2cf6d262010-08-18 05:29:10 -04001244static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1245 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
David Woodhousefb2dce82008-08-05 18:01:53 +01001246{
Bart Van Assche233bde22018-03-14 15:48:06 -07001247 return blkdev_issue_discard(sb->s_bdev,
1248 block << (sb->s_blocksize_bits -
1249 SECTOR_SHIFT),
1250 nr_blocks << (sb->s_blocksize_bits -
1251 SECTOR_SHIFT),
Christoph Hellwig2cf6d262010-08-18 05:29:10 -04001252 gfp_mask, flags);
David Woodhousefb2dce82008-08-05 18:01:53 +01001253}
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001254static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
Theodore Ts'oa107e5a2010-10-27 23:44:47 -04001255 sector_t nr_blocks, gfp_t gfp_mask)
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001256{
1257 return blkdev_issue_zeroout(sb->s_bdev,
Bart Van Assche233bde22018-03-14 15:48:06 -07001258 block << (sb->s_blocksize_bits -
1259 SECTOR_SHIFT),
1260 nr_blocks << (sb->s_blocksize_bits -
1261 SECTOR_SHIFT),
Christoph Hellwigee472d82017-04-05 19:21:08 +02001262 gfp_mask, 0);
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001263}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Christoph Hellwigf00c4d82017-11-05 10:36:31 +03001265extern int blk_verify_command(unsigned char *cmd, fmode_t mode);
Adel Gadllah0b07de82008-06-26 13:48:27 +02001266
Martin K. Peterseneb28d312010-02-26 00:20:37 -05001267enum blk_default_limits {
1268 BLK_MAX_SEGMENTS = 128,
1269 BLK_SAFE_MAX_SECTORS = 255,
Jeff Moyerd2be5372015-08-13 14:57:57 -04001270 BLK_DEF_MAX_SECTORS = 2560,
Martin K. Peterseneb28d312010-02-26 00:20:37 -05001271 BLK_MAX_SEGMENT_SIZE = 65536,
1272 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1273};
Milan Broz0e435ac2008-12-03 12:55:08 +01001274
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001275static inline unsigned long queue_segment_boundary(const struct request_queue *q)
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001276{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001277 return q->limits.seg_boundary_mask;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001278}
1279
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001280static inline unsigned long queue_virt_boundary(const struct request_queue *q)
Keith Busch03100aa2015-08-19 14:24:05 -07001281{
1282 return q->limits.virt_boundary_mask;
1283}
1284
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001285static inline unsigned int queue_max_sectors(const struct request_queue *q)
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001286{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001287 return q->limits.max_sectors;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001288}
1289
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001290static inline unsigned int queue_max_hw_sectors(const struct request_queue *q)
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001291{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001292 return q->limits.max_hw_sectors;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001293}
1294
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001295static inline unsigned short queue_max_segments(const struct request_queue *q)
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001296{
Martin K. Petersen8a783622010-02-26 00:20:39 -05001297 return q->limits.max_segments;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001298}
1299
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001300static inline unsigned short queue_max_discard_segments(const struct request_queue *q)
Christoph Hellwig1e739732017-02-08 14:46:49 +01001301{
1302 return q->limits.max_discard_segments;
1303}
1304
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001305static inline unsigned int queue_max_segment_size(const struct request_queue *q)
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001306{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001307 return q->limits.max_segment_size;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001308}
1309
Keith Busch0512a752020-05-12 17:55:47 +09001310static inline unsigned int queue_max_zone_append_sectors(const struct request_queue *q)
1311{
1312 return q->limits.max_zone_append_sectors;
1313}
1314
Mikulas Patockaad6bf882020-01-15 08:35:25 -05001315static inline unsigned queue_logical_block_size(const struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
1317 int retval = 512;
1318
Martin K. Petersen025146e2009-05-22 17:17:51 -04001319 if (q && q->limits.logical_block_size)
1320 retval = q->limits.logical_block_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
1322 return retval;
1323}
1324
Mikulas Patockaad6bf882020-01-15 08:35:25 -05001325static inline unsigned int bdev_logical_block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326{
Martin K. Petersene1defc42009-05-22 17:17:49 -04001327 return queue_logical_block_size(bdev_get_queue(bdev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328}
1329
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001330static inline unsigned int queue_physical_block_size(const struct request_queue *q)
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001331{
1332 return q->limits.physical_block_size;
1333}
1334
Martin K. Petersen892b6f92010-10-13 21:18:03 +02001335static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
Martin K. Petersenac481c22009-10-03 20:52:01 +02001336{
1337 return queue_physical_block_size(bdev_get_queue(bdev));
1338}
1339
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001340static inline unsigned int queue_io_min(const struct request_queue *q)
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001341{
1342 return q->limits.io_min;
1343}
1344
Martin K. Petersenac481c22009-10-03 20:52:01 +02001345static inline int bdev_io_min(struct block_device *bdev)
1346{
1347 return queue_io_min(bdev_get_queue(bdev));
1348}
1349
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001350static inline unsigned int queue_io_opt(const struct request_queue *q)
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001351{
1352 return q->limits.io_opt;
1353}
1354
Martin K. Petersenac481c22009-10-03 20:52:01 +02001355static inline int bdev_io_opt(struct block_device *bdev)
1356{
1357 return queue_io_opt(bdev_get_queue(bdev));
1358}
1359
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001360static inline int queue_alignment_offset(const struct request_queue *q)
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001361{
Martin K. Petersenac481c22009-10-03 20:52:01 +02001362 if (q->limits.misaligned)
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001363 return -1;
1364
Martin K. Petersenac481c22009-10-03 20:52:01 +02001365 return q->limits.alignment_offset;
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001366}
1367
Martin K. Petersene03a72e2010-01-11 03:21:51 -05001368static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
Martin K. Petersen81744ee2009-12-29 08:35:35 +01001369{
1370 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
Bart Van Assche233bde22018-03-14 15:48:06 -07001371 unsigned int alignment = sector_div(sector, granularity >> SECTOR_SHIFT)
1372 << SECTOR_SHIFT;
Martin K. Petersen81744ee2009-12-29 08:35:35 +01001373
Mike Snitzerb8839b82014-10-08 18:26:13 -04001374 return (granularity + lim->alignment_offset - alignment) % granularity;
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001375}
1376
Martin K. Petersenac481c22009-10-03 20:52:01 +02001377static inline int bdev_alignment_offset(struct block_device *bdev)
1378{
1379 struct request_queue *q = bdev_get_queue(bdev);
1380
1381 if (q->limits.misaligned)
1382 return -1;
1383
1384 if (bdev != bdev->bd_contains)
1385 return bdev->bd_part->alignment_offset;
1386
1387 return q->limits.alignment_offset;
1388}
1389
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001390static inline int queue_discard_alignment(const struct request_queue *q)
Martin K. Petersen86b37282009-11-10 11:50:21 +01001391{
1392 if (q->limits.discard_misaligned)
1393 return -1;
1394
1395 return q->limits.discard_alignment;
1396}
1397
Martin K. Petersene03a72e2010-01-11 03:21:51 -05001398static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
Martin K. Petersen86b37282009-11-10 11:50:21 +01001399{
Linus Torvalds59771072012-12-19 07:18:35 -08001400 unsigned int alignment, granularity, offset;
Martin K. Petersendd3d1452010-01-11 03:21:48 -05001401
Martin K. Petersena934a002011-05-18 10:37:35 +02001402 if (!lim->max_discard_sectors)
1403 return 0;
1404
Linus Torvalds59771072012-12-19 07:18:35 -08001405 /* Why are these in bytes, not sectors? */
Bart Van Assche233bde22018-03-14 15:48:06 -07001406 alignment = lim->discard_alignment >> SECTOR_SHIFT;
1407 granularity = lim->discard_granularity >> SECTOR_SHIFT;
Linus Torvalds59771072012-12-19 07:18:35 -08001408 if (!granularity)
1409 return 0;
1410
1411 /* Offset of the partition start in 'granularity' sectors */
1412 offset = sector_div(sector, granularity);
1413
1414 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1415 offset = (granularity + alignment - offset) % granularity;
1416
1417 /* Turn it back into bytes, gaah */
Bart Van Assche233bde22018-03-14 15:48:06 -07001418 return offset << SECTOR_SHIFT;
Martin K. Petersen86b37282009-11-10 11:50:21 +01001419}
1420
Paolo Bonzinic6e66632012-08-02 09:48:50 +02001421static inline int bdev_discard_alignment(struct block_device *bdev)
1422{
1423 struct request_queue *q = bdev_get_queue(bdev);
1424
1425 if (bdev != bdev->bd_contains)
1426 return bdev->bd_part->discard_alignment;
1427
1428 return q->limits.discard_alignment;
1429}
1430
Martin K. Petersen4363ac72012-09-18 12:19:27 -04001431static inline unsigned int bdev_write_same(struct block_device *bdev)
1432{
1433 struct request_queue *q = bdev_get_queue(bdev);
1434
1435 if (q)
1436 return q->limits.max_write_same_sectors;
1437
1438 return 0;
1439}
1440
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -08001441static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1442{
1443 struct request_queue *q = bdev_get_queue(bdev);
1444
1445 if (q)
1446 return q->limits.max_write_zeroes_sectors;
1447
1448 return 0;
1449}
1450
Damien Le Moal797476b2016-10-18 15:40:29 +09001451static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1452{
1453 struct request_queue *q = bdev_get_queue(bdev);
1454
1455 if (q)
1456 return blk_queue_zoned_model(q);
1457
1458 return BLK_ZONED_NONE;
1459}
1460
1461static inline bool bdev_is_zoned(struct block_device *bdev)
1462{
1463 struct request_queue *q = bdev_get_queue(bdev);
1464
1465 if (q)
1466 return blk_queue_is_zoned(q);
1467
1468 return false;
1469}
1470
Damien Le Moal113ab722019-07-10 13:53:10 +09001471static inline sector_t bdev_zone_sectors(struct block_device *bdev)
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +09001472{
1473 struct request_queue *q = bdev_get_queue(bdev);
1474
1475 if (q)
Damien Le Moalf99e8642017-01-12 07:58:32 -07001476 return blk_queue_zone_sectors(q);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +09001477 return 0;
1478}
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +09001479
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001480static inline int queue_dma_alignment(const struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481{
Pete Wyckoff482eb682008-01-01 10:23:02 -05001482 return q ? q->dma_alignment : 511;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483}
1484
Namhyung Kim14417792010-09-15 13:08:27 +02001485static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
FUJITA Tomonori87904072008-08-28 15:05:58 +09001486 unsigned int len)
1487{
1488 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
Namhyung Kim14417792010-09-15 13:08:27 +02001489 return !(addr & alignment) && !(len & alignment);
FUJITA Tomonori87904072008-08-28 15:05:58 +09001490}
1491
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492/* assumes size > 256 */
1493static inline unsigned int blksize_bits(unsigned int size)
1494{
1495 unsigned int bits = 8;
1496 do {
1497 bits++;
1498 size >>= 1;
1499 } while (size > 256);
1500 return bits;
1501}
1502
Adrian Bunk2befb9e2005-09-10 00:27:17 -07001503static inline unsigned int block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
1505 return bdev->bd_block_size;
1506}
1507
Jens Axboe59c3d452014-04-08 09:15:35 -06001508int kblockd_schedule_work(struct work_struct *work);
Jens Axboe818cd1c2017-04-10 09:54:55 -06001509int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1512 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1513#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1514 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1515
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001516#if defined(CONFIG_BLK_DEV_INTEGRITY)
1517
Martin K. Petersen8288f492014-09-26 19:20:02 -04001518enum blk_integrity_flags {
1519 BLK_INTEGRITY_VERIFY = 1 << 0,
1520 BLK_INTEGRITY_GENERATE = 1 << 1,
Martin K. Petersen3aec2f42014-09-26 19:20:03 -04001521 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
Martin K. Petersenaae7df52014-09-26 19:20:05 -04001522 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
Martin K. Petersen8288f492014-09-26 19:20:02 -04001523};
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001524
Martin K. Petersen18593082014-09-26 19:20:01 -04001525struct blk_integrity_iter {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001526 void *prot_buf;
1527 void *data_buf;
Martin K. Petersen3be91c42014-09-26 19:19:59 -04001528 sector_t seed;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001529 unsigned int data_size;
Martin K. Petersen3be91c42014-09-26 19:19:59 -04001530 unsigned short interval;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001531 const char *disk_name;
1532};
1533
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +02001534typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
Max Gurtovoy54d4e6a2019-09-16 18:44:29 +03001535typedef void (integrity_prepare_fn) (struct request *);
1536typedef void (integrity_complete_fn) (struct request *, unsigned int);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001537
Martin K. Petersen0f8087e2015-10-21 13:19:33 -04001538struct blk_integrity_profile {
1539 integrity_processing_fn *generate_fn;
1540 integrity_processing_fn *verify_fn;
Max Gurtovoy54d4e6a2019-09-16 18:44:29 +03001541 integrity_prepare_fn *prepare_fn;
1542 integrity_complete_fn *complete_fn;
Martin K. Petersen0f8087e2015-10-21 13:19:33 -04001543 const char *name;
1544};
1545
Martin K. Petersen25520d52015-10-21 13:19:49 -04001546extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001547extern void blk_integrity_unregister(struct gendisk *);
Martin K. Petersenad7fce92008-10-01 03:38:39 -04001548extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001549extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1550 struct scatterlist *);
1551extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001552extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1553 struct request *);
1554extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1555 struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001556
Martin K. Petersen25520d52015-10-21 13:19:49 -04001557static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1558{
Dan Williamsac6fc482015-10-21 13:20:18 -04001559 struct blk_integrity *bi = &disk->queue->integrity;
Martin K. Petersen25520d52015-10-21 13:19:49 -04001560
1561 if (!bi->profile)
1562 return NULL;
1563
1564 return bi;
1565}
1566
Jens Axboeb04accc2008-10-02 12:53:22 +02001567static inline
1568struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
1569{
Martin K. Petersen25520d52015-10-21 13:19:49 -04001570 return blk_get_integrity(bdev->bd_disk);
Martin K. Petersenb02739b2008-10-02 18:47:49 +02001571}
1572
Martin K. Petersen180b2f92014-09-26 19:19:56 -04001573static inline bool blk_integrity_rq(struct request *rq)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001574{
Martin K. Petersen180b2f92014-09-26 19:19:56 -04001575 return rq->cmd_flags & REQ_INTEGRITY;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001576}
1577
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001578static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1579 unsigned int segs)
1580{
1581 q->limits.max_integrity_segments = segs;
1582}
1583
1584static inline unsigned short
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001585queue_max_integrity_segments(const struct request_queue *q)
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001586{
1587 return q->limits.max_integrity_segments;
1588}
1589
Greg Edwards359f6422018-07-25 10:22:58 -04001590/**
1591 * bio_integrity_intervals - Return number of integrity intervals for a bio
1592 * @bi: blk_integrity profile for device
1593 * @sectors: Size of the bio in 512-byte sectors
1594 *
1595 * Description: The block layer calculates everything in 512 byte
1596 * sectors but integrity metadata is done in terms of the data integrity
1597 * interval size of the storage device. Convert the block layer sectors
1598 * to the appropriate number of integrity intervals.
1599 */
1600static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1601 unsigned int sectors)
1602{
1603 return sectors >> (bi->interval_exp - 9);
1604}
1605
1606static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1607 unsigned int sectors)
1608{
1609 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
1610}
1611
Christoph Hellwig2a876f52019-03-03 08:38:29 -07001612/*
1613 * Return the first bvec that contains integrity data. Only drivers that are
1614 * limited to a single integrity segment should use this helper.
1615 */
1616static inline struct bio_vec *rq_integrity_vec(struct request *rq)
1617{
1618 if (WARN_ON_ONCE(queue_max_integrity_segments(rq->q) > 1))
1619 return NULL;
1620 return rq->bio->bi_integrity->bip_vec;
1621}
1622
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001623#else /* CONFIG_BLK_DEV_INTEGRITY */
1624
Stephen Rothwellfd832402012-01-12 09:17:30 +01001625struct bio;
1626struct block_device;
1627struct gendisk;
1628struct blk_integrity;
1629
1630static inline int blk_integrity_rq(struct request *rq)
1631{
1632 return 0;
1633}
1634static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1635 struct bio *b)
1636{
1637 return 0;
1638}
1639static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1640 struct bio *b,
1641 struct scatterlist *s)
1642{
1643 return 0;
1644}
1645static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1646{
Michele Curti61a04e52014-10-09 15:30:17 -07001647 return NULL;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001648}
1649static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1650{
1651 return NULL;
1652}
1653static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1654{
1655 return 0;
1656}
Martin K. Petersen25520d52015-10-21 13:19:49 -04001657static inline void blk_integrity_register(struct gendisk *d,
Stephen Rothwellfd832402012-01-12 09:17:30 +01001658 struct blk_integrity *b)
1659{
Stephen Rothwellfd832402012-01-12 09:17:30 +01001660}
1661static inline void blk_integrity_unregister(struct gendisk *d)
1662{
1663}
1664static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1665 unsigned int segs)
1666{
1667}
Bart Van Asscheaf2c68f2019-08-01 15:50:40 -07001668static inline unsigned short queue_max_integrity_segments(const struct request_queue *q)
Stephen Rothwellfd832402012-01-12 09:17:30 +01001669{
1670 return 0;
1671}
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001672static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1673 struct request *r1,
1674 struct request *r2)
Stephen Rothwellfd832402012-01-12 09:17:30 +01001675{
Martin K. Petersencb1a5ab2014-10-28 20:27:43 -06001676 return true;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001677}
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001678static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1679 struct request *r,
1680 struct bio *b)
Stephen Rothwellfd832402012-01-12 09:17:30 +01001681{
Martin K. Petersencb1a5ab2014-10-28 20:27:43 -06001682 return true;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001683}
Martin K. Petersen25520d52015-10-21 13:19:49 -04001684
Greg Edwards359f6422018-07-25 10:22:58 -04001685static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1686 unsigned int sectors)
1687{
1688 return 0;
1689}
1690
1691static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1692 unsigned int sectors)
1693{
1694 return 0;
1695}
1696
Christoph Hellwig2a876f52019-03-03 08:38:29 -07001697static inline struct bio_vec *rq_integrity_vec(struct request *rq)
1698{
1699 return NULL;
1700}
1701
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001702#endif /* CONFIG_BLK_DEV_INTEGRITY */
1703
Al Viro08f85852007-10-08 13:26:20 -04001704struct block_device_operations {
Al Virod4430d62008-03-02 09:09:22 -05001705 int (*open) (struct block_device *, fmode_t);
Al Virodb2a1442013-05-05 21:52:57 -04001706 void (*release) (struct gendisk *, fmode_t);
Tejun Heo3f289dc2018-07-18 04:47:36 -07001707 int (*rw_page)(struct block_device *, sector_t, struct page *, unsigned int);
Al Virod4430d62008-03-02 09:09:22 -05001708 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1709 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
Tejun Heo77ea8872010-12-08 20:57:37 +01001710 unsigned int (*check_events) (struct gendisk *disk,
1711 unsigned int clearing);
1712 /* ->media_changed() is DEPRECATED, use ->check_events() instead */
Al Viro08f85852007-10-08 13:26:20 -04001713 int (*media_changed) (struct gendisk *);
Tejun Heoc3e33e02010-05-15 20:09:29 +02001714 void (*unlock_native_capacity) (struct gendisk *);
Al Viro08f85852007-10-08 13:26:20 -04001715 int (*revalidate_disk) (struct gendisk *);
1716 int (*getgeo)(struct block_device *, struct hd_geometry *);
Nitin Guptab3a27d02010-05-17 11:02:43 +05301717 /* this callback is with swap_lock and sometimes page table lock held */
1718 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
Christoph Hellwige76239a2018-10-12 19:08:49 +09001719 int (*report_zones)(struct gendisk *, sector_t sector,
Christoph Hellwigd4100352019-11-11 11:39:30 +09001720 unsigned int nr_zones, report_zones_cb cb, void *data);
Christoph Hellwig348e1142020-03-27 09:07:17 +01001721 char *(*devnode)(struct gendisk *disk, umode_t *mode);
Al Viro08f85852007-10-08 13:26:20 -04001722 struct module *owner;
Christoph Hellwigbbd3e062015-10-15 14:10:48 +02001723 const struct pr_ops *pr_ops;
Al Viro08f85852007-10-08 13:26:20 -04001724};
1725
Arnd Bergmannee6a1292019-11-28 15:48:10 +01001726#ifdef CONFIG_COMPAT
1727extern int blkdev_compat_ptr_ioctl(struct block_device *, fmode_t,
1728 unsigned int, unsigned long);
1729#else
1730#define blkdev_compat_ptr_ioctl NULL
1731#endif
1732
Al Viro633a08b2007-08-29 20:34:12 -04001733extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1734 unsigned long);
Matthew Wilcox47a191f2014-06-04 16:07:46 -07001735extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1736extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1737 struct writeback_control *);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +09001738
1739#ifdef CONFIG_BLK_DEV_ZONED
1740bool blk_req_needs_zone_write_lock(struct request *rq);
Johannes Thumshirn1392d372020-05-12 17:55:48 +09001741bool blk_req_zone_write_trylock(struct request *rq);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +09001742void __blk_req_zone_write_lock(struct request *rq);
1743void __blk_req_zone_write_unlock(struct request *rq);
1744
1745static inline void blk_req_zone_write_lock(struct request *rq)
1746{
1747 if (blk_req_needs_zone_write_lock(rq))
1748 __blk_req_zone_write_lock(rq);
1749}
1750
1751static inline void blk_req_zone_write_unlock(struct request *rq)
1752{
1753 if (rq->rq_flags & RQF_ZONE_WRITE_LOCKED)
1754 __blk_req_zone_write_unlock(rq);
1755}
1756
1757static inline bool blk_req_zone_is_write_locked(struct request *rq)
1758{
1759 return rq->q->seq_zones_wlock &&
1760 test_bit(blk_rq_zone_no(rq), rq->q->seq_zones_wlock);
1761}
1762
1763static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1764{
1765 if (!blk_req_needs_zone_write_lock(rq))
1766 return true;
1767 return !blk_req_zone_is_write_locked(rq);
1768}
1769#else
1770static inline bool blk_req_needs_zone_write_lock(struct request *rq)
1771{
1772 return false;
1773}
1774
1775static inline void blk_req_zone_write_lock(struct request *rq)
1776{
1777}
1778
1779static inline void blk_req_zone_write_unlock(struct request *rq)
1780{
1781}
1782static inline bool blk_req_zone_is_write_locked(struct request *rq)
1783{
1784 return false;
1785}
1786
1787static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1788{
1789 return true;
1790}
1791#endif /* CONFIG_BLK_DEV_ZONED */
1792
David Howells93614012006-09-30 20:45:40 +02001793#else /* CONFIG_BLOCK */
Fabian Frederickac13a822014-06-04 16:06:27 -07001794
1795struct block_device;
1796
David Howells93614012006-09-30 20:45:40 +02001797/*
1798 * stubs for when the block layer is configured out
1799 */
1800#define buffer_heads_over_limit 0
1801
David Howells93614012006-09-30 20:45:40 +02001802static inline long nr_blockdev_pages(void)
1803{
1804 return 0;
1805}
1806
Jens Axboe1f940bd2011-03-11 20:17:08 +01001807struct blk_plug {
1808};
1809
1810static inline void blk_start_plug(struct blk_plug *plug)
Jens Axboe73c10102011-03-08 13:19:51 +01001811{
1812}
1813
Jens Axboe1f940bd2011-03-11 20:17:08 +01001814static inline void blk_finish_plug(struct blk_plug *plug)
Jens Axboe73c10102011-03-08 13:19:51 +01001815{
1816}
1817
Jens Axboe1f940bd2011-03-11 20:17:08 +01001818static inline void blk_flush_plug(struct task_struct *task)
Jens Axboe73c10102011-03-08 13:19:51 +01001819{
1820}
1821
Jens Axboea237c1c2011-04-16 13:27:55 +02001822static inline void blk_schedule_flush_plug(struct task_struct *task)
1823{
1824}
1825
1826
Jens Axboe73c10102011-03-08 13:19:51 +01001827static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1828{
1829 return false;
1830}
1831
Fabian Frederickac13a822014-06-04 16:06:27 -07001832static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
1833 sector_t *error_sector)
1834{
1835 return 0;
1836}
1837
David Howells93614012006-09-30 20:45:40 +02001838#endif /* CONFIG_BLOCK */
1839
Jens Axboe06193172018-11-13 21:16:54 -07001840static inline void blk_wake_io_task(struct task_struct *waiter)
1841{
1842 /*
1843 * If we're polling, the task itself is doing the completions. For
1844 * that case, we don't need to signal a wakeup, it's enough to just
1845 * mark us as RUNNING.
1846 */
1847 if (waiter == current)
1848 __set_current_state(TASK_RUNNING);
1849 else
1850 wake_up_process(waiter);
1851}
1852
Ming Leie6249cd2020-05-03 09:54:22 +08001853static inline void blk_io_schedule(void)
1854{
1855 /* Prevent hang_check timer from firing at us during very long I/O */
1856 unsigned long timeout = sysctl_hung_task_timeout_secs * HZ / 2;
1857
1858 if (timeout)
1859 io_schedule_timeout(timeout);
1860 else
1861 io_schedule();
1862}
1863
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864#endif