]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - block/blk.h
KEYS: Don't write out to userspace while holding key semaphore
[mirror_ubuntu-hirsute-kernel.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>
c39ae60d 7#include <xen/xen.h>
f70ced09 8#include "blk-mq.h"
c3e22192 9#include "blk-mq-sched.h"
a73f730d 10
0d2602ca
JA
11/* Max future timer expiry for timeouts */
12#define BLK_MAX_TIMEOUT (5 * HZ)
13
18fbda91
OS
14#ifdef CONFIG_DEBUG_FS
15extern struct dentry *blk_debugfs_root;
16#endif
17
7c94e1c1
ML
18struct blk_flush_queue {
19 unsigned int flush_queue_delayed:1;
20 unsigned int flush_pending_idx:1;
21 unsigned int flush_running_idx:1;
8d699663 22 blk_status_t rq_status;
7c94e1c1
ML
23 unsigned long flush_pending_since;
24 struct list_head flush_queue[2];
25 struct list_head flush_data_in_flight;
26 struct request *flush_rq;
0048b483
ML
27
28 /*
29 * flush_rq shares tag with this rq, both can't be active
30 * at the same time
31 */
32 struct request *orig_rq;
b3c6a599 33 struct lock_class_key key;
7c94e1c1
ML
34 spinlock_t mq_flush_lock;
35};
36
8324aa91
JA
37extern struct kmem_cache *blk_requestq_cachep;
38extern struct kobj_type blk_queue_ktype;
a73f730d 39extern struct ida blk_queue_ida;
8324aa91 40
f9afca4d
JA
41static inline struct blk_flush_queue *
42blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 43{
8ccdf4a3 44 return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
7c94e1c1
ML
45}
46
09ac46c4
TH
47static inline void __blk_get_queue(struct request_queue *q)
48{
49 kobject_get(&q->kobj);
50}
51
8d699663
YY
52static inline bool
53is_flush_rq(struct request *req, struct blk_mq_hw_ctx *hctx)
54{
55 return hctx->fq->flush_rq == req;
56}
57
f70ced09 58struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
5b202853 59 int node, int cmd_size, gfp_t flags);
f70ced09 60void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 61
3ef28e83
DW
62void blk_freeze_queue(struct request_queue *q);
63
64static inline void blk_queue_enter_live(struct request_queue *q)
65{
66 /*
67 * Given that running in generic_make_request() context
68 * guarantees that a live reference against q_usage_counter has
69 * been established, further references under that same context
70 * need not check that the queue has been frozen (marked dead).
71 */
72 percpu_ref_get(&q->q_usage_counter);
73}
8324aa91 74
3dccdae5
CH
75static inline bool biovec_phys_mergeable(struct request_queue *q,
76 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 77{
3dccdae5 78 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
79 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
80 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
81
82 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 83 return false;
0383ad43 84 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
6a9f5f24 85 return false;
3dccdae5
CH
86 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
87 return false;
6a9f5f24
CH
88 return true;
89}
90
27ca1d4e
CH
91static inline bool __bvec_gap_to_prev(struct request_queue *q,
92 struct bio_vec *bprv, unsigned int offset)
93{
df376b2e 94 return (offset & queue_virt_boundary(q)) ||
27ca1d4e
CH
95 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
96}
97
98/*
99 * Check if adding a bio_vec after bprv with offset would create a gap in
100 * the SG list. Most drivers don't care about this, but some do.
101 */
102static inline bool bvec_gap_to_prev(struct request_queue *q,
103 struct bio_vec *bprv, unsigned int offset)
104{
105 if (!queue_virt_boundary(q))
106 return false;
107 return __bvec_gap_to_prev(q, bprv, offset);
108}
109
1aa0a133
CH
110static inline void blk_rq_bio_prep(struct request *rq, struct bio *bio,
111 unsigned int nr_segs)
112{
113 rq->nr_phys_segments = nr_segs;
114 rq->__data_len = bio->bi_iter.bi_size;
115 rq->bio = rq->biotail = bio;
116 rq->ioprio = bio_prio(bio);
117
118 if (bio->bi_disk)
119 rq->rq_disk = bio->bi_disk;
120}
121
5a48fc14
DW
122#ifdef CONFIG_BLK_DEV_INTEGRITY
123void blk_flush_integrity(void);
7c20f116 124bool __bio_integrity_endio(struct bio *);
ece841ab 125void bio_integrity_free(struct bio *bio);
7c20f116
CH
126static inline bool bio_integrity_endio(struct bio *bio)
127{
128 if (bio_integrity(bio))
129 return __bio_integrity_endio(bio);
130 return true;
131}
43b729bf
CH
132
133static inline bool integrity_req_gap_back_merge(struct request *req,
134 struct bio *next)
135{
136 struct bio_integrity_payload *bip = bio_integrity(req->bio);
137 struct bio_integrity_payload *bip_next = bio_integrity(next);
138
139 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
140 bip_next->bip_vec[0].bv_offset);
141}
142
143static inline bool integrity_req_gap_front_merge(struct request *req,
144 struct bio *bio)
145{
146 struct bio_integrity_payload *bip = bio_integrity(bio);
147 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
148
149 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
150 bip_next->bip_vec[0].bv_offset);
151}
152#else /* CONFIG_BLK_DEV_INTEGRITY */
153static inline bool integrity_req_gap_back_merge(struct request *req,
154 struct bio *next)
155{
156 return false;
157}
158static inline bool integrity_req_gap_front_merge(struct request *req,
159 struct bio *bio)
160{
161 return false;
162}
163
5a48fc14
DW
164static inline void blk_flush_integrity(void)
165{
166}
7c20f116
CH
167static inline bool bio_integrity_endio(struct bio *bio)
168{
169 return true;
170}
ece841ab
JT
171static inline void bio_integrity_free(struct bio *bio)
172{
173}
43b729bf 174#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 175
0d2602ca 176unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 177void blk_add_timer(struct request *req);
320ae51f 178
14ccb66b
CH
179bool bio_attempt_front_merge(struct request *req, struct bio *bio,
180 unsigned int nr_segs);
181bool bio_attempt_back_merge(struct request *req, struct bio *bio,
182 unsigned int nr_segs);
1e739730
CH
183bool bio_attempt_discard_merge(struct request_queue *q, struct request *req,
184 struct bio *bio);
320ae51f 185bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
14ccb66b 186 unsigned int nr_segs, struct request **same_queue_rq);
320ae51f
JA
187
188void blk_account_io_start(struct request *req, bool new_io);
189void blk_account_io_completion(struct request *req, unsigned int bytes);
522a7775 190void blk_account_io_done(struct request *req, u64 now);
320ae51f 191
158dbda0
TH
192/*
193 * Internal elevator interface
194 */
e8064021 195#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 196
ae1b1539 197void blk_insert_flush(struct request *rq);
dd831006 198
954b4a5c 199void elevator_init_mq(struct request_queue *q);
d48ece20
JW
200int elevator_switch_mq(struct request_queue *q,
201 struct elevator_type *new_e);
c3e22192 202void __elevator_exit(struct request_queue *, struct elevator_queue *);
cecf5d87 203int elv_register_queue(struct request_queue *q, bool uevent);
83d016ac
BVA
204void elv_unregister_queue(struct request_queue *q);
205
c3e22192
ML
206static inline void elevator_exit(struct request_queue *q,
207 struct elevator_queue *e)
208{
284b94be
ML
209 lockdep_assert_held(&q->sysfs_lock);
210
c3e22192
ML
211 blk_mq_sched_free_requests(q);
212 __elevator_exit(q, e);
213}
214
807d4af2
CH
215struct hd_struct *__disk_get_part(struct gendisk *disk, int partno);
216
581d4e28
JA
217#ifdef CONFIG_FAIL_IO_TIMEOUT
218int blk_should_fake_timeout(struct request_queue *);
219ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
220ssize_t part_timeout_store(struct device *, struct device_attribute *,
221 const char *, size_t);
222#else
223static inline int blk_should_fake_timeout(struct request_queue *q)
224{
225 return 0;
226}
227#endif
228
14ccb66b
CH
229void __blk_queue_split(struct request_queue *q, struct bio **bio,
230 unsigned int *nr_segs);
231int ll_back_merge_fn(struct request *req, struct bio *bio,
232 unsigned int nr_segs);
233int ll_front_merge_fn(struct request *req, struct bio *bio,
234 unsigned int nr_segs);
b973cb7e
JA
235struct request *attempt_back_merge(struct request_queue *q, struct request *rq);
236struct request *attempt_front_merge(struct request_queue *q, struct request *rq);
5e84ea3a
JA
237int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
238 struct request *next);
e9cd19c0 239unsigned int blk_recalc_rq_segments(struct request *rq);
80a761fd 240void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 241bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 242enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 243
ff88972c
AB
244int blk_dev_init(void);
245
c2553b58
JA
246/*
247 * Contribute to IO statistics IFF:
248 *
249 * a) it's attached to a gendisk, and
48d9b0d4 250 * b) the queue had IO stats enabled when this request was started
c2553b58 251 */
599d067d 252static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 253{
48d9b0d4 254 return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
fb8ec18c
JA
255}
256
6cf7677f
CH
257static inline void req_set_nomerge(struct request_queue *q, struct request *req)
258{
259 req->cmd_flags |= REQ_NOMERGE;
260 if (req == q->last_merge)
261 q->last_merge = NULL;
262}
263
1adfc5e4
ML
264/*
265 * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
266 * is defined as 'unsigned int', meantime it has to aligned to with logical
267 * block size which is the minimum accepted unit by hardware.
268 */
269static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
270{
271 return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
272}
273
f2dbd76a
TH
274/*
275 * Internal io_context interface
276 */
277void get_io_context(struct io_context *ioc);
47fdd4ca 278struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
279struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
280 gfp_t gfp_mask);
7e5a8794 281void ioc_clear_queue(struct request_queue *q);
f2dbd76a 282
24acfc34 283int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a
TH
284
285/**
286 * create_io_context - try to create task->io_context
f2dbd76a
TH
287 * @gfp_mask: allocation mask
288 * @node: allocation node
289 *
24acfc34
TH
290 * If %current->io_context is %NULL, allocate a new io_context and install
291 * it. Returns the current %current->io_context which may be %NULL if
292 * allocation failed.
f2dbd76a
TH
293 *
294 * Note that this function can't be called with IRQ disabled because
24acfc34 295 * task_lock which protects %current->io_context is IRQ-unsafe.
f2dbd76a 296 */
24acfc34 297static inline struct io_context *create_io_context(gfp_t gfp_mask, int node)
f2dbd76a
TH
298{
299 WARN_ON_ONCE(irqs_disabled());
24acfc34
TH
300 if (unlikely(!current->io_context))
301 create_task_io_context(current, gfp_mask, node);
302 return current->io_context;
f2dbd76a
TH
303}
304
305/*
306 * Internal throttling interface
307 */
bc9fcbf9 308#ifdef CONFIG_BLK_DEV_THROTTLING
c9a929dd 309extern void blk_throtl_drain(struct request_queue *q);
bc9fcbf9
TH
310extern int blk_throtl_init(struct request_queue *q);
311extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 312extern void blk_throtl_register_queue(struct request_queue *q);
bc9fcbf9 313#else /* CONFIG_BLK_DEV_THROTTLING */
c9a929dd 314static inline void blk_throtl_drain(struct request_queue *q) { }
bc9fcbf9
TH
315static inline int blk_throtl_init(struct request_queue *q) { return 0; }
316static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 317static inline void blk_throtl_register_queue(struct request_queue *q) { }
bc9fcbf9 318#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
319#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
320extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
321extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
322 const char *page, size_t count);
9e234eea 323extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 324extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
325#else
326static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 327static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 328#endif
bc9fcbf9 329
3bce016a
CH
330#ifdef CONFIG_BOUNCE
331extern int init_emergency_isa_pool(void);
332extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
333#else
334static inline int init_emergency_isa_pool(void)
335{
336 return 0;
337}
338static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
339{
340}
341#endif /* CONFIG_BOUNCE */
342
d7067512
JB
343#ifdef CONFIG_BLK_CGROUP_IOLATENCY
344extern int blk_iolatency_init(struct request_queue *q);
345#else
346static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
347#endif
348
a2d6b3a2
DLM
349struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
350
bf505456
DLM
351#ifdef CONFIG_BLK_DEV_ZONED
352void blk_queue_free_zone_bitmaps(struct request_queue *q);
353#else
354static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
355#endif
356
bc9fcbf9 357#endif /* BLK_INTERNAL_H */