blk-mq: Use request queue-wide tags for tagset-wide sbitmap
[linux-block.git] / block / blk.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
8324aa91
JA
2#ifndef BLK_INTERNAL_H
3#define BLK_INTERNAL_H
4
a73f730d 5#include <linux/idr.h>
f70ced09 6#include <linux/blk-mq.h>
c6a564ff 7#include <linux/part_stat.h>
a892c8d5 8#include <linux/blk-crypto.h>
9bb33f24 9#include <linux/memblock.h> /* for max_pfn/max_low_pfn */
c39ae60d 10#include <xen/xen.h>
a892c8d5 11#include "blk-crypto-internal.h"
f70ced09 12#include "blk-mq.h"
c3e22192 13#include "blk-mq-sched.h"
a73f730d 14
0d2602ca
JA
15/* Max future timer expiry for timeouts */
16#define BLK_MAX_TIMEOUT (5 * HZ)
17
18fbda91 18extern struct dentry *blk_debugfs_root;
18fbda91 19
7c94e1c1 20struct blk_flush_queue {
7c94e1c1
ML
21 unsigned int flush_pending_idx:1;
22 unsigned int flush_running_idx:1;
8d699663 23 blk_status_t rq_status;
7c94e1c1
ML
24 unsigned long flush_pending_since;
25 struct list_head flush_queue[2];
26 struct list_head flush_data_in_flight;
27 struct request *flush_rq;
0048b483 28
7c94e1c1
ML
29 spinlock_t mq_flush_lock;
30};
31
8324aa91
JA
32extern struct kmem_cache *blk_requestq_cachep;
33extern struct kobj_type blk_queue_ktype;
a73f730d 34extern struct ida blk_queue_ida;
8324aa91 35
f9afca4d
JA
36static inline struct blk_flush_queue *
37blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 38{
8ccdf4a3 39 return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
7c94e1c1
ML
40}
41
09ac46c4
TH
42static inline void __blk_get_queue(struct request_queue *q)
43{
44 kobject_get(&q->kobj);
45}
46
8d699663
YY
47static inline bool
48is_flush_rq(struct request *req, struct blk_mq_hw_ctx *hctx)
49{
50 return hctx->fq->flush_rq == req;
51}
52
754a1572
GJ
53struct blk_flush_queue *blk_alloc_flush_queue(int node, int cmd_size,
54 gfp_t flags);
f70ced09 55void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 56
3ef28e83
DW
57void blk_freeze_queue(struct request_queue *q);
58
dc0b8a57 59#define BIO_INLINE_VECS 4
7a800a20
CH
60struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs,
61 gfp_t gfp_mask);
62void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs);
eec716a1 63
3dccdae5
CH
64static inline bool biovec_phys_mergeable(struct request_queue *q,
65 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 66{
3dccdae5 67 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
68 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
69 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
70
71 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 72 return false;
0383ad43 73 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
6a9f5f24 74 return false;
3dccdae5
CH
75 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
76 return false;
6a9f5f24
CH
77 return true;
78}
79
27ca1d4e
CH
80static inline bool __bvec_gap_to_prev(struct request_queue *q,
81 struct bio_vec *bprv, unsigned int offset)
82{
df376b2e 83 return (offset & queue_virt_boundary(q)) ||
27ca1d4e
CH
84 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
85}
86
87/*
88 * Check if adding a bio_vec after bprv with offset would create a gap in
89 * the SG list. Most drivers don't care about this, but some do.
90 */
91static inline bool bvec_gap_to_prev(struct request_queue *q,
92 struct bio_vec *bprv, unsigned int offset)
93{
94 if (!queue_virt_boundary(q))
95 return false;
96 return __bvec_gap_to_prev(q, bprv, offset);
97}
98
5a48fc14
DW
99#ifdef CONFIG_BLK_DEV_INTEGRITY
100void blk_flush_integrity(void);
7c20f116 101bool __bio_integrity_endio(struct bio *);
ece841ab 102void bio_integrity_free(struct bio *bio);
7c20f116
CH
103static inline bool bio_integrity_endio(struct bio *bio)
104{
105 if (bio_integrity(bio))
106 return __bio_integrity_endio(bio);
107 return true;
108}
43b729bf 109
92cf2fd1
CH
110bool blk_integrity_merge_rq(struct request_queue *, struct request *,
111 struct request *);
d59da419
CH
112bool blk_integrity_merge_bio(struct request_queue *, struct request *,
113 struct bio *);
92cf2fd1 114
43b729bf
CH
115static inline bool integrity_req_gap_back_merge(struct request *req,
116 struct bio *next)
117{
118 struct bio_integrity_payload *bip = bio_integrity(req->bio);
119 struct bio_integrity_payload *bip_next = bio_integrity(next);
120
121 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
122 bip_next->bip_vec[0].bv_offset);
123}
124
125static inline bool integrity_req_gap_front_merge(struct request *req,
126 struct bio *bio)
127{
128 struct bio_integrity_payload *bip = bio_integrity(bio);
129 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
130
131 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
132 bip_next->bip_vec[0].bv_offset);
133}
581e2600
CH
134
135void blk_integrity_add(struct gendisk *);
136void blk_integrity_del(struct gendisk *);
43b729bf 137#else /* CONFIG_BLK_DEV_INTEGRITY */
92cf2fd1
CH
138static inline bool blk_integrity_merge_rq(struct request_queue *rq,
139 struct request *r1, struct request *r2)
140{
141 return true;
142}
d59da419
CH
143static inline bool blk_integrity_merge_bio(struct request_queue *rq,
144 struct request *r, struct bio *b)
145{
146 return true;
147}
43b729bf
CH
148static inline bool integrity_req_gap_back_merge(struct request *req,
149 struct bio *next)
150{
151 return false;
152}
153static inline bool integrity_req_gap_front_merge(struct request *req,
154 struct bio *bio)
155{
156 return false;
157}
158
5a48fc14
DW
159static inline void blk_flush_integrity(void)
160{
161}
7c20f116
CH
162static inline bool bio_integrity_endio(struct bio *bio)
163{
164 return true;
165}
ece841ab
JT
166static inline void bio_integrity_free(struct bio *bio)
167{
168}
581e2600
CH
169static inline void blk_integrity_add(struct gendisk *disk)
170{
171}
172static inline void blk_integrity_del(struct gendisk *disk)
173{
174}
43b729bf 175#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 176
0d2602ca 177unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 178void blk_add_timer(struct request *req);
320ae51f 179
320ae51f 180bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
14ccb66b 181 unsigned int nr_segs, struct request **same_queue_rq);
bdc6a287
BW
182bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
183 struct bio *bio, unsigned int nr_segs);
320ae51f 184
b5af37ab 185void blk_account_io_start(struct request *req);
522a7775 186void blk_account_io_done(struct request *req, u64 now);
320ae51f 187
158dbda0
TH
188/*
189 * Internal elevator interface
190 */
e8064021 191#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 192
ae1b1539 193void blk_insert_flush(struct request *rq);
dd831006 194
954b4a5c 195void elevator_init_mq(struct request_queue *q);
d48ece20
JW
196int elevator_switch_mq(struct request_queue *q,
197 struct elevator_type *new_e);
c3e22192 198void __elevator_exit(struct request_queue *, struct elevator_queue *);
cecf5d87 199int elv_register_queue(struct request_queue *q, bool uevent);
83d016ac
BVA
200void elv_unregister_queue(struct request_queue *q);
201
c3e22192
ML
202static inline void elevator_exit(struct request_queue *q,
203 struct elevator_queue *e)
204{
284b94be
ML
205 lockdep_assert_held(&q->sysfs_lock);
206
c3e22192
ML
207 blk_mq_sched_free_requests(q);
208 __elevator_exit(q, e);
209}
210
3ad5cee5
CH
211ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
212 char *buf);
213ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
214 char *buf);
215ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
216 char *buf);
217ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
218 char *buf);
219ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
220 const char *buf, size_t count);
581d4e28
JA
221ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
222ssize_t part_timeout_store(struct device *, struct device_attribute *,
223 const char *, size_t);
581d4e28 224
f695ca38 225void __blk_queue_split(struct bio **bio, unsigned int *nr_segs);
14ccb66b
CH
226int ll_back_merge_fn(struct request *req, struct bio *bio,
227 unsigned int nr_segs);
5e84ea3a
JA
228int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
229 struct request *next);
e9cd19c0 230unsigned int blk_recalc_rq_segments(struct request *rq);
80a761fd 231void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 232bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 233enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 234
ff88972c
AB
235int blk_dev_init(void);
236
c2553b58
JA
237/*
238 * Contribute to IO statistics IFF:
239 *
240 * a) it's attached to a gendisk, and
48d9b0d4 241 * b) the queue had IO stats enabled when this request was started
c2553b58 242 */
599d067d 243static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 244{
48d9b0d4 245 return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
fb8ec18c
JA
246}
247
6cf7677f
CH
248static inline void req_set_nomerge(struct request_queue *q, struct request *req)
249{
250 req->cmd_flags |= REQ_NOMERGE;
251 if (req == q->last_merge)
252 q->last_merge = NULL;
253}
254
1adfc5e4
ML
255/*
256 * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
257 * is defined as 'unsigned int', meantime it has to aligned to with logical
258 * block size which is the minimum accepted unit by hardware.
259 */
260static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
261{
262 return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
263}
264
9b15d109
CL
265/*
266 * The max bio size which is aligned to q->limits.discard_granularity. This
267 * is a hint to split large discard bio in generic block layer, then if device
268 * driver needs to split the discard bio into smaller ones, their bi_size can
269 * be very probably and easily aligned to discard_granularity of the device's
270 * queue.
271 */
272static inline unsigned int bio_aligned_discard_max_sectors(
273 struct request_queue *q)
274{
275 return round_down(UINT_MAX, q->limits.discard_granularity) >>
276 SECTOR_SHIFT;
277}
278
f2dbd76a
TH
279/*
280 * Internal io_context interface
281 */
282void get_io_context(struct io_context *ioc);
47fdd4ca 283struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
284struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
285 gfp_t gfp_mask);
7e5a8794 286void ioc_clear_queue(struct request_queue *q);
f2dbd76a 287
24acfc34 288int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 289
f2dbd76a
TH
290/*
291 * Internal throttling interface
292 */
bc9fcbf9 293#ifdef CONFIG_BLK_DEV_THROTTLING
bc9fcbf9
TH
294extern int blk_throtl_init(struct request_queue *q);
295extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 296extern void blk_throtl_register_queue(struct request_queue *q);
db18a53e 297bool blk_throtl_bio(struct bio *bio);
bc9fcbf9 298#else /* CONFIG_BLK_DEV_THROTTLING */
bc9fcbf9
TH
299static inline int blk_throtl_init(struct request_queue *q) { return 0; }
300static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 301static inline void blk_throtl_register_queue(struct request_queue *q) { }
db18a53e 302static inline bool blk_throtl_bio(struct bio *bio) { return false; }
bc9fcbf9 303#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
304#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
305extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
306extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
307 const char *page, size_t count);
9e234eea 308extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 309extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
310#else
311static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 312static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 313#endif
bc9fcbf9 314
9bb33f24
CH
315void __blk_queue_bounce(struct request_queue *q, struct bio **bio);
316
317static inline bool blk_queue_may_bounce(struct request_queue *q)
318{
319 return IS_ENABLED(CONFIG_BOUNCE) &&
320 q->limits.bounce == BLK_BOUNCE_HIGH &&
321 max_low_pfn >= max_pfn;
322}
323
3bce016a
CH
324static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
325{
9bb33f24
CH
326 if (unlikely(blk_queue_may_bounce(q) && bio_has_data(*bio)))
327 __blk_queue_bounce(q, bio);
3bce016a 328}
3bce016a 329
d7067512
JB
330#ifdef CONFIG_BLK_CGROUP_IOLATENCY
331extern int blk_iolatency_init(struct request_queue *q);
332#else
333static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
334#endif
335
a2d6b3a2
DLM
336struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
337
bf505456
DLM
338#ifdef CONFIG_BLK_DEV_ZONED
339void blk_queue_free_zone_bitmaps(struct request_queue *q);
508aebb8 340void blk_queue_clear_zone_settings(struct request_queue *q);
bf505456
DLM
341#else
342static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
508aebb8 343static inline void blk_queue_clear_zone_settings(struct request_queue *q) {}
bf505456
DLM
344#endif
345
9fc995a6 346int blk_alloc_devt(struct block_device *part, dev_t *devt);
581e2600 347void blk_free_devt(dev_t devt);
581e2600
CH
348char *disk_name(struct gendisk *hd, int partno, char *buf);
349#define ADDPART_FLAG_NONE 0
350#define ADDPART_FLAG_RAID 1
351#define ADDPART_FLAG_WHOLEDISK 2
fa9156ae
CH
352int bdev_add_partition(struct block_device *bdev, int partno,
353 sector_t start, sector_t length);
354int bdev_del_partition(struct block_device *bdev, int partno);
355int bdev_resize_partition(struct block_device *bdev, int partno,
356 sector_t start, sector_t length);
581e2600 357
e4581105 358int bio_add_hw_page(struct request_queue *q, struct bio *bio,
130879f1 359 struct page *page, unsigned int len, unsigned int offset,
e4581105 360 unsigned int max_sectors, bool *same_page);
130879f1 361
bc9fcbf9 362#endif /* BLK_INTERNAL_H */