blob: 0de92b29f589c949307ef716a750fb7f7a671ae7 [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
Tejun Heo8bd435b2012-04-13 13:11:28 -070053/*
54 * Maximum number of blkcg policies allowed to be registered concurrently.
55 * Defined here to simplify include dependency.
56 */
Jens Axboe01c5f852018-09-11 10:59:53 -060057#define BLKCG_MAX_POLS 5
Tejun Heo8bd435b2012-04-13 13:11:28 -070058
Christoph Hellwig2a842ac2017-06-03 09:38:04 +020059typedef void (rq_end_io_fn)(struct request *, blk_status_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Jens Axboe4aff5e22006-08-10 08:44:47 +020061/*
Christoph Hellwige8064022016-10-20 15:12:13 +020062 * request flags */
63typedef __u32 __bitwise req_flags_t;
64
65/* elevator knows about this request */
66#define RQF_SORTED ((__force req_flags_t)(1 << 0))
67/* drive already may have started this one */
68#define RQF_STARTED ((__force req_flags_t)(1 << 1))
Christoph Hellwige8064022016-10-20 15:12:13 +020069/* may not be passed by ioscheduler */
70#define RQF_SOFTBARRIER ((__force req_flags_t)(1 << 3))
71/* request for flush sequence */
72#define RQF_FLUSH_SEQ ((__force req_flags_t)(1 << 4))
73/* merge of different types, fail separately */
74#define RQF_MIXED_MERGE ((__force req_flags_t)(1 << 5))
75/* track inflight for MQ */
76#define RQF_MQ_INFLIGHT ((__force req_flags_t)(1 << 6))
77/* don't call prep for this one */
78#define RQF_DONTPREP ((__force req_flags_t)(1 << 7))
79/* set for "ide_preempt" requests and also for requests for which the SCSI
80 "quiesce" state must be ignored. */
81#define RQF_PREEMPT ((__force req_flags_t)(1 << 8))
82/* contains copies of user pages */
83#define RQF_COPY_USER ((__force req_flags_t)(1 << 9))
84/* vaguely specified driver internal error. Ignored by the block layer */
85#define RQF_FAILED ((__force req_flags_t)(1 << 10))
86/* don't warn about errors */
87#define RQF_QUIET ((__force req_flags_t)(1 << 11))
88/* elevator private data attached */
89#define RQF_ELVPRIV ((__force req_flags_t)(1 << 12))
Konstantin Khlebnikov4822e902018-10-11 10:07:06 +030090/* account into disk and partition IO statistics */
Christoph Hellwige8064022016-10-20 15:12:13 +020091#define RQF_IO_STAT ((__force req_flags_t)(1 << 13))
92/* request came from our alloc pool */
93#define RQF_ALLOCED ((__force req_flags_t)(1 << 14))
94/* runtime pm request */
95#define RQF_PM ((__force req_flags_t)(1 << 15))
96/* on IO scheduler merge hash */
97#define RQF_HASHED ((__force req_flags_t)(1 << 16))
Konstantin Khlebnikov4822e902018-10-11 10:07:06 +030098/* track IO completion time */
Jens Axboecf43e6b2016-11-07 21:32:37 -070099#define RQF_STATS ((__force req_flags_t)(1 << 17))
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700100/* Look at ->special_vec for the actual data payload instead of the
101 bio chain. */
102#define RQF_SPECIAL_PAYLOAD ((__force req_flags_t)(1 << 18))
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900103/* The per-zone write lock is held for this request */
104#define RQF_ZONE_WRITE_LOCKED ((__force req_flags_t)(1 << 19))
Jens Axboe76a86f92018-01-10 11:30:56 -0700105/* already slept for hybrid poll */
Keith Busch12f5b932018-05-29 15:52:28 +0200106#define RQF_MQ_POLL_SLEPT ((__force req_flags_t)(1 << 20))
Christoph Hellwigda661262018-06-14 13:58:45 +0200107/* ->timeout has been called, don't expire again */
108#define RQF_TIMED_OUT ((__force req_flags_t)(1 << 21))
Christoph Hellwige8064022016-10-20 15:12:13 +0200109
110/* flags that prevent us from merging requests: */
111#define RQF_NOMERGE_FLAGS \
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700112 (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
Christoph Hellwige8064022016-10-20 15:12:13 +0200113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/*
Keith Busch12f5b932018-05-29 15:52:28 +0200115 * Request state for blk-mq.
116 */
117enum mq_rq_state {
118 MQ_RQ_IDLE = 0,
119 MQ_RQ_IN_FLIGHT = 1,
120 MQ_RQ_COMPLETE = 2,
121};
122
123/*
Christoph Hellwigaf76e552014-05-06 12:12:45 +0200124 * Try to put the fields that are referenced together in the same cacheline.
125 *
126 * If you modify this structure, make sure to update blk_rq_init() and
127 * especially blk_mq_rq_ctx_init() to take care of the added fields.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 */
129struct request {
Jens Axboe165125e2007-07-24 09:28:11 +0200130 struct request_queue *q;
Jens Axboe320ae512013-10-24 09:20:05 +0100131 struct blk_mq_ctx *mq_ctx;
Jens Axboeea4f9952018-10-29 15:06:13 -0600132 struct blk_mq_hw_ctx *mq_hctx;
Jens Axboee6a1c872006-08-10 09:00:21 +0200133
Christoph Hellwigef295ec2016-10-28 08:48:16 -0600134 unsigned int cmd_flags; /* op and common flags */
Christoph Hellwige8064022016-10-20 15:12:13 +0200135 req_flags_t rq_flags;
Jens Axboed486f1f2017-01-31 12:34:41 -0700136
137 int internal_tag;
138
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900139 /* the following two fields are internal, NEVER access directly */
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900140 unsigned int __data_len; /* total data len */
Jens Axboebd166ef2017-01-17 06:03:22 -0700141 int tag;
Richard Kennedy181fdde2010-03-19 08:58:16 +0100142 sector_t __sector; /* sector cursor */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144 struct bio *bio;
145 struct bio *biotail;
146
Jens Axboe7c3fb702018-01-10 11:46:39 -0700147 struct list_head queuelist;
148
Jens Axboe360f92c2014-04-09 20:27:01 -0600149 /*
150 * The hash is used inside the scheduler, and killed once the
151 * request reaches the dispatch list. The ipi_list is only used
152 * to queue the request for softirq completion, which is long
153 * after the request has been unhashed (and even removed from
154 * the dispatch list).
155 */
156 union {
157 struct hlist_node hash; /* merge hash */
158 struct list_head ipi_list;
159 };
160
Jens Axboee6a1c872006-08-10 09:00:21 +0200161 /*
162 * The rb_node is only used inside the io scheduler, requests
163 * are pruned when moved to the dispatch queue. So let the
Mike Snitzerc1867942011-02-11 11:08:00 +0100164 * completion_data share space with the rb_node.
Jens Axboee6a1c872006-08-10 09:00:21 +0200165 */
166 union {
167 struct rb_node rb_node; /* sort/lookup */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700168 struct bio_vec special_vec;
Mike Snitzerc1867942011-02-11 11:08:00 +0100169 void *completion_data;
Christoph Hellwige26738e2017-04-20 16:03:11 +0200170 int error_count; /* for legacy drivers, don't use */
Jens Axboee6a1c872006-08-10 09:00:21 +0200171 };
Jens Axboe98170642006-07-28 09:23:08 +0200172
Jens Axboeff7d1452006-07-12 14:04:37 +0200173 /*
Vivek Goyal7f1dc8a2010-04-21 17:44:16 +0200174 * Three pointers are available for the IO schedulers, if they need
Mike Snitzerc1867942011-02-11 11:08:00 +0100175 * more they have to dynamically allocate it. Flush requests are
176 * never put on the IO scheduler. So let the flush fields share
Tejun Heoa612fdd2011-12-14 00:33:41 +0100177 * space with the elevator data.
Jens Axboeff7d1452006-07-12 14:04:37 +0200178 */
Mike Snitzerc1867942011-02-11 11:08:00 +0100179 union {
Tejun Heoa612fdd2011-12-14 00:33:41 +0100180 struct {
181 struct io_cq *icq;
182 void *priv[2];
183 } elv;
184
Mike Snitzerc1867942011-02-11 11:08:00 +0100185 struct {
186 unsigned int seq;
187 struct list_head list;
Jeff Moyer4853aba2011-08-15 21:37:25 +0200188 rq_end_io_fn *saved_end_io;
Mike Snitzerc1867942011-02-11 11:08:00 +0100189 } flush;
190 };
Jens Axboeff7d1452006-07-12 14:04:37 +0200191
Jens Axboe8f34ee72006-06-13 09:02:34 +0200192 struct gendisk *rq_disk;
Jerome Marchand09e099d2011-01-05 16:57:38 +0100193 struct hd_struct *part;
Omar Sandoval522a7772018-05-09 02:08:53 -0700194 /* Time that I/O was submitted to the kernel. */
195 u64 start_time_ns;
Omar Sandoval544ccc8d2018-05-09 02:08:50 -0700196 /* Time that I/O was submitted to the device. */
197 u64 io_start_time_ns;
198
199#ifdef CONFIG_BLK_WBT
200 unsigned short wbt_flags;
201#endif
202#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
203 unsigned short throtl_size;
204#endif
205
206 /*
207 * Number of scatter-gather DMA addr+len pairs after
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 * physical address coalescing is performed.
209 */
210 unsigned short nr_phys_segments;
Jens Axboe7c3fb702018-01-10 11:46:39 -0700211
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200212#if defined(CONFIG_BLK_DEV_INTEGRITY)
213 unsigned short nr_integrity_segments;
214#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Jens Axboe7c3fb702018-01-10 11:46:39 -0700216 unsigned short write_hint;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200217 unsigned short ioprio;
218
FUJITA Tomonori7a85f882008-03-04 11:17:11 +0100219 unsigned int extra_len; /* length of alignment and padding */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Keith Busch12f5b932018-05-29 15:52:28 +0200221 enum mq_rq_state state;
222 refcount_t ref;
Tejun Heo1d9bd512018-01-09 08:29:48 -0800223
Jens Axboe0b7576d2018-05-29 08:47:57 -0600224 unsigned int timeout;
Christoph Hellwig079076b2018-11-14 17:02:05 +0100225 unsigned long deadline;
Jens Axboe0a72e7f2018-01-09 14:23:42 -0700226
Jens Axboe7c3fb702018-01-10 11:46:39 -0700227 union {
Linus Torvalds0a4b6e22018-01-29 11:51:49 -0800228 struct __call_single_data csd;
Jens Axboe7c3fb702018-01-10 11:46:39 -0700229 u64 fifo_time;
230 };
231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 /*
Jens Axboec00895a2006-09-30 20:29:12 +0200233 * completion callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 */
235 rq_end_io_fn *end_io;
236 void *end_io_data;
237};
238
Ming Lei14cb0dc2017-12-18 15:40:43 +0800239static inline bool blk_op_is_scsi(unsigned int op)
240{
241 return op == REQ_OP_SCSI_IN || op == REQ_OP_SCSI_OUT;
242}
243
244static inline bool blk_op_is_private(unsigned int op)
245{
246 return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
247}
248
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100249static inline bool blk_rq_is_scsi(struct request *rq)
250{
Ming Lei14cb0dc2017-12-18 15:40:43 +0800251 return blk_op_is_scsi(req_op(rq));
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100252}
253
254static inline bool blk_rq_is_private(struct request *rq)
255{
Ming Lei14cb0dc2017-12-18 15:40:43 +0800256 return blk_op_is_private(req_op(rq));
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100257}
258
Christoph Hellwig57292b52017-01-31 16:57:29 +0100259static inline bool blk_rq_is_passthrough(struct request *rq)
260{
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100261 return blk_rq_is_scsi(rq) || blk_rq_is_private(rq);
Christoph Hellwig57292b52017-01-31 16:57:29 +0100262}
263
Ming Lei14cb0dc2017-12-18 15:40:43 +0800264static inline bool bio_is_passthrough(struct bio *bio)
265{
266 unsigned op = bio_op(bio);
267
268 return blk_op_is_scsi(op) || blk_op_is_private(op);
269}
270
Fernando Luis Vázquez Cao766ca442008-08-14 09:59:13 +0200271static inline unsigned short req_get_ioprio(struct request *req)
272{
273 return req->ioprio;
274}
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276#include <linux/elevator.h>
277
Jens Axboe320ae512013-10-24 09:20:05 +0100278struct blk_queue_ctx;
279
Jens Axboedece1632015-11-05 10:41:16 -0700280typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282struct bio_vec;
Tejun Heo2fb98e82008-02-19 11:36:53 +0100283typedef int (dma_drain_needed_fn)(struct request *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Jens Axboe242f9dc2008-09-14 05:55:09 -0700285enum blk_eh_timer_return {
Christoph Hellwig88b0cfa2018-05-29 15:52:38 +0200286 BLK_EH_DONE, /* drivers has completed the command */
287 BLK_EH_RESET_TIMER, /* reset timer and try again */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700288};
289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290enum blk_queue_state {
291 Queue_down,
292 Queue_up,
293};
294
Shaohua Liee1b6f72015-01-15 17:32:25 -0800295#define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
296#define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900298#define BLK_SCSI_MAX_CMDS (256)
299#define BLK_SCSI_CMD_PER_LONG (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
300
Damien Le Moal797476b2016-10-18 15:40:29 +0900301/*
302 * Zoned block device models (zoned limit).
303 */
304enum blk_zoned_model {
305 BLK_ZONED_NONE, /* Regular block device */
306 BLK_ZONED_HA, /* Host-aware zoned block device */
307 BLK_ZONED_HM, /* Host-managed zoned block device */
308};
309
Martin K. Petersen025146e2009-05-22 17:17:51 -0400310struct queue_limits {
311 unsigned long bounce_pfn;
312 unsigned long seg_boundary_mask;
Keith Busch03100aa2015-08-19 14:24:05 -0700313 unsigned long virt_boundary_mask;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400314
315 unsigned int max_hw_sectors;
Martin K. Petersenca369d52015-11-13 16:46:48 -0500316 unsigned int max_dev_sectors;
Jens Axboe762380a2014-06-05 13:38:39 -0600317 unsigned int chunk_sectors;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400318 unsigned int max_sectors;
319 unsigned int max_segment_size;
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400320 unsigned int physical_block_size;
321 unsigned int alignment_offset;
322 unsigned int io_min;
323 unsigned int io_opt;
Christoph Hellwig67efc922009-09-30 13:54:20 +0200324 unsigned int max_discard_sectors;
Jens Axboe0034af02015-07-16 09:14:26 -0600325 unsigned int max_hw_discard_sectors;
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400326 unsigned int max_write_same_sectors;
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800327 unsigned int max_write_zeroes_sectors;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100328 unsigned int discard_granularity;
329 unsigned int discard_alignment;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400330
331 unsigned short logical_block_size;
Martin K. Petersen8a783622010-02-26 00:20:39 -0500332 unsigned short max_segments;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200333 unsigned short max_integrity_segments;
Christoph Hellwig1e739732017-02-08 14:46:49 +0100334 unsigned short max_discard_segments;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400335
Martin K. Petersenc72758f2009-05-22 17:17:53 -0400336 unsigned char misaligned;
Martin K. Petersen86b37282009-11-10 11:50:21 +0100337 unsigned char discard_misaligned;
Kent Overstreetc78afc62013-07-11 22:39:53 -0700338 unsigned char raid_partial_stripes_expensive;
Damien Le Moal797476b2016-10-18 15:40:29 +0900339 enum blk_zoned_model zoned;
Martin K. Petersen025146e2009-05-22 17:17:51 -0400340};
341
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900342#ifdef CONFIG_BLK_DEV_ZONED
343
Damien Le Moala91e1382018-10-12 19:08:43 +0900344extern unsigned int blkdev_nr_zones(struct block_device *bdev);
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900345extern int blkdev_report_zones(struct block_device *bdev,
346 sector_t sector, struct blk_zone *zones,
347 unsigned int *nr_zones, gfp_t gfp_mask);
348extern int blkdev_reset_zones(struct block_device *bdev, sector_t sectors,
349 sector_t nr_sectors, gfp_t gfp_mask);
Damien Le Moalbf505452018-10-12 19:08:50 +0900350extern int blk_revalidate_disk_zones(struct gendisk *disk);
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900351
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900352extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
353 unsigned int cmd, unsigned long arg);
354extern int blkdev_reset_zones_ioctl(struct block_device *bdev, fmode_t mode,
355 unsigned int cmd, unsigned long arg);
356
357#else /* CONFIG_BLK_DEV_ZONED */
358
Damien Le Moala91e1382018-10-12 19:08:43 +0900359static inline unsigned int blkdev_nr_zones(struct block_device *bdev)
360{
361 return 0;
362}
Damien Le Moalbf505452018-10-12 19:08:50 +0900363
364static inline int blk_revalidate_disk_zones(struct gendisk *disk)
365{
366 return 0;
367}
368
Shaun Tancheff3ed05a92016-10-18 15:40:35 +0900369static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
370 fmode_t mode, unsigned int cmd,
371 unsigned long arg)
372{
373 return -ENOTTY;
374}
375
376static inline int blkdev_reset_zones_ioctl(struct block_device *bdev,
377 fmode_t mode, unsigned int cmd,
378 unsigned long arg)
379{
380 return -ENOTTY;
381}
382
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900383#endif /* CONFIG_BLK_DEV_ZONED */
384
Richard Kennedyd7b76302011-07-13 21:17:23 +0200385struct request_queue {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 /*
387 * Together with queue_head for cacheline sharing
388 */
389 struct list_head queue_head;
390 struct request *last_merge;
Jens Axboeb374d182008-10-31 10:05:07 +0100391 struct elevator_queue *elevator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Omar Sandoval34dbad52017-03-21 08:56:08 -0700393 struct blk_queue_stats *stats;
Josef Bacika7905042018-07-03 09:32:35 -0600394 struct rq_qos *rq_qos;
Jens Axboe87760e52016-11-09 12:38:14 -0700395
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 make_request_fn *make_request_fn;
Tejun Heo2fb98e82008-02-19 11:36:53 +0100397 dma_drain_needed_fn *dma_drain_needed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Jens Axboef8a5b122016-12-13 09:24:51 -0700399 const struct blk_mq_ops *mq_ops;
Jens Axboe320ae512013-10-24 09:20:05 +0100400
Jens Axboe320ae512013-10-24 09:20:05 +0100401 /* sw queues */
Ming Leie6cdb092014-06-03 11:24:06 +0800402 struct blk_mq_ctx __percpu *queue_ctx;
Jens Axboe320ae512013-10-24 09:20:05 +0100403 unsigned int nr_queues;
404
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
James Bottomleyfa0ccd82008-01-10 11:30:36 -0600468 unsigned int dma_drain_size;
Richard Kennedyd7b76302011-07-13 21:17:23 +0200469 void *dma_drain_buffer;
Tejun Heoe3790c72008-03-04 11:18:17 +0100470 unsigned int dma_pad_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 unsigned int dma_alignment;
472
Jens Axboe242f9dc2008-09-14 05:55:09 -0700473 unsigned int rq_timeout;
Jens Axboe64f1c212016-11-14 13:03:03 -0700474 int poll_nsec;
Omar Sandoval34dbad52017-03-21 08:56:08 -0700475
476 struct blk_stat_callback *poll_cb;
Stephen Bates02063192017-04-20 16:59:11 -0600477 struct blk_rq_stat poll_stat[BLK_MQ_POLL_STATS_BKTS];
Omar Sandoval34dbad52017-03-21 08:56:08 -0700478
Jens Axboe242f9dc2008-09-14 05:55:09 -0700479 struct timer_list timeout;
Christoph Hellwig287922e2015-10-30 20:57:30 +0800480 struct work_struct timeout_work;
Jens Axboe242f9dc2008-09-14 05:55:09 -0700481
Tejun Heoa612fdd2011-12-14 00:33:41 +0100482 struct list_head icq_list;
Tejun Heo4eef3042012-03-05 13:15:18 -0800483#ifdef CONFIG_BLK_CGROUP
Tejun Heoa2b16932012-04-13 13:11:33 -0700484 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
Tejun Heo3c798392012-04-16 13:57:25 -0700485 struct blkcg_gq *root_blkg;
Tejun Heo03aa2642012-03-05 13:15:19 -0800486 struct list_head blkg_list;
Tejun Heo4eef3042012-03-05 13:15:18 -0800487#endif
Tejun Heoa612fdd2011-12-14 00:33:41 +0100488
Martin K. Petersen025146e2009-05-22 17:17:51 -0400489 struct queue_limits limits;
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
495 * 0 for regular block devices. seq_zones_bitmap is a bitmap of nr_zones
496 * bits which indicates if a zone is conventional (bit clear) or
497 * sequential (bit set). seq_zones_wlock is a bitmap of nr_zones
498 * bits which indicates if a zone is write locked, that is, if a write
499 * request targeting the zone was dispatched. All three fields are
500 * initialized by the low level device driver (e.g. scsi/sd.c).
501 * Stacking drivers (device mappers) may or may not initialize
502 * these fields.
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;
510 unsigned long *seq_zones_bitmap;
511 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
Jens Axboe2056a782006-03-23 20:00:26 +0100521 struct blk_trace *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;
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200534
Christoph Hellwig4ecd4fe2015-05-07 09:38:13 +0200535 atomic_t mq_freeze_depth;
Tejun Heod7325802012-03-05 13:14:58 -0800536
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200537#if defined(CONFIG_BLK_DEV_BSG)
538 struct bsg_class_device bsg_dev;
539#endif
Vivek Goyale43473b2010-09-15 17:06:35 -0400540
541#ifdef CONFIG_BLK_DEV_THROTTLING
542 /* Throttle data */
543 struct throtl_data *td;
544#endif
Tejun Heo548bc8e2013-01-09 08:05:13 -0800545 struct rcu_head rcu_head;
Jens Axboe320ae512013-10-24 09:20:05 +0100546 wait_queue_head_t mq_freeze_wq;
Dan Williams3ef28e82015-10-21 13:20:12 -0400547 struct percpu_ref q_usage_counter;
Jens Axboe320ae512013-10-24 09:20:05 +0100548 struct list_head all_q_node;
Jens Axboe0d2602c2014-05-13 15:10:52 -0600549
550 struct blk_mq_tag_set *tag_set;
551 struct list_head tag_set_list;
Kent Overstreet338aa962018-05-20 18:25:47 -0400552 struct bio_set bio_split;
Akinobu Mita4593fdb2015-09-27 02:09:20 +0900553
Omar Sandoval03796c12017-01-31 14:53:18 -0800554#ifdef CONFIG_BLK_DEBUG_FS
Omar Sandoval07e4fea2017-01-25 08:06:40 -0800555 struct dentry *debugfs_dir;
Omar Sandovald332ce02017-05-04 08:24:40 -0600556 struct dentry *sched_debugfs_dir;
Ming Leicc566942018-12-17 09:46:00 +0800557 struct dentry *rqos_debugfs_dir;
Omar Sandoval07e4fea2017-01-25 08:06:40 -0800558#endif
559
Akinobu Mita4593fdb2015-09-27 02:09:20 +0900560 bool mq_sysfs_init_done;
Christoph Hellwig6d247d72017-01-27 09:51:45 -0700561
562 size_t cmd_size;
Bart Van Asschedc9edc42017-06-14 13:27:50 -0600563
564 struct work_struct release_work;
Jens Axboef793dfd2017-06-26 08:15:27 -0600565
566#define BLK_MAX_WRITE_HINTS 5
567 u64 write_hints[BLK_MAX_WRITE_HINTS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568};
569
Jens Axboeeca7abf2019-02-09 15:42:07 -0700570#define QUEUE_FLAG_STOPPED 0 /* queue is stopped */
571#define QUEUE_FLAG_DYING 1 /* queue being torn down */
Jens Axboeeca7abf2019-02-09 15:42:07 -0700572#define QUEUE_FLAG_NOMERGES 3 /* disable merge attempts */
573#define QUEUE_FLAG_SAME_COMP 4 /* complete on same CPU-group */
574#define QUEUE_FLAG_FAIL_IO 5 /* fake timeout */
575#define QUEUE_FLAG_NONROT 6 /* non-rotational device (SSD) */
576#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
577#define QUEUE_FLAG_IO_STAT 7 /* do disk/partitions IO accounting */
578#define QUEUE_FLAG_DISCARD 8 /* supports DISCARD */
579#define QUEUE_FLAG_NOXMERGES 9 /* No extended merges */
580#define QUEUE_FLAG_ADD_RANDOM 10 /* Contributes to random pool */
581#define QUEUE_FLAG_SECERASE 11 /* supports secure erase */
582#define QUEUE_FLAG_SAME_FORCE 12 /* force complete on same CPU */
583#define QUEUE_FLAG_DEAD 13 /* queue tear-down finished */
584#define QUEUE_FLAG_INIT_DONE 14 /* queue is initialized */
Jens Axboeeca7abf2019-02-09 15:42:07 -0700585#define QUEUE_FLAG_POLL 16 /* IO polling enabled if set */
586#define QUEUE_FLAG_WC 17 /* Write back caching */
587#define QUEUE_FLAG_FUA 18 /* device supports FUA writes */
588#define QUEUE_FLAG_DAX 19 /* device supports DAX */
589#define QUEUE_FLAG_STATS 20 /* track IO start and completion times */
590#define QUEUE_FLAG_POLL_STATS 21 /* collecting stats for hybrid polling */
591#define QUEUE_FLAG_REGISTERED 22 /* queue has been registered to a disk */
592#define QUEUE_FLAG_SCSI_PASSTHROUGH 23 /* queue supports SCSI commands */
593#define QUEUE_FLAG_QUIESCED 24 /* queue has been quiesced */
594#define QUEUE_FLAG_PCI_P2PDMA 25 /* device supports PCI p2p requests */
Tejun Heo797e7db2006-01-06 09:51:03 +0100595
Jens Axboe94eddfb2013-11-19 09:25:07 -0700596#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
Jens Axboe6e0de612018-12-05 06:50:40 -0700597 (1 << QUEUE_FLAG_SAME_COMP))
Jens Axboe94eddfb2013-11-19 09:25:07 -0700598
Bart Van Assche8814ce82018-03-07 17:10:04 -0800599void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
600void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
601bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
Bart Van Assche8814ce82018-03-07 17:10:04 -0800602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
Bart Van Assche3f3299d2012-11-28 13:42:38 +0100604#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
Bart Van Asschec246e802012-12-06 14:32:01 +0100605#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
Jens Axboe320ae512013-10-24 09:20:05 +0100606#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
Alan D. Brunelleac9fafa2008-04-29 14:44:19 +0200607#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
Alan D. Brunelle488991e2010-01-29 09:04:08 +0100608#define blk_queue_noxmerges(q) \
609 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
Jens Axboea68bbddba2008-09-24 13:03:33 +0200610#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
Jens Axboebc58ba92009-01-23 10:54:44 +0100611#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
Jens Axboee2e1a142010-06-09 10:42:09 +0200612#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
Christoph Hellwigc15227d2009-09-30 13:52:12 +0200613#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
Christoph Hellwig288dab82016-06-09 16:00:36 +0200614#define blk_queue_secure_erase(q) \
615 (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
Toshi Kani163d4ba2016-06-23 17:05:50 -0400616#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
Bart Van Assche9efc1602017-05-31 14:43:46 -0700617#define blk_queue_scsi_passthrough(q) \
618 test_bit(QUEUE_FLAG_SCSI_PASSTHROUGH, &(q)->queue_flags)
Logan Gunthorpe49d92c02018-10-04 15:27:41 -0600619#define blk_queue_pci_p2pdma(q) \
620 test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200622#define blk_noretry_request(rq) \
623 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
624 REQ_FAILFAST_DRIVER))
Ming Leif4560ff2017-06-18 14:24:27 -0600625#define blk_queue_quiesced(q) test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
Bart Van Asschecd84a622018-09-26 14:01:04 -0700626#define blk_queue_pm_only(q) atomic_read(&(q)->pm_only)
Dave Chinner0ce91442018-04-18 14:08:27 +1000627#define blk_queue_fua(q) test_bit(QUEUE_FLAG_FUA, &(q)->queue_flags)
Bart Van Asschec9254f22017-11-09 10:49:57 -0800628
Bart Van Asschecd84a622018-09-26 14:01:04 -0700629extern void blk_set_pm_only(struct request_queue *q);
630extern void blk_clear_pm_only(struct request_queue *q);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200631
Christoph Hellwig57292b52017-01-31 16:57:29 +0100632static inline bool blk_account_rq(struct request *rq)
633{
634 return (rq->rq_flags & RQF_STARTED) && !blk_rq_is_passthrough(rq);
635}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
638
Mike Christie4e1b2d522016-06-05 14:32:22 -0500639#define rq_data_dir(rq) (op_is_write(req_op(rq)) ? WRITE : READ)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Jens Axboe344e9ff2018-11-15 12:22:51 -0700641static inline bool queue_is_mq(struct request_queue *q)
Jens Axboe49fd5242014-04-16 10:57:18 -0600642{
Jens Axboea1ce35f2018-10-29 10:23:51 -0600643 return q->mq_ops;
Jens Axboe49fd5242014-04-16 10:57:18 -0600644}
645
Damien Le Moal797476b2016-10-18 15:40:29 +0900646static inline enum blk_zoned_model
647blk_queue_zoned_model(struct request_queue *q)
648{
649 return q->limits.zoned;
650}
651
652static inline bool blk_queue_is_zoned(struct request_queue *q)
653{
654 switch (blk_queue_zoned_model(q)) {
655 case BLK_ZONED_HA:
656 case BLK_ZONED_HM:
657 return true;
658 default:
659 return false;
660 }
661}
662
Damien Le Moalf99e8642017-01-12 07:58:32 -0700663static inline unsigned int blk_queue_zone_sectors(struct request_queue *q)
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +0900664{
665 return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
666}
667
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700668#ifdef CONFIG_BLK_DEV_ZONED
Damien Le Moal965b6522018-10-12 19:08:48 +0900669static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
670{
671 return blk_queue_is_zoned(q) ? q->nr_zones : 0;
672}
673
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900674static inline unsigned int blk_queue_zone_no(struct request_queue *q,
675 sector_t sector)
676{
677 if (!blk_queue_is_zoned(q))
678 return 0;
679 return sector >> ilog2(q->limits.chunk_sectors);
680}
681
682static inline bool blk_queue_zone_is_seq(struct request_queue *q,
683 sector_t sector)
684{
685 if (!blk_queue_is_zoned(q) || !q->seq_zones_bitmap)
686 return false;
687 return test_bit(blk_queue_zone_no(q, sector), q->seq_zones_bitmap);
688}
Damien Le Moal965b6522018-10-12 19:08:48 +0900689#else /* CONFIG_BLK_DEV_ZONED */
690static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
691{
692 return 0;
693}
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700694#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900695
Jens Axboe1faa16d2009-04-06 14:48:01 +0200696static inline bool rq_is_sync(struct request *rq)
697{
Christoph Hellwigef295ec2016-10-28 08:48:16 -0600698 return op_is_sync(rq->cmd_flags);
Jens Axboe1faa16d2009-04-06 14:48:01 +0200699}
700
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400701static inline bool rq_mergeable(struct request *rq)
702{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100703 if (blk_rq_is_passthrough(rq))
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400704 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
Mike Christie3a5e02c2016-06-05 14:32:23 -0500706 if (req_op(rq) == REQ_OP_FLUSH)
707 return false;
708
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800709 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
710 return false;
711
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400712 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
713 return false;
Christoph Hellwige8064022016-10-20 15:12:13 +0200714 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
715 return false;
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400716
717 return true;
718}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400720static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
721{
Christoph Hellwigefbeccd2017-06-19 09:24:41 +0200722 if (bio_page(a) == bio_page(b) &&
723 bio_offset(a) == bio_offset(b))
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400724 return true;
725
726 return false;
727}
728
Jens Axboed278d4a2016-03-30 10:21:08 -0600729static inline unsigned int blk_queue_depth(struct request_queue *q)
730{
731 if (q->queue_depth)
732 return q->queue_depth;
733
734 return q->nr_requests;
735}
736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737extern unsigned long blk_max_low_pfn, blk_max_pfn;
738
739/*
740 * standard bounce addresses:
741 *
742 * BLK_BOUNCE_HIGH : bounce all highmem pages
743 * BLK_BOUNCE_ANY : don't bounce anything
744 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
745 */
Andi Kleen24728922008-04-21 09:51:05 +0200746
747#if BITS_PER_LONG == 32
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
Andi Kleen24728922008-04-21 09:51:05 +0200749#else
750#define BLK_BOUNCE_HIGH -1ULL
751#endif
752#define BLK_BOUNCE_ANY (-1ULL)
FUJITA Tomonoribfe17232010-05-31 15:59:03 +0900753#define BLK_BOUNCE_ISA (DMA_BIT_MASK(24))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Jens Axboe3d6392c2007-07-09 12:38:05 +0200755/*
756 * default timeout for SG_IO if none specified
757 */
758#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800759#define BLK_MIN_SG_TIMEOUT (7 * HZ)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200760
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900761struct rq_map_data {
762 struct page **pages;
763 int page_order;
764 int nr_entries;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +0900765 unsigned long offset;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +0900766 int null_mapped;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +0200767 int from_user;
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900768};
769
NeilBrown5705f702007-09-25 12:35:59 +0200770struct req_iterator {
Kent Overstreet79886132013-11-23 17:19:00 -0800771 struct bvec_iter iter;
NeilBrown5705f702007-09-25 12:35:59 +0200772 struct bio *bio;
773};
774
775/* This should not be used directly - use rq_for_each_segment */
Jens Axboe1e428072009-02-23 09:03:10 +0100776#define for_each_bio(_bio) \
777 for (; _bio; _bio = _bio->bi_next)
NeilBrown5705f702007-09-25 12:35:59 +0200778#define __rq_for_each_bio(_bio, rq) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 if ((rq->bio)) \
780 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
781
NeilBrown5705f702007-09-25 12:35:59 +0200782#define rq_for_each_segment(bvl, _rq, _iter) \
783 __rq_for_each_bio(_iter.bio, _rq) \
Kent Overstreet79886132013-11-23 17:19:00 -0800784 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
NeilBrown5705f702007-09-25 12:35:59 +0200785
Ming Leid18d9172019-02-15 19:13:11 +0800786#define rq_for_each_bvec(bvl, _rq, _iter) \
787 __rq_for_each_bio(_iter.bio, _rq) \
788 bio_for_each_bvec(bvl, _iter.bio, _iter.iter)
789
Kent Overstreet4550dd62013-08-07 14:26:21 -0700790#define rq_iter_last(bvec, _iter) \
Kent Overstreet79886132013-11-23 17:19:00 -0800791 (_iter.bio->bi_next == NULL && \
Kent Overstreet4550dd62013-08-07 14:26:21 -0700792 bio_iter_last(bvec, _iter.iter))
NeilBrown5705f702007-09-25 12:35:59 +0200793
Ilya Loginov2d4dc892009-11-26 09:16:19 +0100794#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
795# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
796#endif
797#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
798extern void rq_flush_dcache_pages(struct request *rq);
799#else
800static inline void rq_flush_dcache_pages(struct request *rq)
801{
802}
803#endif
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805extern int blk_register_queue(struct gendisk *disk);
806extern void blk_unregister_queue(struct gendisk *disk);
Jens Axboedece1632015-11-05 10:41:16 -0700807extern blk_qc_t generic_make_request(struct bio *bio);
Christoph Hellwigf421e1d2017-11-02 21:29:50 +0300808extern blk_qc_t direct_make_request(struct bio *bio);
FUJITA Tomonori2a4aa302008-04-29 09:54:36 +0200809extern void blk_rq_init(struct request_queue *q, struct request *rq);
Bart Van Asscheda8d7f02017-04-19 14:01:24 -0700810extern void blk_init_request_from_bio(struct request *req, struct bio *bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811extern void blk_put_request(struct request *);
Bart Van Asschecd6ce142017-06-20 11:15:39 -0700812extern struct request *blk_get_request(struct request_queue *, unsigned int op,
Christoph Hellwigff005a02018-05-09 09:54:05 +0200813 blk_mq_req_flags_t flags);
Kiyoshi Uedaef9e3fa2008-10-01 16:12:15 +0200814extern int blk_lld_busy(struct request_queue *q);
Mike Snitzer78d8e582015-06-26 10:01:13 -0400815extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
816 struct bio_set *bs, gfp_t gfp_mask,
817 int (*bio_ctr)(struct bio *, struct bio *, void *),
818 void *data);
819extern void blk_rq_unprep_clone(struct request *rq);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200820extern blk_status_t blk_insert_cloned_request(struct request_queue *q,
Kiyoshi Ueda82124d62008-09-18 10:45:38 -0400821 struct request *rq);
Jens Axboe0abc2a12017-12-18 15:40:44 +0800822extern int blk_rq_append_bio(struct request *rq, struct bio **bio);
NeilBrownaf67c312017-06-18 14:38:57 +1000823extern void blk_queue_split(struct request_queue *, struct bio **);
Jens Axboe165125e2007-07-24 09:28:11 +0200824extern void blk_recount_segments(struct request_queue *, struct bio *);
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100825extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100826extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
827 unsigned int, void __user *);
Al Viro74f3c8a2007-08-27 15:38:10 -0400828extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
829 unsigned int, void __user *);
Al Viroe915e872008-09-02 17:16:41 -0400830extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
831 struct scsi_ioctl_command __user *);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700832
Bart Van Assche9a95e4e2017-11-09 10:49:59 -0800833extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
Dan Williams2e6edc952015-11-19 13:29:28 -0800834extern void blk_queue_exit(struct request_queue *q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835extern void blk_sync_queue(struct request_queue *q);
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900836extern int blk_rq_map_user(struct request_queue *, struct request *,
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900837 struct rq_map_data *, void __user *, unsigned long,
838 gfp_t);
Jens Axboe8e5cfc42006-12-19 11:12:46 +0100839extern int blk_rq_unmap_user(struct bio *);
Jens Axboe165125e2007-07-24 09:28:11 +0200840extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
841extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100842 struct rq_map_data *, const struct iov_iter *,
843 gfp_t);
Christoph Hellwigb7819b92017-04-20 16:02:55 +0200844extern void blk_execute_rq(struct request_queue *, struct gendisk *,
James Bottomley 994ca9a2005-06-20 14:11:09 +0200845 struct request *, int);
Jens Axboe165125e2007-07-24 09:28:11 +0200846extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
Jens Axboe15fc8582006-01-06 10:00:50 +0100847 struct request *, int, rq_end_io_fn *);
Mike Christie6e39b69e2005-11-11 05:30:24 -0600848
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200849int blk_status_to_errno(blk_status_t status);
850blk_status_t errno_to_blk_status(int errno);
851
Jens Axboe0a1b8b82018-11-26 08:24:43 -0700852int blk_poll(struct request_queue *q, blk_qc_t cookie, bool spin);
Jens Axboe05229beed2015-11-05 10:44:55 -0700853
Jens Axboe165125e2007-07-24 09:28:11 +0200854static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855{
Tejun Heoff9ea322014-09-08 08:03:56 +0900856 return bdev->bd_disk->queue; /* this is never NULL */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857}
858
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859/*
Bart Van Assche233bde22018-03-14 15:48:06 -0700860 * The basic unit of block I/O is a sector. It is used in a number of contexts
861 * in Linux (blk, bio, genhd). The size of one sector is 512 = 2**9
862 * bytes. Variables of type sector_t represent an offset or size that is a
863 * multiple of 512 bytes. Hence these two constants.
864 */
865#ifndef SECTOR_SHIFT
866#define SECTOR_SHIFT 9
867#endif
868#ifndef SECTOR_SIZE
869#define SECTOR_SIZE (1 << SECTOR_SHIFT)
870#endif
871
872/*
Tejun Heo80a761f2009-07-03 17:48:17 +0900873 * blk_rq_pos() : the current sector
874 * blk_rq_bytes() : bytes left in the entire request
875 * blk_rq_cur_bytes() : bytes left in the current segment
876 * blk_rq_err_bytes() : bytes left till the next error boundary
877 * blk_rq_sectors() : sectors left in the entire request
878 * blk_rq_cur_sectors() : sectors left in the current segment
Tejun Heo5efccd12009-04-23 11:05:18 +0900879 */
Tejun Heo5b936292009-05-07 22:24:38 +0900880static inline sector_t blk_rq_pos(const struct request *rq)
881{
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900882 return rq->__sector;
Tejun Heo5b936292009-05-07 22:24:38 +0900883}
884
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900885static inline unsigned int blk_rq_bytes(const struct request *rq)
886{
Tejun Heoa2dec7b2009-05-07 22:24:44 +0900887 return rq->__data_len;
Tejun Heo2e46e8b2009-05-07 22:24:41 +0900888}
889
890static inline int blk_rq_cur_bytes(const struct request *rq)
891{
892 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
893}
Tejun Heo5efccd12009-04-23 11:05:18 +0900894
Tejun Heo80a761f2009-07-03 17:48:17 +0900895extern unsigned int blk_rq_err_bytes(const struct request *rq);
896
Tejun Heo5b936292009-05-07 22:24:38 +0900897static inline unsigned int blk_rq_sectors(const struct request *rq)
898{
Bart Van Assche233bde22018-03-14 15:48:06 -0700899 return blk_rq_bytes(rq) >> SECTOR_SHIFT;
Tejun Heo5b936292009-05-07 22:24:38 +0900900}
901
902static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
903{
Bart Van Assche233bde22018-03-14 15:48:06 -0700904 return blk_rq_cur_bytes(rq) >> SECTOR_SHIFT;
Tejun Heo5b936292009-05-07 22:24:38 +0900905}
906
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700907#ifdef CONFIG_BLK_DEV_ZONED
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900908static inline unsigned int blk_rq_zone_no(struct request *rq)
909{
910 return blk_queue_zone_no(rq->q, blk_rq_pos(rq));
911}
912
913static inline unsigned int blk_rq_zone_is_seq(struct request *rq)
914{
915 return blk_queue_zone_is_seq(rq->q, blk_rq_pos(rq));
916}
Bart Van Assche6a5ac982018-06-15 14:55:21 -0700917#endif /* CONFIG_BLK_DEV_ZONED */
Christoph Hellwig6cc77e92017-12-21 15:43:38 +0900918
Christoph Hellwig2e3258e2017-01-13 12:29:10 +0100919/*
920 * Some commands like WRITE SAME have a payload or data transfer size which
921 * is different from the size of the request. Any driver that supports such
922 * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
923 * calculate the data transfer size.
924 */
925static inline unsigned int blk_rq_payload_bytes(struct request *rq)
926{
927 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
928 return rq->special_vec.bv_len;
929 return blk_rq_bytes(rq);
930}
931
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400932static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
Mike Christie8fe0d472016-06-05 14:32:15 -0500933 int op)
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400934{
Adrian Hunter7afafc82016-08-16 10:59:35 +0300935 if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
Bart Van Assche233bde22018-03-14 15:48:06 -0700936 return min(q->limits.max_discard_sectors,
937 UINT_MAX >> SECTOR_SHIFT);
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400938
Mike Christie8fe0d472016-06-05 14:32:15 -0500939 if (unlikely(op == REQ_OP_WRITE_SAME))
Martin K. Petersen4363ac72012-09-18 12:19:27 -0400940 return q->limits.max_write_same_sectors;
941
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800942 if (unlikely(op == REQ_OP_WRITE_ZEROES))
943 return q->limits.max_write_zeroes_sectors;
944
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400945 return q->limits.max_sectors;
946}
947
Jens Axboe762380a2014-06-05 13:38:39 -0600948/*
949 * Return maximum size of a request at given offset. Only valid for
950 * file system requests.
951 */
952static inline unsigned int blk_max_size_offset(struct request_queue *q,
953 sector_t offset)
954{
955 if (!q->limits.chunk_sectors)
Jens Axboe736ed4d2014-06-17 22:09:29 -0700956 return q->limits.max_sectors;
Jens Axboe762380a2014-06-05 13:38:39 -0600957
Keith Busch15bfd212018-06-26 09:14:58 -0600958 return min(q->limits.max_sectors, (unsigned int)(q->limits.chunk_sectors -
959 (offset & (q->limits.chunk_sectors - 1))));
Jens Axboe762380a2014-06-05 13:38:39 -0600960}
961
Damien Le Moal17007f32016-07-20 21:40:47 -0600962static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
963 sector_t offset)
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400964{
965 struct request_queue *q = rq->q;
966
Christoph Hellwig57292b52017-01-31 16:57:29 +0100967 if (blk_rq_is_passthrough(rq))
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400968 return q->limits.max_hw_sectors;
969
Adrian Hunter7afafc82016-08-16 10:59:35 +0300970 if (!q->limits.chunk_sectors ||
971 req_op(rq) == REQ_OP_DISCARD ||
972 req_op(rq) == REQ_OP_SECURE_ERASE)
Mike Christie8fe0d472016-06-05 14:32:15 -0500973 return blk_queue_get_max_sectors(q, req_op(rq));
Jens Axboe762380a2014-06-05 13:38:39 -0600974
Damien Le Moal17007f32016-07-20 21:40:47 -0600975 return min(blk_max_size_offset(q, offset),
Mike Christie8fe0d472016-06-05 14:32:15 -0500976 blk_queue_get_max_sectors(q, req_op(rq)));
Martin K. Petersenf31dc1c2012-09-18 12:19:26 -0400977}
978
Jun'ichi Nomura75afb352013-09-21 13:57:47 -0600979static inline unsigned int blk_rq_count_bios(struct request *rq)
980{
981 unsigned int nr_bios = 0;
982 struct bio *bio;
983
984 __rq_for_each_bio(bio, rq)
985 nr_bios++;
986
987 return nr_bios;
988}
989
Christoph Hellwigef71de82017-11-02 21:29:51 +0300990void blk_steal_bios(struct bio_list *list, struct request *rq);
991
Tejun Heo9934c8c2009-05-08 11:54:16 +0900992/*
Tejun Heo2e60e022009-04-23 11:05:18 +0900993 * Request completion related functions.
994 *
995 * blk_update_request() completes given number of bytes and updates
996 * the request without completing it.
997 *
Tejun Heof06d9a22009-04-23 11:05:19 +0900998 * blk_end_request() and friends. __blk_end_request() must be called
999 * with the request queue spinlock acquired.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 *
1001 * Several drivers define their own end_request and call
Kiyoshi Ueda3bcddea2007-12-11 17:52:28 -05001002 * blk_end_request() for parts of the original function.
1003 * This prevents code duplication in drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001005extern bool blk_update_request(struct request *rq, blk_status_t error,
Tejun Heo2e60e022009-04-23 11:05:18 +09001006 unsigned int nr_bytes);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001007extern void blk_end_request_all(struct request *rq, blk_status_t error);
1008extern bool __blk_end_request(struct request *rq, blk_status_t error,
FUJITA Tomonorib1f74492009-05-11 17:56:09 +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_cur(struct request *rq, blk_status_t error);
Tejun Heo2e60e022009-04-23 11:05:18 +09001012
Jens Axboe242f9dc2008-09-14 05:55:09 -07001013extern void __blk_complete_request(struct request *);
1014extern void blk_abort_request(struct request *);
Jens Axboeff856ba2006-01-09 16:02:34 +01001015
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 * Access functions for manipulating queue properties
1018 */
Jens Axboe165125e2007-07-24 09:28:11 +02001019extern void blk_cleanup_queue(struct request_queue *);
1020extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
1021extern void blk_queue_bounce_limit(struct request_queue *, u64);
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001022extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
Jens Axboe762380a2014-06-05 13:38:39 -06001023extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001024extern void blk_queue_max_segments(struct request_queue *, unsigned short);
Christoph Hellwig1e739732017-02-08 14:46:49 +01001025extern void blk_queue_max_discard_segments(struct request_queue *,
1026 unsigned short);
Jens Axboe165125e2007-07-24 09:28:11 +02001027extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
Christoph Hellwig67efc922009-09-30 13:54:20 +02001028extern void blk_queue_max_discard_sectors(struct request_queue *q,
1029 unsigned int max_discard_sectors);
Martin K. Petersen4363ac72012-09-18 12:19:27 -04001030extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1031 unsigned int max_write_same_sectors);
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -08001032extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1033 unsigned int max_write_same_sectors);
Martin K. Petersene1defc42009-05-22 17:17:49 -04001034extern void blk_queue_logical_block_size(struct request_queue *, unsigned short);
Martin K. Petersen892b6f92010-10-13 21:18:03 +02001035extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001036extern void blk_queue_alignment_offset(struct request_queue *q,
1037 unsigned int alignment);
Martin K. Petersen7c958e32009-07-31 11:49:11 -04001038extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001039extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
Martin K. Petersen3c5820c2009-09-11 21:54:52 +02001040extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001041extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
Jens Axboed278d4a2016-03-30 10:21:08 -06001042extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
Martin K. Petersene475bba2009-06-16 08:23:52 +02001043extern void blk_set_default_limits(struct queue_limits *lim);
Martin K. Petersenb1bd0552012-01-11 16:27:11 +01001044extern void blk_set_stacking_limits(struct queue_limits *lim);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001045extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1046 sector_t offset);
Martin K. Petersen17be8c22010-01-11 03:21:49 -05001047extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1048 sector_t offset);
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001049extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1050 sector_t offset);
Jens Axboe165125e2007-07-24 09:28:11 +02001051extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
Tejun Heoe3790c72008-03-04 11:18:17 +01001052extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
FUJITA Tomonori27f82212008-07-04 09:30:03 +02001053extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
Tejun Heo2fb98e82008-02-19 11:36:53 +01001054extern int blk_queue_dma_drain(struct request_queue *q,
1055 dma_drain_needed_fn *dma_drain_needed,
1056 void *buf, unsigned int size);
Jens Axboe165125e2007-07-24 09:28:11 +02001057extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
Keith Busch03100aa2015-08-19 14:24:05 -07001058extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
Jens Axboe165125e2007-07-24 09:28:11 +02001059extern void blk_queue_dma_alignment(struct request_queue *, int);
James Bottomley11c3e682007-12-31 16:37:00 -06001060extern void blk_queue_update_dma_alignment(struct request_queue *, int);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001061extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
Jens Axboe93e9d8e2016-04-12 12:32:46 -06001062extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Christoph Hellwig1e739732017-02-08 14:46:49 +01001064/*
1065 * Number of physical segments as sent to the device.
1066 *
1067 * Normally this is the number of discontiguous data segments sent by the
1068 * submitter. But for data-less command like discard we might have no
1069 * actual data segments submitted, but the driver might have to add it's
1070 * own special payload. In that case we still return 1 here so that this
1071 * special payload will be mapped.
1072 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001073static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1074{
1075 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1076 return 1;
1077 return rq->nr_phys_segments;
1078}
1079
Christoph Hellwig1e739732017-02-08 14:46:49 +01001080/*
1081 * Number of discard segments (or ranges) the driver needs to fill in.
1082 * Each discard bio merged into a request is counted as one segment.
1083 */
1084static inline unsigned short blk_rq_nr_discard_segments(struct request *rq)
1085{
1086 return max_t(unsigned short, rq->nr_phys_segments, 1);
1087}
1088
Jens Axboe165125e2007-07-24 09:28:11 +02001089extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090extern void blk_dump_rq_flags(struct request *, char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091extern long nr_blockdev_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092
Tejun Heo09ac46c2011-12-14 00:33:38 +01001093bool __must_check blk_get_queue(struct request_queue *);
Jens Axboe165125e2007-07-24 09:28:11 +02001094struct request_queue *blk_alloc_queue(gfp_t);
Christoph Hellwig6d469642018-11-14 17:02:18 +01001095struct request_queue *blk_alloc_queue_node(gfp_t gfp_mask, int node_id);
Jens Axboe165125e2007-07-24 09:28:11 +02001096extern void blk_put_queue(struct request_queue *);
Jens Axboe3f21c262015-06-05 10:57:37 -06001097extern void blk_set_queue_dying(struct request_queue *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098
Shaohua Li316cc672011-07-08 08:19:21 +02001099/*
Suresh Jayaraman75df7132011-09-21 10:00:16 +02001100 * blk_plug permits building a queue of related requests by holding the I/O
1101 * fragments for a short period. This allows merging of sequential requests
1102 * into single larger request. As the requests are moved from a per-task list to
1103 * the device's request_queue in a batch, this results in improved scalability
1104 * as the lock contention for request_queue lock is reduced.
1105 *
1106 * It is ok not to disable preemption when adding the request to the plug list
1107 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1108 * the plug list when the task sleeps by itself. For details, please see
1109 * schedule() where blk_schedule_flush_plug() is called.
Shaohua Li316cc672011-07-08 08:19:21 +02001110 */
Jens Axboe73c10102011-03-08 13:19:51 +01001111struct blk_plug {
Jens Axboe320ae512013-10-24 09:20:05 +01001112 struct list_head mq_list; /* blk-mq requests */
Suresh Jayaraman75df7132011-09-21 10:00:16 +02001113 struct list_head cb_list; /* md requires an unplug callback */
Jens Axboe5f0ed772018-11-23 22:04:33 -07001114 unsigned short rq_count;
Jens Axboece5b0092018-11-27 17:13:56 -07001115 bool multiple_queues;
Jens Axboe73c10102011-03-08 13:19:51 +01001116};
Shaohua Li55c022b2011-07-08 08:19:20 +02001117#define BLK_MAX_REQUEST_COUNT 16
Shaohua Li50d24c32016-11-03 17:03:53 -07001118#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
Shaohua Li55c022b2011-07-08 08:19:20 +02001119
NeilBrown9cbb1752012-07-31 09:08:14 +02001120struct blk_plug_cb;
NeilBrown74018dc2012-07-31 09:08:15 +02001121typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
NeilBrown048c9372011-04-18 09:52:22 +02001122struct blk_plug_cb {
1123 struct list_head list;
NeilBrown9cbb1752012-07-31 09:08:14 +02001124 blk_plug_cb_fn callback;
1125 void *data;
NeilBrown048c9372011-04-18 09:52:22 +02001126};
NeilBrown9cbb1752012-07-31 09:08:14 +02001127extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1128 void *data, int size);
Jens Axboe73c10102011-03-08 13:19:51 +01001129extern void blk_start_plug(struct blk_plug *);
1130extern void blk_finish_plug(struct blk_plug *);
Jens Axboef6603782011-04-15 15:49:07 +02001131extern void blk_flush_plug_list(struct blk_plug *, bool);
Jens Axboe73c10102011-03-08 13:19:51 +01001132
1133static inline void blk_flush_plug(struct task_struct *tsk)
1134{
1135 struct blk_plug *plug = tsk->plug;
1136
Christoph Hellwig88b996c2011-04-15 15:20:10 +02001137 if (plug)
Jens Axboea237c1c2011-04-16 13:27:55 +02001138 blk_flush_plug_list(plug, false);
1139}
1140
1141static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1142{
1143 struct blk_plug *plug = tsk->plug;
1144
1145 if (plug)
Jens Axboef6603782011-04-15 15:49:07 +02001146 blk_flush_plug_list(plug, true);
Jens Axboe73c10102011-03-08 13:19:51 +01001147}
1148
1149static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1150{
1151 struct blk_plug *plug = tsk->plug;
1152
Jens Axboe320ae512013-10-24 09:20:05 +01001153 return plug &&
Jens Axboea1ce35f2018-10-29 10:23:51 -06001154 (!list_empty(&plug->mq_list) ||
Jens Axboe320ae512013-10-24 09:20:05 +01001155 !list_empty(&plug->cb_list));
Jens Axboe73c10102011-03-08 13:19:51 +01001156}
1157
Christoph Hellwigee472d82017-04-05 19:21:08 +02001158extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
1159extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1160 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
Christoph Hellwige950fdf2016-07-19 11:23:33 +02001161
1162#define BLKDEV_DISCARD_SECURE (1 << 0) /* issue a secure erase */
Christoph Hellwigdd3932e2010-09-16 20:51:46 +02001163
Dmitry Monakhovfbd9b092010-04-28 17:55:06 +04001164extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1165 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
Christoph Hellwig38f25252016-04-16 14:55:28 -04001166extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
Christoph Hellwig288dab82016-06-09 16:00:36 +02001167 sector_t nr_sects, gfp_t gfp_mask, int flags,
Mike Christie469e3212016-06-05 14:31:49 -05001168 struct bio **biop);
Christoph Hellwigee472d82017-04-05 19:21:08 +02001169
1170#define BLKDEV_ZERO_NOUNMAP (1 << 0) /* do not free blocks */
Christoph Hellwigcb365b92017-04-05 19:21:10 +02001171#define BLKDEV_ZERO_NOFALLBACK (1 << 1) /* don't write explicit zeroes */
Christoph Hellwigee472d82017-04-05 19:21:08 +02001172
Chaitanya Kulkarnie73c23f2016-11-30 12:28:58 -08001173extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1174 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
Christoph Hellwigee472d82017-04-05 19:21:08 +02001175 unsigned flags);
Dmitry Monakhov3f14d792010-04-28 17:55:09 +04001176extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
Christoph Hellwigee472d82017-04-05 19:21:08 +02001177 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1178
Christoph Hellwig2cf6d262010-08-18 05:29:10 -04001179static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1180 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
David Woodhousefb2dce82008-08-05 18:01:53 +01001181{
Bart Van Assche233bde22018-03-14 15:48:06 -07001182 return blkdev_issue_discard(sb->s_bdev,
1183 block << (sb->s_blocksize_bits -
1184 SECTOR_SHIFT),
1185 nr_blocks << (sb->s_blocksize_bits -
1186 SECTOR_SHIFT),
Christoph Hellwig2cf6d262010-08-18 05:29:10 -04001187 gfp_mask, flags);
David Woodhousefb2dce82008-08-05 18:01:53 +01001188}
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001189static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
Theodore Ts'oa107e5a2010-10-27 23:44:47 -04001190 sector_t nr_blocks, gfp_t gfp_mask)
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001191{
1192 return blkdev_issue_zeroout(sb->s_bdev,
Bart Van Assche233bde22018-03-14 15:48:06 -07001193 block << (sb->s_blocksize_bits -
1194 SECTOR_SHIFT),
1195 nr_blocks << (sb->s_blocksize_bits -
1196 SECTOR_SHIFT),
Christoph Hellwigee472d82017-04-05 19:21:08 +02001197 gfp_mask, 0);
Lukas Czernere6fa0be2010-10-27 21:30:04 -04001198}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Christoph Hellwigf00c4d82017-11-05 10:36:31 +03001200extern int blk_verify_command(unsigned char *cmd, fmode_t mode);
Adel Gadllah0b07de82008-06-26 13:48:27 +02001201
Martin K. Peterseneb28d312010-02-26 00:20:37 -05001202enum blk_default_limits {
1203 BLK_MAX_SEGMENTS = 128,
1204 BLK_SAFE_MAX_SECTORS = 255,
Jeff Moyerd2be5372015-08-13 14:57:57 -04001205 BLK_DEF_MAX_SECTORS = 2560,
Martin K. Peterseneb28d312010-02-26 00:20:37 -05001206 BLK_MAX_SEGMENT_SIZE = 65536,
1207 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1208};
Milan Broz0e435ac2008-12-03 12:55:08 +01001209
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001210static inline unsigned long queue_segment_boundary(struct request_queue *q)
1211{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001212 return q->limits.seg_boundary_mask;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001213}
1214
Keith Busch03100aa2015-08-19 14:24:05 -07001215static inline unsigned long queue_virt_boundary(struct request_queue *q)
1216{
1217 return q->limits.virt_boundary_mask;
1218}
1219
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001220static inline unsigned int queue_max_sectors(struct request_queue *q)
1221{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001222 return q->limits.max_sectors;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001223}
1224
1225static inline unsigned int queue_max_hw_sectors(struct request_queue *q)
1226{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001227 return q->limits.max_hw_sectors;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001228}
1229
Martin K. Petersen8a783622010-02-26 00:20:39 -05001230static inline unsigned short queue_max_segments(struct request_queue *q)
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001231{
Martin K. Petersen8a783622010-02-26 00:20:39 -05001232 return q->limits.max_segments;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001233}
1234
Christoph Hellwig1e739732017-02-08 14:46:49 +01001235static inline unsigned short queue_max_discard_segments(struct request_queue *q)
1236{
1237 return q->limits.max_discard_segments;
1238}
1239
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001240static inline unsigned int queue_max_segment_size(struct request_queue *q)
1241{
Martin K. Petersen025146e2009-05-22 17:17:51 -04001242 return q->limits.max_segment_size;
Martin K. Petersenae03bf62009-05-22 17:17:50 -04001243}
1244
Martin K. Petersene1defc42009-05-22 17:17:49 -04001245static inline unsigned short queue_logical_block_size(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246{
1247 int retval = 512;
1248
Martin K. Petersen025146e2009-05-22 17:17:51 -04001249 if (q && q->limits.logical_block_size)
1250 retval = q->limits.logical_block_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251
1252 return retval;
1253}
1254
Martin K. Petersene1defc42009-05-22 17:17:49 -04001255static inline unsigned short bdev_logical_block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256{
Martin K. Petersene1defc42009-05-22 17:17:49 -04001257 return queue_logical_block_size(bdev_get_queue(bdev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258}
1259
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001260static inline unsigned int queue_physical_block_size(struct request_queue *q)
1261{
1262 return q->limits.physical_block_size;
1263}
1264
Martin K. Petersen892b6f92010-10-13 21:18:03 +02001265static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
Martin K. Petersenac481c22009-10-03 20:52:01 +02001266{
1267 return queue_physical_block_size(bdev_get_queue(bdev));
1268}
1269
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001270static inline unsigned int queue_io_min(struct request_queue *q)
1271{
1272 return q->limits.io_min;
1273}
1274
Martin K. Petersenac481c22009-10-03 20:52:01 +02001275static inline int bdev_io_min(struct block_device *bdev)
1276{
1277 return queue_io_min(bdev_get_queue(bdev));
1278}
1279
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001280static inline unsigned int queue_io_opt(struct request_queue *q)
1281{
1282 return q->limits.io_opt;
1283}
1284
Martin K. Petersenac481c22009-10-03 20:52:01 +02001285static inline int bdev_io_opt(struct block_device *bdev)
1286{
1287 return queue_io_opt(bdev_get_queue(bdev));
1288}
1289
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001290static inline int queue_alignment_offset(struct request_queue *q)
1291{
Martin K. Petersenac481c22009-10-03 20:52:01 +02001292 if (q->limits.misaligned)
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001293 return -1;
1294
Martin K. Petersenac481c22009-10-03 20:52:01 +02001295 return q->limits.alignment_offset;
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001296}
1297
Martin K. Petersene03a72e2010-01-11 03:21:51 -05001298static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
Martin K. Petersen81744ee2009-12-29 08:35:35 +01001299{
1300 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
Bart Van Assche233bde22018-03-14 15:48:06 -07001301 unsigned int alignment = sector_div(sector, granularity >> SECTOR_SHIFT)
1302 << SECTOR_SHIFT;
Martin K. Petersen81744ee2009-12-29 08:35:35 +01001303
Mike Snitzerb8839b82014-10-08 18:26:13 -04001304 return (granularity + lim->alignment_offset - alignment) % granularity;
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001305}
1306
Martin K. Petersenac481c22009-10-03 20:52:01 +02001307static inline int bdev_alignment_offset(struct block_device *bdev)
1308{
1309 struct request_queue *q = bdev_get_queue(bdev);
1310
1311 if (q->limits.misaligned)
1312 return -1;
1313
1314 if (bdev != bdev->bd_contains)
1315 return bdev->bd_part->alignment_offset;
1316
1317 return q->limits.alignment_offset;
1318}
1319
Martin K. Petersen86b37282009-11-10 11:50:21 +01001320static inline int queue_discard_alignment(struct request_queue *q)
1321{
1322 if (q->limits.discard_misaligned)
1323 return -1;
1324
1325 return q->limits.discard_alignment;
1326}
1327
Martin K. Petersene03a72e2010-01-11 03:21:51 -05001328static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
Martin K. Petersen86b37282009-11-10 11:50:21 +01001329{
Linus Torvalds59771072012-12-19 07:18:35 -08001330 unsigned int alignment, granularity, offset;
Martin K. Petersendd3d1452010-01-11 03:21:48 -05001331
Martin K. Petersena934a002011-05-18 10:37:35 +02001332 if (!lim->max_discard_sectors)
1333 return 0;
1334
Linus Torvalds59771072012-12-19 07:18:35 -08001335 /* Why are these in bytes, not sectors? */
Bart Van Assche233bde22018-03-14 15:48:06 -07001336 alignment = lim->discard_alignment >> SECTOR_SHIFT;
1337 granularity = lim->discard_granularity >> SECTOR_SHIFT;
Linus Torvalds59771072012-12-19 07:18:35 -08001338 if (!granularity)
1339 return 0;
1340
1341 /* Offset of the partition start in 'granularity' sectors */
1342 offset = sector_div(sector, granularity);
1343
1344 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1345 offset = (granularity + alignment - offset) % granularity;
1346
1347 /* Turn it back into bytes, gaah */
Bart Van Assche233bde22018-03-14 15:48:06 -07001348 return offset << SECTOR_SHIFT;
Martin K. Petersen86b37282009-11-10 11:50:21 +01001349}
1350
Paolo Bonzinic6e66632012-08-02 09:48:50 +02001351static inline int bdev_discard_alignment(struct block_device *bdev)
1352{
1353 struct request_queue *q = bdev_get_queue(bdev);
1354
1355 if (bdev != bdev->bd_contains)
1356 return bdev->bd_part->discard_alignment;
1357
1358 return q->limits.discard_alignment;
1359}
1360
Martin K. Petersen4363ac72012-09-18 12:19:27 -04001361static inline unsigned int bdev_write_same(struct block_device *bdev)
1362{
1363 struct request_queue *q = bdev_get_queue(bdev);
1364
1365 if (q)
1366 return q->limits.max_write_same_sectors;
1367
1368 return 0;
1369}
1370
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -08001371static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1372{
1373 struct request_queue *q = bdev_get_queue(bdev);
1374
1375 if (q)
1376 return q->limits.max_write_zeroes_sectors;
1377
1378 return 0;
1379}
1380
Damien Le Moal797476b2016-10-18 15:40:29 +09001381static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1382{
1383 struct request_queue *q = bdev_get_queue(bdev);
1384
1385 if (q)
1386 return blk_queue_zoned_model(q);
1387
1388 return BLK_ZONED_NONE;
1389}
1390
1391static inline bool bdev_is_zoned(struct block_device *bdev)
1392{
1393 struct request_queue *q = bdev_get_queue(bdev);
1394
1395 if (q)
1396 return blk_queue_is_zoned(q);
1397
1398 return false;
1399}
1400
Damien Le Moalf99e8642017-01-12 07:58:32 -07001401static inline unsigned int bdev_zone_sectors(struct block_device *bdev)
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +09001402{
1403 struct request_queue *q = bdev_get_queue(bdev);
1404
1405 if (q)
Damien Le Moalf99e8642017-01-12 07:58:32 -07001406 return blk_queue_zone_sectors(q);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +09001407 return 0;
1408}
Hannes Reinecke6a0cb1b2016-10-18 15:40:33 +09001409
Jens Axboe165125e2007-07-24 09:28:11 +02001410static inline int queue_dma_alignment(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411{
Pete Wyckoff482eb682008-01-01 10:23:02 -05001412 return q ? q->dma_alignment : 511;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413}
1414
Namhyung Kim14417792010-09-15 13:08:27 +02001415static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
FUJITA Tomonori87904072008-08-28 15:05:58 +09001416 unsigned int len)
1417{
1418 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
Namhyung Kim14417792010-09-15 13:08:27 +02001419 return !(addr & alignment) && !(len & alignment);
FUJITA Tomonori87904072008-08-28 15:05:58 +09001420}
1421
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422/* assumes size > 256 */
1423static inline unsigned int blksize_bits(unsigned int size)
1424{
1425 unsigned int bits = 8;
1426 do {
1427 bits++;
1428 size >>= 1;
1429 } while (size > 256);
1430 return bits;
1431}
1432
Adrian Bunk2befb9e2005-09-10 00:27:17 -07001433static inline unsigned int block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434{
1435 return bdev->bd_block_size;
1436}
1437
1438typedef struct {struct page *v;} Sector;
1439
1440unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
1441
1442static inline void put_dev_sector(Sector p)
1443{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001444 put_page(p.v);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445}
1446
Jens Axboe59c3d452014-04-08 09:15:35 -06001447int kblockd_schedule_work(struct work_struct *work);
Jens Axboeee63cfa2016-08-24 15:52:48 -06001448int kblockd_schedule_work_on(int cpu, struct work_struct *work);
Jens Axboe818cd1c2017-04-10 09:54:55 -06001449int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1452 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1453#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1454 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1455
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001456#if defined(CONFIG_BLK_DEV_INTEGRITY)
1457
Martin K. Petersen8288f492014-09-26 19:20:02 -04001458enum blk_integrity_flags {
1459 BLK_INTEGRITY_VERIFY = 1 << 0,
1460 BLK_INTEGRITY_GENERATE = 1 << 1,
Martin K. Petersen3aec2f42014-09-26 19:20:03 -04001461 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
Martin K. Petersenaae7df52014-09-26 19:20:05 -04001462 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
Martin K. Petersen8288f492014-09-26 19:20:02 -04001463};
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001464
Martin K. Petersen18593082014-09-26 19:20:01 -04001465struct blk_integrity_iter {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001466 void *prot_buf;
1467 void *data_buf;
Martin K. Petersen3be91c42014-09-26 19:19:59 -04001468 sector_t seed;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001469 unsigned int data_size;
Martin K. Petersen3be91c42014-09-26 19:19:59 -04001470 unsigned short interval;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001471 const char *disk_name;
1472};
1473
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +02001474typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001475
Martin K. Petersen0f8087e2015-10-21 13:19:33 -04001476struct blk_integrity_profile {
1477 integrity_processing_fn *generate_fn;
1478 integrity_processing_fn *verify_fn;
1479 const char *name;
1480};
1481
Martin K. Petersen25520d52015-10-21 13:19:49 -04001482extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001483extern void blk_integrity_unregister(struct gendisk *);
Martin K. Petersenad7fce92008-10-01 03:38:39 -04001484extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001485extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1486 struct scatterlist *);
1487extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001488extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1489 struct request *);
1490extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1491 struct bio *);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001492
Martin K. Petersen25520d52015-10-21 13:19:49 -04001493static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1494{
Dan Williamsac6fc482015-10-21 13:20:18 -04001495 struct blk_integrity *bi = &disk->queue->integrity;
Martin K. Petersen25520d52015-10-21 13:19:49 -04001496
1497 if (!bi->profile)
1498 return NULL;
1499
1500 return bi;
1501}
1502
Jens Axboeb04accc2008-10-02 12:53:22 +02001503static inline
1504struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
1505{
Martin K. Petersen25520d52015-10-21 13:19:49 -04001506 return blk_get_integrity(bdev->bd_disk);
Martin K. Petersenb02739b2008-10-02 18:47:49 +02001507}
1508
Martin K. Petersen180b2f92014-09-26 19:19:56 -04001509static inline bool blk_integrity_rq(struct request *rq)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001510{
Martin K. Petersen180b2f92014-09-26 19:19:56 -04001511 return rq->cmd_flags & REQ_INTEGRITY;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001512}
1513
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001514static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1515 unsigned int segs)
1516{
1517 q->limits.max_integrity_segments = segs;
1518}
1519
1520static inline unsigned short
1521queue_max_integrity_segments(struct request_queue *q)
1522{
1523 return q->limits.max_integrity_segments;
1524}
1525
Greg Edwards359f6422018-07-25 10:22:58 -04001526/**
1527 * bio_integrity_intervals - Return number of integrity intervals for a bio
1528 * @bi: blk_integrity profile for device
1529 * @sectors: Size of the bio in 512-byte sectors
1530 *
1531 * Description: The block layer calculates everything in 512 byte
1532 * sectors but integrity metadata is done in terms of the data integrity
1533 * interval size of the storage device. Convert the block layer sectors
1534 * to the appropriate number of integrity intervals.
1535 */
1536static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1537 unsigned int sectors)
1538{
1539 return sectors >> (bi->interval_exp - 9);
1540}
1541
1542static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1543 unsigned int sectors)
1544{
1545 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
1546}
1547
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001548#else /* CONFIG_BLK_DEV_INTEGRITY */
1549
Stephen Rothwellfd832402012-01-12 09:17:30 +01001550struct bio;
1551struct block_device;
1552struct gendisk;
1553struct blk_integrity;
1554
1555static inline int blk_integrity_rq(struct request *rq)
1556{
1557 return 0;
1558}
1559static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1560 struct bio *b)
1561{
1562 return 0;
1563}
1564static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1565 struct bio *b,
1566 struct scatterlist *s)
1567{
1568 return 0;
1569}
1570static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1571{
Michele Curti61a04e52014-10-09 15:30:17 -07001572 return NULL;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001573}
1574static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1575{
1576 return NULL;
1577}
1578static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1579{
1580 return 0;
1581}
Martin K. Petersen25520d52015-10-21 13:19:49 -04001582static inline void blk_integrity_register(struct gendisk *d,
Stephen Rothwellfd832402012-01-12 09:17:30 +01001583 struct blk_integrity *b)
1584{
Stephen Rothwellfd832402012-01-12 09:17:30 +01001585}
1586static inline void blk_integrity_unregister(struct gendisk *d)
1587{
1588}
1589static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1590 unsigned int segs)
1591{
1592}
1593static inline unsigned short queue_max_integrity_segments(struct request_queue *q)
1594{
1595 return 0;
1596}
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001597static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1598 struct request *r1,
1599 struct request *r2)
Stephen Rothwellfd832402012-01-12 09:17:30 +01001600{
Martin K. Petersencb1a5ab2014-10-28 20:27:43 -06001601 return true;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001602}
Martin K. Petersen4eaf99b2014-09-26 19:20:06 -04001603static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1604 struct request *r,
1605 struct bio *b)
Stephen Rothwellfd832402012-01-12 09:17:30 +01001606{
Martin K. Petersencb1a5ab2014-10-28 20:27:43 -06001607 return true;
Stephen Rothwellfd832402012-01-12 09:17:30 +01001608}
Martin K. Petersen25520d52015-10-21 13:19:49 -04001609
Greg Edwards359f6422018-07-25 10:22:58 -04001610static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1611 unsigned int sectors)
1612{
1613 return 0;
1614}
1615
1616static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1617 unsigned int sectors)
1618{
1619 return 0;
1620}
1621
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001622#endif /* CONFIG_BLK_DEV_INTEGRITY */
1623
Al Viro08f85852007-10-08 13:26:20 -04001624struct block_device_operations {
Al Virod4430d62008-03-02 09:09:22 -05001625 int (*open) (struct block_device *, fmode_t);
Al Virodb2a1442013-05-05 21:52:57 -04001626 void (*release) (struct gendisk *, fmode_t);
Tejun Heo3f289dc2018-07-18 04:47:36 -07001627 int (*rw_page)(struct block_device *, sector_t, struct page *, unsigned int);
Al Virod4430d62008-03-02 09:09:22 -05001628 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1629 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
Tejun Heo77ea8872010-12-08 20:57:37 +01001630 unsigned int (*check_events) (struct gendisk *disk,
1631 unsigned int clearing);
1632 /* ->media_changed() is DEPRECATED, use ->check_events() instead */
Al Viro08f85852007-10-08 13:26:20 -04001633 int (*media_changed) (struct gendisk *);
Tejun Heoc3e33e02010-05-15 20:09:29 +02001634 void (*unlock_native_capacity) (struct gendisk *);
Al Viro08f85852007-10-08 13:26:20 -04001635 int (*revalidate_disk) (struct gendisk *);
1636 int (*getgeo)(struct block_device *, struct hd_geometry *);
Nitin Guptab3a27d02010-05-17 11:02:43 +05301637 /* this callback is with swap_lock and sometimes page table lock held */
1638 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
Christoph Hellwige76239a2018-10-12 19:08:49 +09001639 int (*report_zones)(struct gendisk *, sector_t sector,
1640 struct blk_zone *zones, unsigned int *nr_zones,
1641 gfp_t gfp_mask);
Al Viro08f85852007-10-08 13:26:20 -04001642 struct module *owner;
Christoph Hellwigbbd3e062015-10-15 14:10:48 +02001643 const struct pr_ops *pr_ops;
Al Viro08f85852007-10-08 13:26:20 -04001644};
1645
Al Viro633a08b2007-08-29 20:34:12 -04001646extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1647 unsigned long);
Matthew Wilcox47a191f2014-06-04 16:07:46 -07001648extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1649extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1650 struct writeback_control *);
Christoph Hellwig6cc77e92017-12-21 15:43:38 +09001651
1652#ifdef CONFIG_BLK_DEV_ZONED
1653bool blk_req_needs_zone_write_lock(struct request *rq);
1654void __blk_req_zone_write_lock(struct request *rq);
1655void __blk_req_zone_write_unlock(struct request *rq);
1656
1657static inline void blk_req_zone_write_lock(struct request *rq)
1658{
1659 if (blk_req_needs_zone_write_lock(rq))
1660 __blk_req_zone_write_lock(rq);
1661}
1662
1663static inline void blk_req_zone_write_unlock(struct request *rq)
1664{
1665 if (rq->rq_flags & RQF_ZONE_WRITE_LOCKED)
1666 __blk_req_zone_write_unlock(rq);
1667}
1668
1669static inline bool blk_req_zone_is_write_locked(struct request *rq)
1670{
1671 return rq->q->seq_zones_wlock &&
1672 test_bit(blk_rq_zone_no(rq), rq->q->seq_zones_wlock);
1673}
1674
1675static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1676{
1677 if (!blk_req_needs_zone_write_lock(rq))
1678 return true;
1679 return !blk_req_zone_is_write_locked(rq);
1680}
1681#else
1682static inline bool blk_req_needs_zone_write_lock(struct request *rq)
1683{
1684 return false;
1685}
1686
1687static inline void blk_req_zone_write_lock(struct request *rq)
1688{
1689}
1690
1691static inline void blk_req_zone_write_unlock(struct request *rq)
1692{
1693}
1694static inline bool blk_req_zone_is_write_locked(struct request *rq)
1695{
1696 return false;
1697}
1698
1699static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1700{
1701 return true;
1702}
1703#endif /* CONFIG_BLK_DEV_ZONED */
1704
David Howells93614012006-09-30 20:45:40 +02001705#else /* CONFIG_BLOCK */
Fabian Frederickac13a822014-06-04 16:06:27 -07001706
1707struct block_device;
1708
David Howells93614012006-09-30 20:45:40 +02001709/*
1710 * stubs for when the block layer is configured out
1711 */
1712#define buffer_heads_over_limit 0
1713
David Howells93614012006-09-30 20:45:40 +02001714static inline long nr_blockdev_pages(void)
1715{
1716 return 0;
1717}
1718
Jens Axboe1f940bd2011-03-11 20:17:08 +01001719struct blk_plug {
1720};
1721
1722static inline void blk_start_plug(struct blk_plug *plug)
Jens Axboe73c10102011-03-08 13:19:51 +01001723{
1724}
1725
Jens Axboe1f940bd2011-03-11 20:17:08 +01001726static inline void blk_finish_plug(struct blk_plug *plug)
Jens Axboe73c10102011-03-08 13:19:51 +01001727{
1728}
1729
Jens Axboe1f940bd2011-03-11 20:17:08 +01001730static inline void blk_flush_plug(struct task_struct *task)
Jens Axboe73c10102011-03-08 13:19:51 +01001731{
1732}
1733
Jens Axboea237c1c2011-04-16 13:27:55 +02001734static inline void blk_schedule_flush_plug(struct task_struct *task)
1735{
1736}
1737
1738
Jens Axboe73c10102011-03-08 13:19:51 +01001739static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1740{
1741 return false;
1742}
1743
Fabian Frederickac13a822014-06-04 16:06:27 -07001744static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
1745 sector_t *error_sector)
1746{
1747 return 0;
1748}
1749
David Howells93614012006-09-30 20:45:40 +02001750#endif /* CONFIG_BLOCK */
1751
Jens Axboe06193172018-11-13 21:16:54 -07001752static inline void blk_wake_io_task(struct task_struct *waiter)
1753{
1754 /*
1755 * If we're polling, the task itself is doing the completions. For
1756 * that case, we don't need to signal a wakeup, it's enough to just
1757 * mark us as RUNNING.
1758 */
1759 if (waiter == current)
1760 __set_current_state(TASK_RUNNING);
1761 else
1762 wake_up_process(waiter);
1763}
1764
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765#endif