blob: 5c58a3b2bf0038083b9dc2b88293349fa8afb22b [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Paul Gortmakerde477252011-05-26 13:46:22 -040031struct module;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +010032struct scsi_ioctl_command;
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035struct elevator_queue;
Jens Axboe2056a782006-03-23 20:00:26 +010036struct blk_trace;
Jens Axboe3d6392c2007-07-09 12:38:05 +020037struct request;
38struct sg_io_hdr;
Mike Christieaa387cc2011-07-31 22:05:09 +020039struct bsg_job;
Tejun Heo3c798392012-04-16 13:57:25 -070040struct blkcg_gq;
Ming Lei7c94e1c2014-09-25 23:23:43 +080041struct blk_flush_queue;
Christoph Hellwigbbd3e062015-10-15 14:10:48 +020042struct pr_ops;
Josef Bacika7905042018-07-03 09:32:35 -060043struct rq_qos;
Omar Sandoval34dbad52017-03-21 08:56:08 -070044struct blk_queue_stats;
45struct blk_stat_callback;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47#define BLKDEV_MIN_RQ 4
48#define BLKDEV_MAX_RQ 128 /* Default maximum */
49
Minwoo Im096392e2018-02-15 23:53:17 +090050/* Must be consistent with blk_mq_poll_stats_bkt() */
Stephen Bates02063192017-04-20 16:59:11 -060051#define BLK_MQ_POLL_STATS_BKTS 16
52
Yufen Yu29ece8b2019-03-18 22:44:41 +080053/* Doing classic polling */
54#define BLK_MQ_POLL_CLASSIC -1
55
Tejun Heo8bd435b2012-04-13 13:11:28 -070056/*
57 * Maximum number of blkcg policies allowed to be registered concurrently.
58 * Defined here to simplify include dependency.
59 */
Jens Axboe01c5f852018-09-11 10:59:53 -060060#define BLKCG_MAX_POLS 5
Tejun Heo8bd435b2012-04-13 13:11:28 -070061
Christoph Hellwig2a842ac2017-06-03 09:38:04 +020062typedef void (rq_end_io_fn)(struct request *, blk_status_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Jens Axboe4aff5e22006-08-10 08:44:47 +020064/*
Christoph Hellwige8064022016-10-20 15:12:13 +020065 * request flags */
66typedef __u32 __bitwise req_flags_t;
67
68/* elevator knows about this request */
69#define RQF_SORTED ((__force req_flags_t)(1 << 0))
70/* drive already may have started this one */
71#define RQF_STARTED ((__force req_flags_t)(1 << 1))
Christoph Hellwige8064022016-10-20 15:12:13 +020072/* may not be passed by ioscheduler */
73#define RQF_SOFTBARRIER ((__force req_flags_t)(1 << 3))
74/* request for flush sequence */
75#define RQF_FLUSH_SEQ ((__force req_flags_t)(1 << 4))
76/* merge of different types, fail separately */
77#define RQF_MIXED_MERGE ((__force req_flags_t)(1 << 5))
78/* track inflight for MQ */
79#define RQF_MQ_INFLIGHT ((__force req_flags_t)(1 << 6))
80/* don't call prep for this one */
81#define RQF_DONTPREP ((__force req_flags_t)(1 << 7))
82/* set for "ide_preempt" requests and also for requests for which the SCSI
83 "quiesce" state must be ignored. */
84#define RQF_PREEMPT ((__force req_flags_t)(1 << 8))
85/* contains copies of user pages */
86#define RQF_COPY_USER ((__force req_flags_t)(1 << 9))
87/* vaguely specified driver internal error. Ignored by the block layer */
88#define RQF_FAILED ((__force req_flags_t)(1 << 10))
89/* don't warn about errors */
90#define RQF_QUIET ((__force req_flags_t)(1 << 11))
91/* elevator private data attached */
92#define RQF_ELVPRIV ((__force req_flags_t)(1 << 12))
Konstantin Khlebnikov4822e902018-10-11 10:07:06 +030093/* account into disk and partition IO statistics */
Christoph Hellwige8064022016-10-20 15:12:13 +020094#define RQF_IO_STAT ((__force req_flags_t)(1 << 13))
95/* request came from our alloc pool */
96#define RQF_ALLOCED ((__force req_flags_t)(1 << 14))
97/* runtime pm request */
98#define RQF_PM ((__force req_flags_t)(1 << 15))
99/* on IO scheduler merge hash */
100#define RQF_HASHED ((__force req_flags_t)(1 << 16))
Konstantin Khlebnikov4822e902018-10-11 10:07:06 +0300101/* track IO completion time */
Jens Axboecf43e6b2016-11-07 21:32:37 -0700102#define RQF_STATS ((__force req_flags_t)(1 << 17))
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700103/* Look at ->special_vec for the actual data payload instead of the
104 bio chain. */
105#define RQF_SPECIAL_PAYLOAD ((__force req_flags_t)(1 << 18))
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900106/* The per-zone write lock is held for this request */
107#define RQF_ZONE_WRITE_LOCKED ((__force req_flags_t)(1 << 19))
Jens Axboe76a86f92018-01-10 11:30:56 -0700108/* already slept for hybrid poll */
Keith Busch12f5b932018-05-29 15:52:28 +0200109#define RQF_MQ_POLL_SLEPT ((__force req_flags_t)(1 << 20))
Christoph Hellwigda661262018-06-14 13:58:45 +0200110/* ->timeout has been called, don't expire again */
111#define RQF_TIMED_OUT ((__force req_flags_t)(1 << 21))
Christoph Hellwige8064022016-10-20 15:12:13 +0200112
113/* flags that prevent us from merging requests: */
114#define RQF_NOMERGE_FLAGS \
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700115 (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
Christoph Hellwige8064022016-10-20 15:12:13 +0200116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117/*
Keith Busch12f5b932018-05-29 15:52:28 +0200118 * Request state for blk-mq.
119 */
120enum mq_rq_state {
121 MQ_RQ_IDLE = 0,
122 MQ_RQ_IN_FLIGHT = 1,
123 MQ_RQ_COMPLETE = 2,
124};
125
126/*
Christoph Hellwigaf76e552014-05-06 12:12:45 +0200127 * Try to put the fields that are referenced together in the same cacheline.
128 *
129 * If you modify this structure, make sure to update blk_rq_init() and
130 * especially blk_mq_rq_ctx_init() to take care of the added fields.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 */
132struct request {
Jens Axboe165125e2007-07-24 09:28:11 +0200133 struct request_queue *q;
Jens Axboe320ae512013-10-24 09:20:05 +0100134 struct blk_mq_ctx *mq_ctx;
Jens Axboeea4f9952018-10-29 15:06:13 -0600135 struct blk_mq_hw_ctx *mq_hctx;
Jens Axboee6a1c872006-08-10 09:00:21 +0200136
Christoph Hellwigef295ec2016-10-28 08:48:16 -0600137 unsigned int cmd_flags; /* op and common flags */
Christoph Hellwige8064022016-10-20 15:12:13 +0200138 req_flags_t rq_flags;
Jens Axboed486f1f2017-01-31 12:34:41 -0700139
140 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 */
Jens Axboebd166ef2017-01-17 06:03:22 -0700144 int tag;
Richard Kennedy181fdde2010-03-19 08:58:16 +0100145 sector_t __sector; /* sector cursor */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147 struct bio *bio;
148 struct bio *biotail;
149
Jens Axboe7c3fb702018-01-10 11:46:39 -0700150 struct list_head queuelist;
151
Jens Axboe360f92c2014-04-09 20:27:01 -0600152 /*
153 * The hash is used inside the scheduler, and killed once the
154 * request reaches the dispatch list. The ipi_list is only used
155 * to queue the request for softirq completion, which is long
156 * after the request has been unhashed (and even removed from
157 * the dispatch list).
158 */
159 union {
160 struct hlist_node hash; /* merge hash */
161 struct list_head ipi_list;
162 };
163
Jens Axboee6a1c872006-08-10 09:00:21 +0200164 /*
165 * The rb_node is only used inside the io scheduler, requests
166 * are pruned when moved to the dispatch queue. So let the
Mike Snitzerc1867942011-02-11 11:08:00 +0100167 * completion_data share space with the rb_node.
Jens Axboee6a1c872006-08-10 09:00:21 +0200168 */
169 union {
170 struct rb_node rb_node; /* sort/lookup */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700171 struct bio_vec special_vec;
Mike Snitzerc1867942011-02-11 11:08:00 +0100172 void *completion_data;
Christoph Hellwige26738e2017-04-20 16:03:11 +0200173 int error_count; /* for legacy drivers, don't use */
Jens Axboee6a1c872006-08-10 09:00:21 +0200174 };
Jens Axboe98170642006-07-28 09:23:08 +0200175
Jens Axboeff7d1452006-07-12 14:04:37 +0200176 /*
Vivek Goyal7f1dc8a2010-04-21 17:44:16 +0200177 * Three pointers are available for the IO schedulers, if they need
Mike Snitzerc1867942011-02-11 11:08:00 +0100178 * more they have to dynamically allocate it. Flush requests are
179 * never put on the IO scheduler. So let the flush fields share
Tejun Heoa612fdd2011-12-14 00:33:41 +0100180 * space with the elevator data.
Jens Axboeff7d1452006-07-12 14:04:37 +0200181 */
Mike Snitzerc1867942011-02-11 11:08:00 +0100182 union {
Tejun Heoa612fdd2011-12-14 00:33:41 +0100183 struct {
184 struct io_cq *icq;
185 void *priv[2];
186 } elv;
187
Mike Snitzerc1867942011-02-11 11:08:00 +0100188 struct {
189 unsigned int seq;
190 struct list_head list;
Jeff Moyer4853aba2011-08-15 21:37:25 +0200191 rq_end_io_fn *saved_end_io;
Mike Snitzerc1867942011-02-11 11:08:00 +0100192 } flush;
193 };
Jens Axboeff7d1452006-07-12 14:04:37 +0200194
Jens Axboe8f34ee72006-06-13 09:02:34 +0200195 struct gendisk *rq_disk;
Jerome Marchand09e099d2011-01-05 16:57:38 +0100196 struct hd_struct *part;
Omar Sandoval522a7772018-05-09 02:08:53 -0700197 /* Time that I/O was submitted to the kernel. */
198 u64 start_time_ns;
Omar Sandoval544ccc8d2018-05-09 02:08:50 -0700199 /* Time that I/O was submitted to the device. */
200 u64 io_start_time_ns;
201
202#ifdef CONFIG_BLK_WBT
203 unsigned short wbt_flags;
204#endif
205#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
206 unsigned short throtl_size;
207#endif
208
209 /*
210 * Number of scatter-gather DMA addr+len pairs after
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 * physical address coalescing is performed.
212 */
213 unsigned short nr_phys_segments;
Jens Axboe7c3fb702018-01-10 11:46:39 -0700214
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200215#if defined(CONFIG_BLK_DEV_INTEGRITY)
216 unsigned short nr_integrity_segments;
217#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Jens Axboe7c3fb702018-01-10 11:46:39 -0700219 unsigned short write_hint;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200220 unsigned short ioprio;
221
FUJITA Tomonori7a85f882008-03-04 11:17:11 +0100222 unsigned int extra_len; /* length of alignment and padding */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Keith Busch12f5b932018-05-29 15:52:28 +0200224 enum mq_rq_state state;
225 refcount_t ref;
Tejun Heo1d9bd512018-01-09 08:29:48 -0800226
Jens Axboe0b7576d2018-05-29 08:47:57 -0600227 unsigned int timeout;
Christoph Hellwig079076b2018-11-14 17:02:05 +0100228 unsigned long deadline;
Jens Axboe0a72e7f2018-01-09 14:23:42 -0700229
Jens Axboe7c3fb702018-01-10 11:46:39 -0700230 union {
Linus Torvalds0a4b6e22018-01-29 11:51:49 -0800231 struct __call_single_data csd;
Jens Axboe7c3fb702018-01-10 11:46:39 -0700232 u64 fifo_time;
233 };
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 /*
Jens Axboec00895a2006-09-30 20:29:12 +0200236 * completion callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 */
238 rq_end_io_fn *end_io;
239 void *end_io_data;
240};
241
Ming Lei14cb0dc2017-12-18 15:40:43 +0800242static inline bool blk_op_is_scsi(unsigned int op)
243{
244 return op == REQ_OP_SCSI_IN || op == REQ_OP_SCSI_OUT;
245}
246
247static inline bool blk_op_is_private(unsigned int op)
248{
249 return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
250}
251
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100252static inline bool blk_rq_is_scsi(struct request *rq)
253{
Ming Lei14cb0dc2017-12-18 15:40:43 +0800254 return blk_op_is_scsi(req_op(rq));
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100255}
256
257static inline bool blk_rq_is_private(struct request *rq)
258{
Ming Lei14cb0dc2017-12-18 15:40:43 +0800259 return blk_op_is_private(req_op(rq));
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100260}
261
Christoph Hellwig57292b52017-01-31 16:57:29 +0100262static inline bool blk_rq_is_passthrough(struct request *rq)
263{
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100264 return blk_rq_is_scsi(rq) || blk_rq_is_private(rq);
Christoph Hellwig57292b52017-01-31 16:57:29 +0100265}
266
Ming Lei14cb0dc2017-12-18 15:40:43 +0800267static inline bool bio_is_passthrough(struct bio *bio)
268{
269 unsigned op = bio_op(bio);
270
271 return blk_op_is_scsi(op) || blk_op_is_private(op);
272}
273
Fernando Luis Vázquez Cao766ca442008-08-14 09:59:13 +0200274static inline unsigned short req_get_ioprio(struct request *req)
275{
276 return req->ioprio;
277}
278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279#include <linux/elevator.h>
280
Jens Axboe320ae512013-10-24 09:20:05 +0100281struct blk_queue_ctx;
282
Jens Axboedece1632015-11-05 10:41:16 -0700283typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285struct bio_vec;
Tejun Heo2fb98e82008-02-19 11:36:53 +0100286typedef int (dma_drain_needed_fn)(struct request *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Jens Axboe242f9dc2008-09-14 05:55:09 -0700288enum blk_eh_timer_return {
Christoph Hellwig88b0cfa2018-05-29 15:52:38 +0200289 BLK_EH_DONE, /* drivers has completed the command */
290 BLK_EH_RESET_TIMER, /* reset timer and try again */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700291};
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293enum blk_queue_state {
294 Queue_down,
295 Queue_up,
296};
297
Shaohua Liee1b6f72015-01-15 17:32:25 -0800298#define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
299#define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900301#define BLK_SCSI_MAX_CMDS (256)
302#define BLK_SCSI_CMD_PER_LONG (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
303
Damien Le Moal797476b2016-10-18 15:40:29 +0900304/*
305 * Zoned block device models (zoned limit).
306 */
307enum blk_zoned_model {
308 BLK_ZONED_NONE, /* Regular block device */
309 BLK_ZONED_HA, /* Host-aware zoned block device */
310 BLK_ZONED_HM, /* Host-managed zoned block device */
311};
312
Martin K. Petersen025146e2009-05-22 17:17:51 -0400313struct queue_limits {
314 unsigned long bounce_pfn;
315 unsigned long seg_boundary_mask;
Keith Busch03100aa2015-08-19 14:24:05 -0700316 unsigned long virt_boundary_mask;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400317
318 unsigned int max_hw_sectors;
Martin K. Petersenca369d52015-11-13 16:46:48 -0500319 unsigned int max_dev_sectors;
Jens Axboe762380a2014-06-05 13:38:39 -0600320 unsigned int chunk_sectors;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400321 unsigned int max_sectors;
322 unsigned int max_segment_size;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400323 unsigned int physical_block_size;
324 unsigned int alignment_offset;
325 unsigned int io_min;
326 unsigned int io_opt;
Christoph Hellwig67efc922009-09-30 13:54:20 +0200327 unsigned int max_discard_sectors;
Jens Axboe0034af02015-07-16 09:14:26 -0600328 unsigned int max_hw_discard_sectors;
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400329 unsigned int max_write_same_sectors;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800330 unsigned int max_write_zeroes_sectors;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100331 unsigned int discard_granularity;
332 unsigned int discard_alignment;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400333
334 unsigned short logical_block_size;
Martin K. Petersen8a783622010-02-26 00:20:39 -0500335 unsigned short max_segments;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200336 unsigned short max_integrity_segments;
Christoph Hellwig1e739732017-02-08 14:46:49 +0100337 unsigned short max_discard_segments;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400338
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400339 unsigned char misaligned;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100340 unsigned char discard_misaligned;
Kent Overstreetc78afc62013-07-11 22:39:53 -0700341 unsigned char raid_partial_stripes_expensive;
Damien Le Moal797476b2016-10-18 15:40:29 +0900342 enum blk_zoned_model zoned;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400343};
344
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900345#ifdef CONFIG_BLK_DEV_ZONED
346
Damien Le Moala91e1382018-10-12 19:08:43 +0900347extern unsigned int blkdev_nr_zones(struct block_device *bdev);
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900348extern int blkdev_report_zones(struct block_device *bdev,
349 sector_t sector, struct blk_zone *zones,
350 unsigned int *nr_zones, gfp_t gfp_mask);
351extern int blkdev_reset_zones(struct block_device *bdev, sector_t sectors,
352 sector_t nr_sectors, gfp_t gfp_mask);
Damien Le Moalbf505452018-10-12 19:08:50 +0900353extern int blk_revalidate_disk_zones(struct gendisk *disk);
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900354
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900355extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
356 unsigned int cmd, unsigned long arg);
357extern int blkdev_reset_zones_ioctl(struct block_device *bdev, fmode_t mode,
358 unsigned int cmd, unsigned long arg);
359
360#else /* CONFIG_BLK_DEV_ZONED */
361
Damien Le Moala91e1382018-10-12 19:08:43 +0900362static inline unsigned int blkdev_nr_zones(struct block_device *bdev)
363{
364 return 0;
365}
Damien Le Moalbf505452018-10-12 19:08:50 +0900366
367static inline int blk_revalidate_disk_zones(struct gendisk *disk)
368{
369 return 0;
370}
371
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900372static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
373 fmode_t mode, unsigned int cmd,
374 unsigned long arg)
375{
376 return -ENOTTY;
377}
378
379static inline int blkdev_reset_zones_ioctl(struct block_device *bdev,
380 fmode_t mode, unsigned int cmd,
381 unsigned long arg)
382{
383 return -ENOTTY;
384}
385
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900386#endif /* CONFIG_BLK_DEV_ZONED */
387
Richard Kennedyd7b76302011-07-13 21:17:23 +0200388struct request_queue {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 /*
390 * Together with queue_head for cacheline sharing
391 */
392 struct list_head queue_head;
393 struct request *last_merge;
Jens Axboeb374d182008-10-31 10:05:07 +0100394 struct elevator_queue *elevator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Omar Sandoval34dbad52017-03-21 08:56:08 -0700396 struct blk_queue_stats *stats;
Josef Bacika7905042018-07-03 09:32:35 -0600397 struct rq_qos *rq_qos;
Jens Axboe87760e52016-11-09 12:38:14 -0700398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 make_request_fn *make_request_fn;
Tejun Heo2fb98e82008-02-19 11:36:53 +0100400 dma_drain_needed_fn *dma_drain_needed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Jens Axboef8a5b122016-12-13 09:24:51 -0700402 const struct blk_mq_ops *mq_ops;
Jens Axboe320ae512013-10-24 09:20:05 +0100403
Jens Axboe320ae512013-10-24 09:20:05 +0100404 /* sw queues */
Ming Leie6cdb092014-06-03 11:24:06 +0800405 struct blk_mq_ctx __percpu *queue_ctx;
Jens Axboe320ae512013-10-24 09:20:05 +0100406 unsigned int nr_queues;
407
Jens Axboed278d4a2016-03-30 10:21:08 -0600408 unsigned int queue_depth;
409
Jens Axboe320ae512013-10-24 09:20:05 +0100410 /* hw dispatch queues */
411 struct blk_mq_hw_ctx **queue_hw_ctx;
412 unsigned int nr_hw_queues;
413
Jan Karadc3b17c2017-02-02 15:56:50 +0100414 struct backing_dev_info *backing_dev_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416 /*
417 * The queue owner gets to use this for whatever they like.
418 * ll_rw_blk doesn't touch it.
419 */
420 void *queuedata;
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 * various queue flags, see QUEUE_* below
424 */
425 unsigned long queue_flags;
Bart Van Asschecd84a622018-09-26 14:01:04 -0700426 /*
427 * Number of contexts that have called blk_set_pm_only(). If this
428 * counter is above zero then only RQF_PM and RQF_PREEMPT requests are
429 * processed.
430 */
431 atomic_t pm_only;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
433 /*
Tejun Heoa73f7302011-12-14 00:33:37 +0100434 * ida allocated id for this queue. Used to index queues from
435 * ioctx.
436 */
437 int id;
438
439 /*
Richard Kennedyd7b76302011-07-13 21:17:23 +0200440 * queue needs bounce pages for pages above this limit
441 */
442 gfp_t bounce_gfp;
443
Christoph Hellwig0d945c12018-11-15 12:17:28 -0700444 spinlock_t queue_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
446 /*
447 * queue kobject
448 */
449 struct kobject kobj;
450
Jens Axboe320ae512013-10-24 09:20:05 +0100451 /*
452 * mq queue kobject
453 */
Ming Lei1db49092018-11-20 09:44:35 +0800454 struct kobject *mq_kobj;
Jens Axboe320ae512013-10-24 09:20:05 +0100455
Dan Williamsac6fc482015-10-21 13:20:18 -0400456#ifdef CONFIG_BLK_DEV_INTEGRITY
457 struct blk_integrity integrity;
458#endif /* CONFIG_BLK_DEV_INTEGRITY */
459
Rafael J. Wysocki47fafbc2014-12-04 01:00:23 +0100460#ifdef CONFIG_PM
Lin Ming6c954662013-03-23 11:42:26 +0800461 struct device *dev;
462 int rpm_status;
463 unsigned int nr_pending;
464#endif
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 /*
467 * queue settings
468 */
469 unsigned long nr_requests; /* Max # of requests */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
James Bottomleyfa0ccd82008-01-10 11:30:36 -0600471 unsigned int dma_drain_size;
Richard Kennedyd7b76302011-07-13 21:17:23 +0200472 void *dma_drain_buffer;
Tejun Heoe3790c72008-03-04 11:18:17 +0100473 unsigned int dma_pad_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 unsigned int dma_alignment;
475
Jens Axboe242f9dc2008-09-14 05:55:09 -0700476 unsigned int rq_timeout;
Jens Axboe64f1c212016-11-14 13:03:03 -0700477 int poll_nsec;
Omar Sandoval34dbad52017-03-21 08:56:08 -0700478
479 struct blk_stat_callback *poll_cb;
Stephen Bates02063192017-04-20 16:59:11 -0600480 struct blk_rq_stat poll_stat[BLK_MQ_POLL_STATS_BKTS];
Omar Sandoval34dbad52017-03-21 08:56:08 -0700481
Jens Axboe242f9dc2008-09-14 05:55:09 -0700482 struct timer_list timeout;
Christoph Hellwig287922e2015-10-30 20:57:30 +0800483 struct work_struct timeout_work;
Jens Axboe242f9dc2008-09-14 05:55:09 -0700484
Tejun Heoa612fdd2011-12-14 00:33:41 +0100485 struct list_head icq_list;
Tejun Heo4eef3042012-03-05 13:15:18 -0800486#ifdef CONFIG_BLK_CGROUP
Tejun Heoa2b16932012-04-13 13:11:33 -0700487 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
Tejun Heo3c798392012-04-16 13:57:25 -0700488 struct blkcg_gq *root_blkg;
Tejun Heo03aa2642012-03-05 13:15:19 -0800489 struct list_head blkg_list;
Tejun Heo4eef3042012-03-05 13:15:18 -0800490#endif
Tejun Heoa612fdd2011-12-14 00:33:41 +0100491
Martin K. Petersen025146e2009-05-22 17:17:51 -0400492 struct queue_limits limits;
493
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700494#ifdef CONFIG_BLK_DEV_ZONED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 /*
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900496 * Zoned block device information for request dispatch control.
497 * nr_zones is the total number of zones of the device. This is always
498 * 0 for regular block devices. seq_zones_bitmap is a bitmap of nr_zones
499 * bits which indicates if a zone is conventional (bit clear) or
500 * sequential (bit set). seq_zones_wlock is a bitmap of nr_zones
501 * bits which indicates if a zone is write locked, that is, if a write
502 * request targeting the zone was dispatched. All three fields are
503 * initialized by the low level device driver (e.g. scsi/sd.c).
504 * Stacking drivers (device mappers) may or may not initialize
505 * these fields.
Bart Van Asscheccce20f2018-04-16 18:04:41 -0700506 *
507 * Reads of this information must be protected with blk_queue_enter() /
508 * blk_queue_exit(). Modifying this information is only allowed while
509 * no requests are being processed. See also blk_mq_freeze_queue() and
510 * blk_mq_unfreeze_queue().
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900511 */
512 unsigned int nr_zones;
513 unsigned long *seq_zones_bitmap;
514 unsigned long *seq_zones_wlock;
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700515#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900516
517 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 * sg stuff
519 */
520 unsigned int sg_timeout;
521 unsigned int sg_reserved_size;
Christoph Lameter19460892005-06-23 00:08:19 -0700522 int node;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700523#ifdef CONFIG_BLK_DEV_IO_TRACE
Jens Axboe2056a782006-03-23 20:00:26 +0100524 struct blk_trace *blk_trace;
Waiman Long5acb3cc2017-09-20 13:12:20 -0600525 struct mutex blk_trace_mutex;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700526#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 /*
Tejun Heo4913efe2010-09-03 11:56:16 +0200528 * for flush operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 */
Ming Lei7c94e1c2014-09-25 23:23:43 +0800530 struct blk_flush_queue *fq;
Al Viro483f4af2006-03-18 18:34:37 -0500531
Christoph Hellwig6fca6a62014-05-28 08:08:02 -0600532 struct list_head requeue_list;
533 spinlock_t requeue_lock;
Mike Snitzer28494502016-09-14 13:28:30 -0400534 struct delayed_work requeue_work;
Christoph Hellwig6fca6a62014-05-28 08:08:02 -0600535
Al Viro483f4af2006-03-18 18:34:37 -0500536 struct mutex sysfs_lock;
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200537
Christoph Hellwig4ecd4fe2015-05-07 09:38:13 +0200538 atomic_t mq_freeze_depth;
Tejun Heod7325802012-03-05 13:14:58 -0800539
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200540#if defined(CONFIG_BLK_DEV_BSG)
541 struct bsg_class_device bsg_dev;
542#endif
Vivek Goyale43473b2010-09-15 17:06:35 -0400543
544#ifdef CONFIG_BLK_DEV_THROTTLING
545 /* Throttle data */
546 struct throtl_data *td;
547#endif
Tejun Heo548bc8e2013-01-09 08:05:13 -0800548 struct rcu_head rcu_head;
Jens Axboe320ae512013-10-24 09:20:05 +0100549 wait_queue_head_t mq_freeze_wq;
Dan Williams3ef28e82015-10-21 13:20:12 -0400550 struct percpu_ref q_usage_counter;
Jens Axboe320ae512013-10-24 09:20:05 +0100551 struct list_head all_q_node;
Jens Axboe0d2602c2014-05-13 15:10:52 -0600552
553 struct blk_mq_tag_set *tag_set;
554 struct list_head tag_set_list;
Kent Overstreet338aa962018-05-20 18:25:47 -0400555 struct bio_set bio_split;
Akinobu Mita4593fdb2015-09-27 02:09:20 +0900556
Omar Sandoval03796c12017-01-31 14:53:18 -0800557#ifdef CONFIG_BLK_DEBUG_FS
Omar Sandoval07e4fea2017-01-25 08:06:40 -0800558 struct dentry *debugfs_dir;
Omar Sandovald332ce02017-05-04 08:24:40 -0600559 struct dentry *sched_debugfs_dir;
Ming Leicc566942018-12-17 09:46:00 +0800560 struct dentry *rqos_debugfs_dir;
Omar Sandoval07e4fea2017-01-25 08:06:40 -0800561#endif
562
Akinobu Mita4593fdb2015-09-27 02:09:20 +0900563 bool mq_sysfs_init_done;
Christoph Hellwig6d247d72017-01-27 09:51:45 -0700564
565 size_t cmd_size;
Bart Van Asschedc9edc42017-06-14 13:27:50 -0600566
567 struct work_struct release_work;
Jens Axboef793dfd2017-06-26 08:15:27 -0600568
569#define BLK_MAX_WRITE_HINTS 5
570 u64 write_hints[BLK_MAX_WRITE_HINTS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571};
572
Jens Axboeeca7abf2019-02-09 15:42:07 -0700573#define QUEUE_FLAG_STOPPED 0 /* queue is stopped */
574#define QUEUE_FLAG_DYING 1 /* queue being torn down */
Jens Axboeeca7abf2019-02-09 15:42:07 -0700575#define QUEUE_FLAG_NOMERGES 3 /* disable merge attempts */
576#define QUEUE_FLAG_SAME_COMP 4 /* complete on same CPU-group */
577#define QUEUE_FLAG_FAIL_IO 5 /* fake timeout */
578#define QUEUE_FLAG_NONROT 6 /* non-rotational device (SSD) */
579#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
580#define QUEUE_FLAG_IO_STAT 7 /* do disk/partitions IO accounting */
581#define QUEUE_FLAG_DISCARD 8 /* supports DISCARD */
582#define QUEUE_FLAG_NOXMERGES 9 /* No extended merges */
583#define QUEUE_FLAG_ADD_RANDOM 10 /* Contributes to random pool */
584#define QUEUE_FLAG_SECERASE 11 /* supports secure erase */
585#define QUEUE_FLAG_SAME_FORCE 12 /* force complete on same CPU */
586#define QUEUE_FLAG_DEAD 13 /* queue tear-down finished */
587#define QUEUE_FLAG_INIT_DONE 14 /* queue is initialized */
Jens Axboeeca7abf2019-02-09 15:42:07 -0700588#define QUEUE_FLAG_POLL 16 /* IO polling enabled if set */
589#define QUEUE_FLAG_WC 17 /* Write back caching */
590#define QUEUE_FLAG_FUA 18 /* device supports FUA writes */
591#define QUEUE_FLAG_DAX 19 /* device supports DAX */
592#define QUEUE_FLAG_STATS 20 /* track IO start and completion times */
593#define QUEUE_FLAG_POLL_STATS 21 /* collecting stats for hybrid polling */
594#define QUEUE_FLAG_REGISTERED 22 /* queue has been registered to a disk */
595#define QUEUE_FLAG_SCSI_PASSTHROUGH 23 /* queue supports SCSI commands */
596#define QUEUE_FLAG_QUIESCED 24 /* queue has been quiesced */
597#define QUEUE_FLAG_PCI_P2PDMA 25 /* device supports PCI p2p requests */
Tejun Heo797e7db2006-01-06 09:51:03 +0100598
Jens Axboe94eddfb2013-11-19 09:25:07 -0700599#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
Jens Axboe6e0de612018-12-05 06:50:40 -0700600 (1 << QUEUE_FLAG_SAME_COMP))
Jens Axboe94eddfb2013-11-19 09:25:07 -0700601
Bart Van Assche8814ce82018-03-07 17:10:04 -0800602void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
603void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
604bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
Bart Van Assche8814ce82018-03-07 17:10:04 -0800605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
Bart Van Assche3f3299d2012-11-28 13:42:38 +0100607#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
Bart Van Asschec246e802012-12-06 14:32:01 +0100608#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
Jens Axboe320ae512013-10-24 09:20:05 +0100609#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
Alan D. Brunelleac9fafa2008-04-29 14:44:19 +0200610#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
Alan D. Brunelle488991e2010-01-29 09:04:08 +0100611#define blk_queue_noxmerges(q) \
612 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
Jens Axboea68bbddba2008-09-24 13:03:33 +0200613#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
Jens Axboebc58ba92009-01-23 10:54:44 +0100614#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
Jens Axboee2e1a142010-06-09 10:42:09 +0200615#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
Christoph Hellwigc15227d2009-09-30 13:52:12 +0200616#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
Christoph Hellwig288dab82016-06-09 16:00:36 +0200617#define blk_queue_secure_erase(q) \
618 (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
Toshi Kani163d4ba2016-06-23 17:05:50 -0400619#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
Bart Van Assche9efc1602017-05-31 14:43:46 -0700620#define blk_queue_scsi_passthrough(q) \
621 test_bit(QUEUE_FLAG_SCSI_PASSTHROUGH, &(q)->queue_flags)
Logan Gunthorpe49d92c02018-10-04 15:27:41 -0600622#define blk_queue_pci_p2pdma(q) \
623 test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200625#define blk_noretry_request(rq) \
626 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
627 REQ_FAILFAST_DRIVER))
Ming Leif4560ff2017-06-18 14:24:27 -0600628#define blk_queue_quiesced(q) test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
Bart Van Asschecd84a622018-09-26 14:01:04 -0700629#define blk_queue_pm_only(q) atomic_read(&(q)->pm_only)
Dave Chinner0ce91442018-04-18 14:08:27 +1000630#define blk_queue_fua(q) test_bit(QUEUE_FLAG_FUA, &(q)->queue_flags)
Bart Van Asschec9254f22017-11-09 10:49:57 -0800631
Bart Van Asschecd84a622018-09-26 14:01:04 -0700632extern void blk_set_pm_only(struct request_queue *q);
633extern void blk_clear_pm_only(struct request_queue *q);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200634
Christoph Hellwig57292b52017-01-31 16:57:29 +0100635static inline bool blk_account_rq(struct request *rq)
636{
637 return (rq->rq_flags & RQF_STARTED) && !blk_rq_is_passthrough(rq);
638}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
641
Mike Christie4e1b2d522016-06-05 14:32:22 -0500642#define rq_data_dir(rq) (op_is_write(req_op(rq)) ? WRITE : READ)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Jens Axboe344e9ff2018-11-15 12:22:51 -0700644static inline bool queue_is_mq(struct request_queue *q)
Jens Axboe49fd5242014-04-16 10:57:18 -0600645{
Jens Axboea1ce35f2018-10-29 10:23:51 -0600646 return q->mq_ops;
Jens Axboe49fd5242014-04-16 10:57:18 -0600647}
648
Damien Le Moal797476b2016-10-18 15:40:29 +0900649static inline enum blk_zoned_model
650blk_queue_zoned_model(struct request_queue *q)
651{
652 return q->limits.zoned;
653}
654
655static inline bool blk_queue_is_zoned(struct request_queue *q)
656{
657 switch (blk_queue_zoned_model(q)) {
658 case BLK_ZONED_HA:
659 case BLK_ZONED_HM:
660 return true;
661 default:
662 return false;
663 }
664}
665
Damien Le Moalf99e8642017-01-12 07:58:32 -0700666static inline unsigned int blk_queue_zone_sectors(struct request_queue *q)
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900667{
668 return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
669}
670
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700671#ifdef CONFIG_BLK_DEV_ZONED
Damien Le Moal965b6522018-10-12 19:08:48 +0900672static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
673{
674 return blk_queue_is_zoned(q) ? q->nr_zones : 0;
675}
676
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900677static inline unsigned int blk_queue_zone_no(struct request_queue *q,
678 sector_t sector)
679{
680 if (!blk_queue_is_zoned(q))
681 return 0;
682 return sector >> ilog2(q->limits.chunk_sectors);
683}
684
685static inline bool blk_queue_zone_is_seq(struct request_queue *q,
686 sector_t sector)
687{
688 if (!blk_queue_is_zoned(q) || !q->seq_zones_bitmap)
689 return false;
690 return test_bit(blk_queue_zone_no(q, sector), q->seq_zones_bitmap);
691}
Damien Le Moal965b6522018-10-12 19:08:48 +0900692#else /* CONFIG_BLK_DEV_ZONED */
693static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
694{
695 return 0;
696}
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700697#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900698
Jens Axboe1faa16d2009-04-06 14:48:01 +0200699static inline bool rq_is_sync(struct request *rq)
700{
Christoph Hellwigef295ec2016-10-28 08:48:16 -0600701 return op_is_sync(rq->cmd_flags);
Jens Axboe1faa16d2009-04-06 14:48:01 +0200702}
703
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400704static inline bool rq_mergeable(struct request *rq)
705{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100706 if (blk_rq_is_passthrough(rq))
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400707 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Mike Christie3a5e02c2016-06-05 14:32:23 -0500709 if (req_op(rq) == REQ_OP_FLUSH)
710 return false;
711
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800712 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
713 return false;
714
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400715 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
716 return false;
Christoph Hellwige8064022016-10-20 15:12:13 +0200717 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
718 return false;
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400719
720 return true;
721}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400723static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
724{
Christoph Hellwigefbeccd2017-06-19 09:24:41 +0200725 if (bio_page(a) == bio_page(b) &&
726 bio_offset(a) == bio_offset(b))
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400727 return true;
728
729 return false;
730}
731
Jens Axboed278d4a2016-03-30 10:21:08 -0600732static inline unsigned int blk_queue_depth(struct request_queue *q)
733{
734 if (q->queue_depth)
735 return q->queue_depth;
736
737 return q->nr_requests;
738}
739
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740extern unsigned long blk_max_low_pfn, blk_max_pfn;
741
742/*
743 * standard bounce addresses:
744 *
745 * BLK_BOUNCE_HIGH : bounce all highmem pages
746 * BLK_BOUNCE_ANY : don't bounce anything
747 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
748 */
Andi Kleen24728922008-04-21 09:51:05 +0200749
750#if BITS_PER_LONG == 32
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
Andi Kleen24728922008-04-21 09:51:05 +0200752#else
753#define BLK_BOUNCE_HIGH -1ULL
754#endif
755#define BLK_BOUNCE_ANY (-1ULL)
FUJITA Tomonoribfe17232010-05-31 15:59:03 +0900756#define BLK_BOUNCE_ISA (DMA_BIT_MASK(24))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Jens Axboe3d6392c2007-07-09 12:38:05 +0200758/*
759 * default timeout for SG_IO if none specified
760 */
761#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800762#define BLK_MIN_SG_TIMEOUT (7 * HZ)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200763
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900764struct rq_map_data {
765 struct page **pages;
766 int page_order;
767 int nr_entries;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +0900768 unsigned long offset;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +0900769 int null_mapped;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +0200770 int from_user;
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900771};
772
NeilBrown5705f702007-09-25 12:35:59 +0200773struct req_iterator {
Kent Overstreet79886132013-11-23 17:19:00 -0800774 struct bvec_iter iter;
NeilBrown5705f702007-09-25 12:35:59 +0200775 struct bio *bio;
776};
777
778/* This should not be used directly - use rq_for_each_segment */
Jens Axboe1e428072009-02-23 09:03:10 +0100779#define for_each_bio(_bio) \
780 for (; _bio; _bio = _bio->bi_next)
NeilBrown5705f702007-09-25 12:35:59 +0200781#define __rq_for_each_bio(_bio, rq) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 if ((rq->bio)) \
783 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
784
NeilBrown5705f702007-09-25 12:35:59 +0200785#define rq_for_each_segment(bvl, _rq, _iter) \
786 __rq_for_each_bio(_iter.bio, _rq) \
Kent Overstreet79886132013-11-23 17:19:00 -0800787 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
NeilBrown5705f702007-09-25 12:35:59 +0200788
Ming Leid18d9172019-02-15 19:13:11 +0800789#define rq_for_each_bvec(bvl, _rq, _iter) \
790 __rq_for_each_bio(_iter.bio, _rq) \
791 bio_for_each_bvec(bvl, _iter.bio, _iter.iter)
792
Kent Overstreet4550dd62013-08-07 14:26:21 -0700793#define rq_iter_last(bvec, _iter) \
Kent Overstreet79886132013-11-23 17:19:00 -0800794 (_iter.bio->bi_next == NULL && \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700795 bio_iter_last(bvec, _iter.iter))
NeilBrown5705f702007-09-25 12:35:59 +0200796
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100797#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
798# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
799#endif
800#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
801extern void rq_flush_dcache_pages(struct request *rq);
802#else
803static inline void rq_flush_dcache_pages(struct request *rq)
804{
805}
806#endif
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808extern int blk_register_queue(struct gendisk *disk);
809extern void blk_unregister_queue(struct gendisk *disk);
Jens Axboedece1632015-11-05 10:41:16 -0700810extern blk_qc_t generic_make_request(struct bio *bio);
Christoph Hellwigf421e1d2017-11-02 21:29:50 +0300811extern blk_qc_t direct_make_request(struct bio *bio);
FUJITA Tomonori2a4aa302008-04-29 09:54:36 +0200812extern void blk_rq_init(struct request_queue *q, struct request *rq);
Bart Van Asscheda8d7f02017-04-19 14:01:24 -0700813extern void blk_init_request_from_bio(struct request *req, struct bio *bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814extern void blk_put_request(struct request *);
Bart Van Asschecd6ce142017-06-20 11:15:39 -0700815extern struct request *blk_get_request(struct request_queue *, unsigned int op,
Christoph Hellwigff005a02018-05-09 09:54:05 +0200816 blk_mq_req_flags_t flags);
Kiyoshi Uedaef9e3fa2008-10-01 16:12:15 +0200817extern int blk_lld_busy(struct request_queue *q);
Mike Snitzer78d8e582015-06-26 10:01:13 -0400818extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
819 struct bio_set *bs, gfp_t gfp_mask,
820 int (*bio_ctr)(struct bio *, struct bio *, void *),
821 void *data);
822extern void blk_rq_unprep_clone(struct request *rq);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200823extern blk_status_t blk_insert_cloned_request(struct request_queue *q,
Kiyoshi Ueda82124d62008-09-18 10:45:38 -0400824 struct request *rq);
Jens Axboe0abc2a12017-12-18 15:40:44 +0800825extern int blk_rq_append_bio(struct request *rq, struct bio **bio);
NeilBrownaf67c312017-06-18 14:38:57 +1000826extern void blk_queue_split(struct request_queue *, struct bio **);
Jens Axboe165125e2007-07-24 09:28:11 +0200827extern void blk_recount_segments(struct request_queue *, struct bio *);
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100828extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100829extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
830 unsigned int, void __user *);
Al Viro74f3c8a2007-08-27 15:38:10 -0400831extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
832 unsigned int, void __user *);
Al Viroe915e872008-09-02 17:16:41 -0400833extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
834 struct scsi_ioctl_command __user *);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700835
Bart Van Assche9a95e4e2017-11-09 10:49:59 -0800836extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
Dan Williams2e6edc952015-11-19 13:29:28 -0800837extern void blk_queue_exit(struct request_queue *q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838extern void blk_sync_queue(struct request_queue *q);
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900839extern int blk_rq_map_user(struct request_queue *, struct request *,
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900840 struct rq_map_data *, void __user *, unsigned long,
841 gfp_t);
Jens Axboe8e5cfc42006-12-19 11:12:46 +0100842extern int blk_rq_unmap_user(struct bio *);
Jens Axboe165125e2007-07-24 09:28:11 +0200843extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
844extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100845 struct rq_map_data *, const struct iov_iter *,
846 gfp_t);
Christoph Hellwigb7819b92017-04-20 16:02:55 +0200847extern void blk_execute_rq(struct request_queue *, struct gendisk *,
James Bottomley 994ca9a2005-06-20 14:11:09 +0200848 struct request *, int);
Jens Axboe165125e2007-07-24 09:28:11 +0200849extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
Jens Axboe15fc8582006-01-06 10:00:50 +0100850 struct request *, int, rq_end_io_fn *);
Mike Christie6e39b69e2005-11-11 05:30:24 -0600851
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200852int blk_status_to_errno(blk_status_t status);
853blk_status_t errno_to_blk_status(int errno);
854
Jens Axboe0a1b8b82018-11-26 08:24:43 -0700855int blk_poll(struct request_queue *q, blk_qc_t cookie, bool spin);
Jens Axboe05229beed2015-11-05 10:44:55 -0700856
Jens Axboe165125e2007-07-24 09:28:11 +0200857static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858{
Tejun Heoff9ea322014-09-08 08:03:56 +0900859 return bdev->bd_disk->queue; /* this is never NULL */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860}
861
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862/*
Bart Van Assche233bde22018-03-14 15:48:06 -0700863 * The basic unit of block I/O is a sector. It is used in a number of contexts
864 * in Linux (blk, bio, genhd). The size of one sector is 512 = 2**9
865 * bytes. Variables of type sector_t represent an offset or size that is a
866 * multiple of 512 bytes. Hence these two constants.
867 */
868#ifndef SECTOR_SHIFT
869#define SECTOR_SHIFT 9
870#endif
871#ifndef SECTOR_SIZE
872#define SECTOR_SIZE (1 << SECTOR_SHIFT)
873#endif
874
875/*
Tejun Heo80a761f2009-07-03 17:48:17 +0900876 * blk_rq_pos() : the current sector
877 * blk_rq_bytes() : bytes left in the entire request
878 * blk_rq_cur_bytes() : bytes left in the current segment
879 * blk_rq_err_bytes() : bytes left till the next error boundary
880 * blk_rq_sectors() : sectors left in the entire request
881 * blk_rq_cur_sectors() : sectors left in the current segment
Tejun Heo5efccd12009-04-23 11:05:18 +0900882 */
Tejun Heo5b936292009-05-07 22:24:38 +0900883static inline sector_t blk_rq_pos(const struct request *rq)
884{
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900885 return rq->__sector;
Tejun Heo5b936292009-05-07 22:24:38 +0900886}
887
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900888static inline unsigned int blk_rq_bytes(const struct request *rq)
889{
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900890 return rq->__data_len;
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900891}
892
893static inline int blk_rq_cur_bytes(const struct request *rq)
894{
895 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
896}
Tejun Heo5efccd12009-04-23 11:05:18 +0900897
Tejun Heo80a761f2009-07-03 17:48:17 +0900898extern unsigned int blk_rq_err_bytes(const struct request *rq);
899
Tejun Heo5b936292009-05-07 22:24:38 +0900900static inline unsigned int blk_rq_sectors(const struct request *rq)
901{
Bart Van Assche233bde22018-03-14 15:48:06 -0700902 return blk_rq_bytes(rq) >> SECTOR_SHIFT;
Tejun Heo5b936292009-05-07 22:24:38 +0900903}
904
905static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
906{
Bart Van Assche233bde22018-03-14 15:48:06 -0700907 return blk_rq_cur_bytes(rq) >> SECTOR_SHIFT;
Tejun Heo5b936292009-05-07 22:24:38 +0900908}
909
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700910#ifdef CONFIG_BLK_DEV_ZONED
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900911static inline unsigned int blk_rq_zone_no(struct request *rq)
912{
913 return blk_queue_zone_no(rq->q, blk_rq_pos(rq));
914}
915
916static inline unsigned int blk_rq_zone_is_seq(struct request *rq)
917{
918 return blk_queue_zone_is_seq(rq->q, blk_rq_pos(rq));
919}
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700920#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900921
Christoph Hellwig2e3258e2017-01-13 12:29:10 +0100922/*
923 * Some commands like WRITE SAME have a payload or data transfer size which
924 * is different from the size of the request. Any driver that supports such
925 * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
926 * calculate the data transfer size.
927 */
928static inline unsigned int blk_rq_payload_bytes(struct request *rq)
929{
930 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
931 return rq->special_vec.bv_len;
932 return blk_rq_bytes(rq);
933}
934
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400935static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
Mike Christie8fe0d472016-06-05 14:32:15 -0500936 int op)
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400937{
Adrian Hunter7afafc82016-08-16 10:59:35 +0300938 if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
Bart Van Assche233bde22018-03-14 15:48:06 -0700939 return min(q->limits.max_discard_sectors,
940 UINT_MAX >> SECTOR_SHIFT);
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400941
Mike Christie8fe0d472016-06-05 14:32:15 -0500942 if (unlikely(op == REQ_OP_WRITE_SAME))
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400943 return q->limits.max_write_same_sectors;
944
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800945 if (unlikely(op == REQ_OP_WRITE_ZEROES))
946 return q->limits.max_write_zeroes_sectors;
947
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400948 return q->limits.max_sectors;
949}
950
Jens Axboe762380a2014-06-05 13:38:39 -0600951/*
952 * Return maximum size of a request at given offset. Only valid for
953 * file system requests.
954 */
955static inline unsigned int blk_max_size_offset(struct request_queue *q,
956 sector_t offset)
957{
958 if (!q->limits.chunk_sectors)
Jens Axboe736ed4d2014-06-17 22:09:29 -0700959 return q->limits.max_sectors;
Jens Axboe762380a2014-06-05 13:38:39 -0600960
Keith Busch15bfd212018-06-26 09:14:58 -0600961 return min(q->limits.max_sectors, (unsigned int)(q->limits.chunk_sectors -
962 (offset & (q->limits.chunk_sectors - 1))));
Jens Axboe762380a2014-06-05 13:38:39 -0600963}
964
Damien Le Moal17007f32016-07-20 21:40:47 -0600965static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
966 sector_t offset)
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400967{
968 struct request_queue *q = rq->q;
969
Christoph Hellwig57292b52017-01-31 16:57:29 +0100970 if (blk_rq_is_passthrough(rq))
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400971 return q->limits.max_hw_sectors;
972
Adrian Hunter7afafc82016-08-16 10:59:35 +0300973 if (!q->limits.chunk_sectors ||
974 req_op(rq) == REQ_OP_DISCARD ||
975 req_op(rq) == REQ_OP_SECURE_ERASE)
Mike Christie8fe0d472016-06-05 14:32:15 -0500976 return blk_queue_get_max_sectors(q, req_op(rq));
Jens Axboe762380a2014-06-05 13:38:39 -0600977
Damien Le Moal17007f32016-07-20 21:40:47 -0600978 return min(blk_max_size_offset(q, offset),
Mike Christie8fe0d472016-06-05 14:32:15 -0500979 blk_queue_get_max_sectors(q, req_op(rq)));
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400980}
981
Jun'ichi Nomura75afb352013-09-21 13:57:47 -0600982static inline unsigned int blk_rq_count_bios(struct request *rq)
983{
984 unsigned int nr_bios = 0;
985 struct bio *bio;
986
987 __rq_for_each_bio(bio, rq)
988 nr_bios++;
989
990 return nr_bios;
991}
992
Christoph Hellwigef71de82017-11-02 21:29:51 +0300993void blk_steal_bios(struct bio_list *list, struct request *rq);
994
Tejun Heo9934c8c2009-05-08 11:54:16 +0900995/*
Tejun Heo2e60e022009-04-23 11:05:18 +0900996 * Request completion related functions.
997 *
998 * blk_update_request() completes given number of bytes and updates
999 * the request without completing it.
1000 *
Tejun Heof06d9a22009-04-23 11:05:19 +09001001 * blk_end_request() and friends. __blk_end_request() must be called
1002 * with the request queue spinlock acquired.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 *
1004 * Several drivers define their own end_request and call
Kiyoshi Ueda3bcddea2007-12-11 17:52:28 -05001005 * blk_end_request() for parts of the original function.
1006 * This prevents code duplication in drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001008extern bool blk_update_request(struct request *rq, blk_status_t error,
Tejun Heo2e60e022009-04-23 11:05:18 +09001009 unsigned int nr_bytes);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001010extern void blk_end_request_all(struct request *rq, blk_status_t error);
1011extern bool __blk_end_request(struct request *rq, blk_status_t error,
FUJITA Tomonorib1f74492009-05-11 17:56:09 +09001012 unsigned int nr_bytes);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001013extern void __blk_end_request_all(struct request *rq, blk_status_t error);
1014extern bool __blk_end_request_cur(struct request *rq, blk_status_t error);
Tejun Heo2e60e022009-04-23 11:05:18 +09001015
Jens Axboe242f9dc2008-09-14 05:55:09 -07001016extern void __blk_complete_request(struct request *);
1017extern void blk_abort_request(struct request *);
Jens Axboeff856ba2006-01-09 16:02:34 +01001018
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 * Access functions for manipulating queue properties
1021 */
Jens Axboe165125e2007-07-24 09:28:11 +02001022extern void blk_cleanup_queue(struct request_queue *);
1023extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
1024extern void blk_queue_bounce_limit(struct request_queue *, u64);
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001025extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
Jens Axboe762380a2014-06-05 13:38:39 -06001026extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001027extern void blk_queue_max_segments(struct request_queue *, unsigned short);
Christoph Hellwig1e739732017-02-08 14:46:49 +01001028extern void blk_queue_max_discard_segments(struct request_queue *,
1029 unsigned short);
Jens Axboe165125e2007-07-24 09:28:11 +02001030extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
Christoph Hellwig67efc922009-09-30 13:54:20 +02001031extern void blk_queue_max_discard_sectors(struct request_queue *q,
1032 unsigned int max_discard_sectors);
Martin K. Petersen4363ac72012-09-18 12:19:27 -04001033extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1034 unsigned int max_write_same_sectors);
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -08001035extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1036 unsigned int max_write_same_sectors);
Martin K. Petersene1defc42009-05-22 17:17:49 -04001037extern void blk_queue_logical_block_size(struct request_queue *, unsigned short);
Martin K. Petersen892b6f92010-10-13 21:18:03 +02001038extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001039extern void blk_queue_alignment_offset(struct request_queue *q,
1040 unsigned int alignment);
Martin K. Petersen7c958e32009-07-31 11:49:11 -04001041extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001042extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
Martin K. Petersen3c5820c2009-09-11 21:54:52 +02001043extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001044extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
Jens Axboed278d4a2016-03-30 10:21:08 -06001045extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
Martin K. Petersene475bba2009-06-16 08:23:52 +02001046extern void blk_set_default_limits(struct queue_limits *lim);
Martin K. Petersenb1bd0552012-01-11 16:27:11 +01001047extern void blk_set_stacking_limits(struct queue_limits *lim);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001048extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1049 sector_t offset);
Martin K. Petersen17be8c22010-01-11 03:21:49 -05001050extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1051 sector_t offset);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001052extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1053 sector_t offset);
Jens Axboe165125e2007-07-24 09:28:11 +02001054extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
Tejun Heoe3790c72008-03-04 11:18:17 +01001055extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
FUJITA Tomonori27f82212008-07-04 09:30:03 +02001056extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
Tejun Heo2fb98e82008-02-19 11:36:53 +01001057extern int blk_queue_dma_drain(struct request_queue *q,
1058 dma_drain_needed_fn *dma_drain_needed,
1059 void *buf, unsigned int size);
Jens Axboe165125e2007-07-24 09:28:11 +02001060extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
Keith Busch03100aa2015-08-19 14:24:05 -07001061extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
Jens Axboe165125e2007-07-24 09:28:11 +02001062extern void blk_queue_dma_alignment(struct request_queue *, int);
James Bottomley11c3e682007-12-31 16:37:00 -06001063extern void blk_queue_update_dma_alignment(struct request_queue *, int);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001064extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
Jens Axboe93e9d8e2016-04-12 12:32:46 -06001065extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
Christoph Hellwig1e739732017-02-08 14:46:49 +01001067/*
1068 * Number of physical segments as sent to the device.
1069 *
1070 * Normally this is the number of discontiguous data segments sent by the
1071 * submitter. But for data-less command like discard we might have no
1072 * actual data segments submitted, but the driver might have to add it's
1073 * own special payload. In that case we still return 1 here so that this
1074 * special payload will be mapped.
1075 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001076static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1077{
1078 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1079 return 1;
1080 return rq->nr_phys_segments;
1081}
1082
Christoph Hellwig1e739732017-02-08 14:46:49 +01001083/*
1084 * Number of discard segments (or ranges) the driver needs to fill in.
1085 * Each discard bio merged into a request is counted as one segment.
1086 */
1087static inline unsigned short blk_rq_nr_discard_segments(struct request *rq)
1088{
1089 return max_t(unsigned short, rq->nr_phys_segments, 1);
1090}
1091
Jens Axboe165125e2007-07-24 09:28:11 +02001092extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093extern void blk_dump_rq_flags(struct request *, char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094extern long nr_blockdev_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
Tejun Heo09ac46c2011-12-14 00:33:38 +01001096bool __must_check blk_get_queue(struct request_queue *);
Jens Axboe165125e2007-07-24 09:28:11 +02001097struct request_queue *blk_alloc_queue(gfp_t);
Christoph Hellwig6d469642018-11-14 17:02:18 +01001098struct request_queue *blk_alloc_queue_node(gfp_t gfp_mask, int node_id);
Jens Axboe165125e2007-07-24 09:28:11 +02001099extern void blk_put_queue(struct request_queue *);
Jens Axboe3f21c262015-06-05 10:57:37 -06001100extern void blk_set_queue_dying(struct request_queue *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Shaohua Li316cc672011-07-08 08:19:21 +02001102/*
Suresh Jayaraman75df7132011-09-21 10:00:16 +02001103 * blk_plug permits building a queue of related requests by holding the I/O
1104 * fragments for a short period. This allows merging of sequential requests
1105 * into single larger request. As the requests are moved from a per-task list to
1106 * the device's request_queue in a batch, this results in improved scalability
1107 * as the lock contention for request_queue lock is reduced.
1108 *
1109 * It is ok not to disable preemption when adding the request to the plug list
1110 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1111 * the plug list when the task sleeps by itself. For details, please see
1112 * schedule() where blk_schedule_flush_plug() is called.
Shaohua Li316cc672011-07-08 08:19:21 +02001113 */
Jens Axboe73c10102011-03-08 13:19:51 +01001114struct blk_plug {
Jens Axboe320ae512013-10-24 09:20:05 +01001115 struct list_head mq_list; /* blk-mq requests */
Suresh Jayaraman75df7132011-09-21 10:00:16 +02001116 struct list_head cb_list; /* md requires an unplug callback */
Jens Axboe5f0ed772018-11-23 22:04:33 -07001117 unsigned short rq_count;
Jens Axboece5b0092018-11-27 17:13:56 -07001118 bool multiple_queues;
Jens Axboe73c10102011-03-08 13:19:51 +01001119};
Shaohua Li55c022b2011-07-08 08:19:20 +02001120#define BLK_MAX_REQUEST_COUNT 16
Shaohua Li50d24c32016-11-03 17:03:53 -07001121#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
Shaohua Li55c022b2011-07-08 08:19:20 +02001122
NeilBrown9cbb1752012-07-31 09:08:14 +02001123struct blk_plug_cb;
NeilBrown74018dc2012-07-31 09:08:15 +02001124typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
NeilBrown048c9372011-04-18 09:52:22 +02001125struct blk_plug_cb {
1126 struct list_head list;
NeilBrown9cbb1752012-07-31 09:08:14 +02001127 blk_plug_cb_fn callback;
1128 void *data;
NeilBrown048c9372011-04-18 09:52:22 +02001129};
NeilBrown9cbb1752012-07-31 09:08:14 +02001130extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1131 void *data, int size);
Jens Axboe73c10102011-03-08 13:19:51 +01001132extern void blk_start_plug(struct blk_plug *);
1133extern void blk_finish_plug(struct blk_plug *);
Jens Axboef6603782011-04-15 15:49:07 +02001134extern void blk_flush_plug_list(struct blk_plug *, bool);
Jens Axboe73c10102011-03-08 13:19:51 +01001135
1136static inline void blk_flush_plug(struct task_struct *tsk)
1137{
1138 struct blk_plug *plug = tsk->plug;
1139
Christoph Hellwig88b996c2011-04-15 15:20:10 +02001140 if (plug)
Jens Axboea237c1c2011-04-16 13:27:55 +02001141 blk_flush_plug_list(plug, false);
1142}
1143
1144static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1145{
1146 struct blk_plug *plug = tsk->plug;
1147
1148 if (plug)
Jens Axboef6603782011-04-15 15:49:07 +02001149 blk_flush_plug_list(plug, true);
Jens Axboe73c10102011-03-08 13:19:51 +01001150}
1151
1152static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1153{
1154 struct blk_plug *plug = tsk->plug;
1155
Jens Axboe320ae512013-10-24 09:20:05 +01001156 return plug &&
Jens Axboea1ce35f2018-10-29 10:23:51 -06001157 (!list_empty(&plug->mq_list) ||
Jens Axboe320ae512013-10-24 09:20:05 +01001158 !list_empty(&plug->cb_list));
Jens Axboe73c10102011-03-08 13:19:51 +01001159}
1160
Christoph Hellwigee472d82017-04-05 19:21:08 +02001161extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
1162extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1163 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
Christoph Hellwige950fdf2016-07-19 11:23:33 +02001164
1165#define BLKDEV_DISCARD_SECURE (1 << 0) /* issue a secure erase */
Christoph Hellwigdd3932e2010-09-16 20:51:46 +02001166
Dmitry Monakhovfbd9b092010-04-28 17:55:06 +04001167extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1168 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
Christoph Hellwig38f25252016-04-16 14:55:28 -04001169extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
Christoph Hellwig288dab82016-06-09 16:00:36 +02001170 sector_t nr_sects, gfp_t gfp_mask, int flags,
Mike Christie469e3212016-06-05 14:31:49 -05001171 struct bio **biop);
Christoph Hellwigee472d82017-04-05 19:21:08 +02001172
1173#define BLKDEV_ZERO_NOUNMAP (1 << 0) /* do not free blocks */
Christoph Hellwigcb365b92017-04-05 19:21:10 +02001174#define BLKDEV_ZERO_NOFALLBACK (1 << 1) /* don't write explicit zeroes */
Christoph Hellwigee472d82017-04-05 19:21:08 +02001175
Chaitanya Kulkarnie73c23f2016-11-30 12:28:58 -08001176extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1177 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
Christoph Hellwigee472d82017-04-05 19:21:08 +02001178 unsigned flags);
Dmitry Monakhov3f14d792010-04-28 17:55:09 +04001179extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
Christoph Hellwigee472d82017-04-05 19:21:08 +02001180 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1181
Christoph Hellwig2cf6d262010-08-18 05:29:10 -04001182static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1183 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
David Woodhousefb2dce82008-08-05 18:01:53 +01001184{
Bart Van Assche233bde22018-03-14 15:48:06 -07001185 return blkdev_issue_discard(sb->s_bdev,
1186 block << (sb->s_blocksize_bits -
1187 SECTOR_SHIFT),
1188 nr_blocks << (sb->s_blocksize_bits -
1189 SECTOR_SHIFT),
Christoph Hellwig2cf6d262010-08-18 05:29:10 -04001190 gfp_mask, flags);
David Woodhousefb2dce82008-08-05 18:01:53 +01001191}
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001192static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
Theodore Ts'oa107e5a2010-10-27 23:44:47 -04001193 sector_t nr_blocks, gfp_t gfp_mask)
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001194{
1195 return blkdev_issue_zeroout(sb->s_bdev,
Bart Van Assche233bde22018-03-14 15:48:06 -07001196 block << (sb->s_blocksize_bits -
1197 SECTOR_SHIFT),
1198 nr_blocks << (sb->s_blocksize_bits -
1199 SECTOR_SHIFT),
Christoph Hellwigee472d82017-04-05 19:21:08 +02001200 gfp_mask, 0);
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001201}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Christoph Hellwigf00c4d82017-11-05 10:36:31 +03001203extern int blk_verify_command(unsigned char *cmd, fmode_t mode);
Adel Gadllah0b07de82008-06-26 13:48:27 +02001204
Martin K. Peterseneb28d312010-02-26 00:20:37 -05001205enum blk_default_limits {
1206 BLK_MAX_SEGMENTS = 128,
1207 BLK_SAFE_MAX_SECTORS = 255,
Jeff Moyerd2be5372015-08-13 14:57:57 -04001208 BLK_DEF_MAX_SECTORS = 2560,
Martin K. Peterseneb28d312010-02-26 00:20:37 -05001209 BLK_MAX_SEGMENT_SIZE = 65536,
1210 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1211};
Milan Broz0e435ac2008-12-03 12:55:08 +01001212
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001213static inline unsigned long queue_segment_boundary(struct request_queue *q)
1214{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001215 return q->limits.seg_boundary_mask;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001216}
1217
Keith Busch03100aa2015-08-19 14:24:05 -07001218static inline unsigned long queue_virt_boundary(struct request_queue *q)
1219{
1220 return q->limits.virt_boundary_mask;
1221}
1222
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001223static inline unsigned int queue_max_sectors(struct request_queue *q)
1224{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001225 return q->limits.max_sectors;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001226}
1227
1228static inline unsigned int queue_max_hw_sectors(struct request_queue *q)
1229{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001230 return q->limits.max_hw_sectors;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001231}
1232
Martin K. Petersen8a783622010-02-26 00:20:39 -05001233static inline unsigned short queue_max_segments(struct request_queue *q)
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001234{
Martin K. Petersen8a783622010-02-26 00:20:39 -05001235 return q->limits.max_segments;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001236}
1237
Christoph Hellwig1e739732017-02-08 14:46:49 +01001238static inline unsigned short queue_max_discard_segments(struct request_queue *q)
1239{
1240 return q->limits.max_discard_segments;
1241}
1242
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001243static inline unsigned int queue_max_segment_size(struct request_queue *q)
1244{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001245 return q->limits.max_segment_size;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001246}
1247
Martin K. Petersene1defc42009-05-22 17:17:49 -04001248static inline unsigned short queue_logical_block_size(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249{
1250 int retval = 512;
1251
Martin K. Petersen025146e2009-05-22 17:17:51 -04001252 if (q && q->limits.logical_block_size)
1253 retval = q->limits.logical_block_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
1255 return retval;
1256}
1257
Martin K. Petersene1defc42009-05-22 17:17:49 -04001258static inline unsigned short bdev_logical_block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259{
Martin K. Petersene1defc42009-05-22 17:17:49 -04001260 return queue_logical_block_size(bdev_get_queue(bdev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261}
1262
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001263static inline unsigned int queue_physical_block_size(struct request_queue *q)
1264{
1265 return q->limits.physical_block_size;
1266}
1267
Martin K. Petersen892b6f92010-10-13 21:18:03 +02001268static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
Martin K. Petersenac481c22009-10-03 20:52:01 +02001269{
1270 return queue_physical_block_size(bdev_get_queue(bdev));
1271}
1272
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001273static inline unsigned int queue_io_min(struct request_queue *q)
1274{
1275 return q->limits.io_min;
1276}
1277
Martin K. Petersenac481c22009-10-03 20:52:01 +02001278static inline int bdev_io_min(struct block_device *bdev)
1279{
1280 return queue_io_min(bdev_get_queue(bdev));
1281}
1282
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001283static inline unsigned int queue_io_opt(struct request_queue *q)
1284{
1285 return q->limits.io_opt;
1286}
1287
Martin K. Petersenac481c22009-10-03 20:52:01 +02001288static inline int bdev_io_opt(struct block_device *bdev)
1289{
1290 return queue_io_opt(bdev_get_queue(bdev));
1291}
1292
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001293static inline int queue_alignment_offset(struct request_queue *q)
1294{
Martin K. Petersenac481c22009-10-03 20:52:01 +02001295 if (q->limits.misaligned)
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001296 return -1;
1297
Martin K. Petersenac481c22009-10-03 20:52:01 +02001298 return q->limits.alignment_offset;
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001299}
1300
Martin K. Petersene03a72e2010-01-11 03:21:51 -05001301static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
Martin K. Petersen81744ee2009-12-29 08:35:35 +01001302{
1303 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
Bart Van Assche233bde22018-03-14 15:48:06 -07001304 unsigned int alignment = sector_div(sector, granularity >> SECTOR_SHIFT)
1305 << SECTOR_SHIFT;
Martin K. Petersen81744ee2009-12-29 08:35:35 +01001306
Mike Snitzerb8839b82014-10-08 18:26:13 -04001307 return (granularity + lim->alignment_offset - alignment) % granularity;
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001308}
1309
Martin K. Petersenac481c22009-10-03 20:52:01 +02001310static inline int bdev_alignment_offset(struct block_device *bdev)
1311{
1312 struct request_queue *q = bdev_get_queue(bdev);
1313
1314 if (q->limits.misaligned)
1315 return -1;
1316
1317 if (bdev != bdev->bd_contains)
1318 return bdev->bd_part->alignment_offset;
1319
1320 return q->limits.alignment_offset;
1321}
1322
Martin K. Petersen86b37282009-11-10 11:50:21 +01001323static inline int queue_discard_alignment(struct request_queue *q)
1324{
1325 if (q->limits.discard_misaligned)
1326 return -1;
1327
1328 return q->limits.discard_alignment;
1329}
1330
Martin K. Petersene03a72e2010-01-11 03:21:51 -05001331static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
Martin K. Petersen86b37282009-11-10 11:50:21 +01001332{
Linus Torvalds59771072012-12-19 07:18:35 -08001333 unsigned int alignment, granularity, offset;
Martin K. Petersendd3d1452010-01-11 03:21:48 -05001334
Martin K. Petersena934a002011-05-18 10:37:35 +02001335 if (!lim->max_discard_sectors)
1336 return 0;
1337
Linus Torvalds59771072012-12-19 07:18:35 -08001338 /* Why are these in bytes, not sectors? */
Bart Van Assche233bde22018-03-14 15:48:06 -07001339 alignment = lim->discard_alignment >> SECTOR_SHIFT;
1340 granularity = lim->discard_granularity >> SECTOR_SHIFT;
Linus Torvalds59771072012-12-19 07:18:35 -08001341 if (!granularity)
1342 return 0;
1343
1344 /* Offset of the partition start in 'granularity' sectors */
1345 offset = sector_div(sector, granularity);
1346
1347 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1348 offset = (granularity + alignment - offset) % granularity;
1349
1350 /* Turn it back into bytes, gaah */
Bart Van Assche233bde22018-03-14 15:48:06 -07001351 return offset << SECTOR_SHIFT;
Martin K. Petersen86b37282009-11-10 11:50:21 +01001352}
1353
Paolo Bonzinic6e66632012-08-02 09:48:50 +02001354static inline int bdev_discard_alignment(struct block_device *bdev)
1355{
1356 struct request_queue *q = bdev_get_queue(bdev);
1357
1358 if (bdev != bdev->bd_contains)
1359 return bdev->bd_part->discard_alignment;
1360
1361 return q->limits.discard_alignment;
1362}
1363
Martin K. Petersen4363ac72012-09-18 12:19:27 -04001364static inline unsigned int bdev_write_same(struct block_device *bdev)
1365{
1366 struct request_queue *q = bdev_get_queue(bdev);
1367
1368 if (q)
1369 return q->limits.max_write_same_sectors;
1370
1371 return 0;
1372}
1373
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -08001374static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1375{
1376 struct request_queue *q = bdev_get_queue(bdev);
1377
1378 if (q)
1379 return q->limits.max_write_zeroes_sectors;
1380
1381 return 0;
1382}
1383
Damien Le Moal797476b2016-10-18 15:40:29 +09001384static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1385{
1386 struct request_queue *q = bdev_get_queue(bdev);
1387
1388 if (q)
1389 return blk_queue_zoned_model(q);
1390
1391 return BLK_ZONED_NONE;
1392}
1393
1394static inline bool bdev_is_zoned(struct block_device *bdev)
1395{
1396 struct request_queue *q = bdev_get_queue(bdev);
1397
1398 if (q)
1399 return blk_queue_is_zoned(q);
1400
1401 return false;
1402}
1403
Damien Le Moalf99e8642017-01-12 07:58:32 -07001404static inline unsigned int bdev_zone_sectors(struct block_device *bdev)
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +09001405{
1406 struct request_queue *q = bdev_get_queue(bdev);
1407
1408 if (q)
Damien Le Moalf99e8642017-01-12 07:58:32 -07001409 return blk_queue_zone_sectors(q);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +09001410 return 0;
1411}
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +09001412
Jens Axboe165125e2007-07-24 09:28:11 +02001413static inline int queue_dma_alignment(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414{
Pete Wyckoff482eb682008-01-01 10:23:02 -05001415 return q ? q->dma_alignment : 511;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416}
1417
Namhyung Kim14417792010-09-15 13:08:27 +02001418static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
FUJITA Tomonori87904072008-08-28 15:05:58 +09001419 unsigned int len)
1420{
1421 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
Namhyung Kim14417792010-09-15 13:08:27 +02001422 return !(addr & alignment) && !(len & alignment);
FUJITA Tomonori87904072008-08-28 15:05:58 +09001423}
1424
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425/* assumes size > 256 */
1426static inline unsigned int blksize_bits(unsigned int size)
1427{
1428 unsigned int bits = 8;
1429 do {
1430 bits++;
1431 size >>= 1;
1432 } while (size > 256);
1433 return bits;
1434}
1435
Adrian Bunk2befb9e2005-09-10 00:27:17 -07001436static inline unsigned int block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437{
1438 return bdev->bd_block_size;
1439}
1440
1441typedef struct {struct page *v;} Sector;
1442
1443unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
1444
1445static inline void put_dev_sector(Sector p)
1446{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001447 put_page(p.v);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448}
1449
Jens Axboe59c3d452014-04-08 09:15:35 -06001450int kblockd_schedule_work(struct work_struct *work);
Jens Axboeee63cfa2016-08-24 15:52:48 -06001451int kblockd_schedule_work_on(int cpu, struct work_struct *work);
Jens Axboe818cd1c2017-04-10 09:54:55 -06001452int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1455 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1456#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1457 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1458
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001459#if defined(CONFIG_BLK_DEV_INTEGRITY)
1460
Martin K. Petersen8288f492014-09-26 19:20:02 -04001461enum blk_integrity_flags {
1462 BLK_INTEGRITY_VERIFY = 1 << 0,
1463 BLK_INTEGRITY_GENERATE = 1 << 1,
Martin K. Petersen3aec2f42014-09-26 19:20:03 -04001464 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
Martin K. Petersenaae7df52014-09-26 19:20:05 -04001465 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
Martin K. Petersen8288f492014-09-26 19:20:02 -04001466};
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001467
Martin K. Petersen18593082014-09-26 19:20:01 -04001468struct blk_integrity_iter {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001469 void *prot_buf;
1470 void *data_buf;
Martin K. Petersen3be91c42014-09-26 19:19:59 -04001471 sector_t seed;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001472 unsigned int data_size;
Martin K. Petersen3be91c42014-09-26 19:19:59 -04001473 unsigned short interval;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001474 const char *disk_name;
1475};
1476
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +02001477typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001478
Martin K. Petersen0f8087e2015-10-21 13:19:33 -04001479struct blk_integrity_profile {
1480 integrity_processing_fn *generate_fn;
1481 integrity_processing_fn *verify_fn;
1482 const char *name;
1483};
1484
Martin K. Petersen25520d52015-10-21 13:19:49 -04001485extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001486extern void blk_integrity_unregister(struct gendisk *);
Martin K. Petersenad7fce92008-10-01 03:38:39 -04001487extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001488extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1489 struct scatterlist *);
1490extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001491extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1492 struct request *);
1493extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1494 struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001495
Martin K. Petersen25520d52015-10-21 13:19:49 -04001496static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1497{
Dan Williamsac6fc482015-10-21 13:20:18 -04001498 struct blk_integrity *bi = &disk->queue->integrity;
Martin K. Petersen25520d52015-10-21 13:19:49 -04001499
1500 if (!bi->profile)
1501 return NULL;
1502
1503 return bi;
1504}
1505
Jens Axboeb04accc2008-10-02 12:53:22 +02001506static inline
1507struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
1508{
Martin K. Petersen25520d52015-10-21 13:19:49 -04001509 return blk_get_integrity(bdev->bd_disk);
Martin K. Petersenb02739b2008-10-02 18:47:49 +02001510}
1511
Martin K. Petersen180b2f92014-09-26 19:19:56 -04001512static inline bool blk_integrity_rq(struct request *rq)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001513{
Martin K. Petersen180b2f92014-09-26 19:19:56 -04001514 return rq->cmd_flags & REQ_INTEGRITY;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001515}
1516
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001517static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1518 unsigned int segs)
1519{
1520 q->limits.max_integrity_segments = segs;
1521}
1522
1523static inline unsigned short
1524queue_max_integrity_segments(struct request_queue *q)
1525{
1526 return q->limits.max_integrity_segments;
1527}
1528
Greg Edwards359f6422018-07-25 10:22:58 -04001529/**
1530 * bio_integrity_intervals - Return number of integrity intervals for a bio
1531 * @bi: blk_integrity profile for device
1532 * @sectors: Size of the bio in 512-byte sectors
1533 *
1534 * Description: The block layer calculates everything in 512 byte
1535 * sectors but integrity metadata is done in terms of the data integrity
1536 * interval size of the storage device. Convert the block layer sectors
1537 * to the appropriate number of integrity intervals.
1538 */
1539static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1540 unsigned int sectors)
1541{
1542 return sectors >> (bi->interval_exp - 9);
1543}
1544
1545static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1546 unsigned int sectors)
1547{
1548 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
1549}
1550
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001551#else /* CONFIG_BLK_DEV_INTEGRITY */
1552
Stephen Rothwellfd832402012-01-12 09:17:30 +01001553struct bio;
1554struct block_device;
1555struct gendisk;
1556struct blk_integrity;
1557
1558static inline int blk_integrity_rq(struct request *rq)
1559{
1560 return 0;
1561}
1562static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1563 struct bio *b)
1564{
1565 return 0;
1566}
1567static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1568 struct bio *b,
1569 struct scatterlist *s)
1570{
1571 return 0;
1572}
1573static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1574{
Michele Curti61a04e52014-10-09 15:30:17 -07001575 return NULL;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001576}
1577static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1578{
1579 return NULL;
1580}
1581static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1582{
1583 return 0;
1584}
Martin K. Petersen25520d52015-10-21 13:19:49 -04001585static inline void blk_integrity_register(struct gendisk *d,
Stephen Rothwellfd832402012-01-12 09:17:30 +01001586 struct blk_integrity *b)
1587{
Stephen Rothwellfd832402012-01-12 09:17:30 +01001588}
1589static inline void blk_integrity_unregister(struct gendisk *d)
1590{
1591}
1592static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1593 unsigned int segs)
1594{
1595}
1596static inline unsigned short queue_max_integrity_segments(struct request_queue *q)
1597{
1598 return 0;
1599}
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001600static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1601 struct request *r1,
1602 struct request *r2)
Stephen Rothwellfd832402012-01-12 09:17:30 +01001603{
Martin K. Petersencb1a5ab2014-10-28 20:27:43 -06001604 return true;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001605}
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001606static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1607 struct request *r,
1608 struct bio *b)
Stephen Rothwellfd832402012-01-12 09:17:30 +01001609{
Martin K. Petersencb1a5ab2014-10-28 20:27:43 -06001610 return true;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001611}
Martin K. Petersen25520d52015-10-21 13:19:49 -04001612
Greg Edwards359f6422018-07-25 10:22:58 -04001613static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1614 unsigned int sectors)
1615{
1616 return 0;
1617}
1618
1619static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1620 unsigned int sectors)
1621{
1622 return 0;
1623}
1624
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001625#endif /* CONFIG_BLK_DEV_INTEGRITY */
1626
Al Viro08f85852007-10-08 13:26:20 -04001627struct block_device_operations {
Al Virod4430d62008-03-02 09:09:22 -05001628 int (*open) (struct block_device *, fmode_t);
Al Virodb2a1442013-05-05 21:52:57 -04001629 void (*release) (struct gendisk *, fmode_t);
Tejun Heo3f289dc2018-07-18 04:47:36 -07001630 int (*rw_page)(struct block_device *, sector_t, struct page *, unsigned int);
Al Virod4430d62008-03-02 09:09:22 -05001631 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1632 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
Tejun Heo77ea8872010-12-08 20:57:37 +01001633 unsigned int (*check_events) (struct gendisk *disk,
1634 unsigned int clearing);
1635 /* ->media_changed() is DEPRECATED, use ->check_events() instead */
Al Viro08f85852007-10-08 13:26:20 -04001636 int (*media_changed) (struct gendisk *);
Tejun Heoc3e33e02010-05-15 20:09:29 +02001637 void (*unlock_native_capacity) (struct gendisk *);
Al Viro08f85852007-10-08 13:26:20 -04001638 int (*revalidate_disk) (struct gendisk *);
1639 int (*getgeo)(struct block_device *, struct hd_geometry *);
Nitin Guptab3a27d02010-05-17 11:02:43 +05301640 /* this callback is with swap_lock and sometimes page table lock held */
1641 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
Christoph Hellwige76239a2018-10-12 19:08:49 +09001642 int (*report_zones)(struct gendisk *, sector_t sector,
1643 struct blk_zone *zones, unsigned int *nr_zones,
1644 gfp_t gfp_mask);
Al Viro08f85852007-10-08 13:26:20 -04001645 struct module *owner;
Christoph Hellwigbbd3e062015-10-15 14:10:48 +02001646 const struct pr_ops *pr_ops;
Al Viro08f85852007-10-08 13:26:20 -04001647};
1648
Al Viro633a08b2007-08-29 20:34:12 -04001649extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1650 unsigned long);
Matthew Wilcox47a191f2014-06-04 16:07:46 -07001651extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1652extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1653 struct writeback_control *);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +09001654
1655#ifdef CONFIG_BLK_DEV_ZONED
1656bool blk_req_needs_zone_write_lock(struct request *rq);
1657void __blk_req_zone_write_lock(struct request *rq);
1658void __blk_req_zone_write_unlock(struct request *rq);
1659
1660static inline void blk_req_zone_write_lock(struct request *rq)
1661{
1662 if (blk_req_needs_zone_write_lock(rq))
1663 __blk_req_zone_write_lock(rq);
1664}
1665
1666static inline void blk_req_zone_write_unlock(struct request *rq)
1667{
1668 if (rq->rq_flags & RQF_ZONE_WRITE_LOCKED)
1669 __blk_req_zone_write_unlock(rq);
1670}
1671
1672static inline bool blk_req_zone_is_write_locked(struct request *rq)
1673{
1674 return rq->q->seq_zones_wlock &&
1675 test_bit(blk_rq_zone_no(rq), rq->q->seq_zones_wlock);
1676}
1677
1678static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1679{
1680 if (!blk_req_needs_zone_write_lock(rq))
1681 return true;
1682 return !blk_req_zone_is_write_locked(rq);
1683}
1684#else
1685static inline bool blk_req_needs_zone_write_lock(struct request *rq)
1686{
1687 return false;
1688}
1689
1690static inline void blk_req_zone_write_lock(struct request *rq)
1691{
1692}
1693
1694static inline void blk_req_zone_write_unlock(struct request *rq)
1695{
1696}
1697static inline bool blk_req_zone_is_write_locked(struct request *rq)
1698{
1699 return false;
1700}
1701
1702static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1703{
1704 return true;
1705}
1706#endif /* CONFIG_BLK_DEV_ZONED */
1707
David Howells93614012006-09-30 20:45:40 +02001708#else /* CONFIG_BLOCK */
Fabian Frederickac13a822014-06-04 16:06:27 -07001709
1710struct block_device;
1711
David Howells93614012006-09-30 20:45:40 +02001712/*
1713 * stubs for when the block layer is configured out
1714 */
1715#define buffer_heads_over_limit 0
1716
David Howells93614012006-09-30 20:45:40 +02001717static inline long nr_blockdev_pages(void)
1718{
1719 return 0;
1720}
1721
Jens Axboe1f940bd2011-03-11 20:17:08 +01001722struct blk_plug {
1723};
1724
1725static inline void blk_start_plug(struct blk_plug *plug)
Jens Axboe73c10102011-03-08 13:19:51 +01001726{
1727}
1728
Jens Axboe1f940bd2011-03-11 20:17:08 +01001729static inline void blk_finish_plug(struct blk_plug *plug)
Jens Axboe73c10102011-03-08 13:19:51 +01001730{
1731}
1732
Jens Axboe1f940bd2011-03-11 20:17:08 +01001733static inline void blk_flush_plug(struct task_struct *task)
Jens Axboe73c10102011-03-08 13:19:51 +01001734{
1735}
1736
Jens Axboea237c1c2011-04-16 13:27:55 +02001737static inline void blk_schedule_flush_plug(struct task_struct *task)
1738{
1739}
1740
1741
Jens Axboe73c10102011-03-08 13:19:51 +01001742static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1743{
1744 return false;
1745}
1746
Fabian Frederickac13a822014-06-04 16:06:27 -07001747static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
1748 sector_t *error_sector)
1749{
1750 return 0;
1751}
1752
David Howells93614012006-09-30 20:45:40 +02001753#endif /* CONFIG_BLOCK */
1754
Jens Axboe06193172018-11-13 21:16:54 -07001755static inline void blk_wake_io_task(struct task_struct *waiter)
1756{
1757 /*
1758 * If we're polling, the task itself is doing the completions. For
1759 * that case, we don't need to signal a wakeup, it's enough to just
1760 * mark us as RUNNING.
1761 */
1762 if (waiter == current)
1763 __set_current_state(TASK_RUNNING);
1764 else
1765 wake_up_process(waiter);
1766}
1767
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768#endif