OPP: Populate required opp tables from "required-opps" property
[linux-2.6-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>
c39ae60d 7#include <xen/xen.h>
f70ced09 8#include "blk-mq.h"
a73f730d 9
86db1e29
JA
10/* Amount of time in which a process may batch requests */
11#define BLK_BATCH_TIME (HZ/50UL)
12
13/* Number of requests a "batching" process may submit */
14#define BLK_BATCH_REQ 32
15
0d2602ca
JA
16/* Max future timer expiry for timeouts */
17#define BLK_MAX_TIMEOUT (5 * HZ)
18
18fbda91
OS
19#ifdef CONFIG_DEBUG_FS
20extern struct dentry *blk_debugfs_root;
21#endif
22
7c94e1c1
ML
23struct blk_flush_queue {
24 unsigned int flush_queue_delayed:1;
25 unsigned int flush_pending_idx:1;
26 unsigned int flush_running_idx:1;
27 unsigned long flush_pending_since;
28 struct list_head flush_queue[2];
29 struct list_head flush_data_in_flight;
30 struct request *flush_rq;
0048b483
ML
31
32 /*
33 * flush_rq shares tag with this rq, both can't be active
34 * at the same time
35 */
36 struct request *orig_rq;
7c94e1c1
ML
37 spinlock_t mq_flush_lock;
38};
39
8324aa91 40extern struct kmem_cache *blk_requestq_cachep;
320ae51f 41extern struct kmem_cache *request_cachep;
8324aa91 42extern struct kobj_type blk_queue_ktype;
a73f730d 43extern struct ida blk_queue_ida;
8324aa91 44
8a0ac14b
BVA
45/*
46 * @q->queue_lock is set while a queue is being initialized. Since we know
47 * that no other threads access the queue object before @q->queue_lock has
48 * been set, it is safe to manipulate queue flags without holding the
49 * queue_lock if @q->queue_lock == NULL. See also blk_alloc_queue_node() and
50 * blk_init_allocated_queue().
51 */
52static inline void queue_lockdep_assert_held(struct request_queue *q)
53{
54 if (q->queue_lock)
55 lockdep_assert_held(q->queue_lock);
56}
57
58static inline void queue_flag_set_unlocked(unsigned int flag,
59 struct request_queue *q)
60{
61 if (test_bit(QUEUE_FLAG_INIT_DONE, &q->queue_flags) &&
62 kref_read(&q->kobj.kref))
63 lockdep_assert_held(q->queue_lock);
64 __set_bit(flag, &q->queue_flags);
65}
66
67static inline void queue_flag_clear_unlocked(unsigned int flag,
68 struct request_queue *q)
69{
70 if (test_bit(QUEUE_FLAG_INIT_DONE, &q->queue_flags) &&
71 kref_read(&q->kobj.kref))
72 lockdep_assert_held(q->queue_lock);
73 __clear_bit(flag, &q->queue_flags);
74}
75
76static inline int queue_flag_test_and_clear(unsigned int flag,
77 struct request_queue *q)
78{
79 queue_lockdep_assert_held(q);
80
81 if (test_bit(flag, &q->queue_flags)) {
82 __clear_bit(flag, &q->queue_flags);
83 return 1;
84 }
85
86 return 0;
87}
88
89static inline int queue_flag_test_and_set(unsigned int flag,
90 struct request_queue *q)
91{
92 queue_lockdep_assert_held(q);
93
94 if (!test_bit(flag, &q->queue_flags)) {
95 __set_bit(flag, &q->queue_flags);
96 return 0;
97 }
98
99 return 1;
100}
101
102static inline void queue_flag_set(unsigned int flag, struct request_queue *q)
103{
104 queue_lockdep_assert_held(q);
105 __set_bit(flag, &q->queue_flags);
106}
107
108static inline void queue_flag_clear(unsigned int flag, struct request_queue *q)
109{
110 queue_lockdep_assert_held(q);
111 __clear_bit(flag, &q->queue_flags);
112}
113
7c94e1c1 114static inline struct blk_flush_queue *blk_get_flush_queue(
e97c293c 115 struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 116{
7d7e0f90
CH
117 if (q->mq_ops)
118 return blk_mq_map_queue(q, ctx->cpu)->fq;
119 return q->fq;
7c94e1c1
ML
120}
121
09ac46c4
TH
122static inline void __blk_get_queue(struct request_queue *q)
123{
124 kobject_get(&q->kobj);
125}
126
f70ced09 127struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
5b202853 128 int node, int cmd_size, gfp_t flags);
f70ced09 129void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 130
5b788ce3
TH
131int blk_init_rl(struct request_list *rl, struct request_queue *q,
132 gfp_t gfp_mask);
b425e504 133void blk_exit_rl(struct request_queue *q, struct request_list *rl);
4cf6324b 134void blk_exit_queue(struct request_queue *q);
86db1e29
JA
135void blk_rq_bio_prep(struct request_queue *q, struct request *rq,
136 struct bio *bio);
d732580b
TH
137void blk_queue_bypass_start(struct request_queue *q);
138void blk_queue_bypass_end(struct request_queue *q);
8324aa91 139void __blk_queue_free_tags(struct request_queue *q);
3ef28e83
DW
140void blk_freeze_queue(struct request_queue *q);
141
142static inline void blk_queue_enter_live(struct request_queue *q)
143{
144 /*
145 * Given that running in generic_make_request() context
146 * guarantees that a live reference against q_usage_counter has
147 * been established, further references under that same context
148 * need not check that the queue has been frozen (marked dead).
149 */
150 percpu_ref_get(&q->q_usage_counter);
151}
8324aa91 152
3dccdae5
CH
153static inline bool biovec_phys_mergeable(struct request_queue *q,
154 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 155{
3dccdae5 156 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
157 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
158 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
159
160 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 161 return false;
c39ae60d 162 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2))
6a9f5f24 163 return false;
3dccdae5
CH
164 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
165 return false;
6a9f5f24
CH
166 return true;
167}
168
27ca1d4e
CH
169static inline bool __bvec_gap_to_prev(struct request_queue *q,
170 struct bio_vec *bprv, unsigned int offset)
171{
172 return offset ||
173 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
174}
175
176/*
177 * Check if adding a bio_vec after bprv with offset would create a gap in
178 * the SG list. Most drivers don't care about this, but some do.
179 */
180static inline bool bvec_gap_to_prev(struct request_queue *q,
181 struct bio_vec *bprv, unsigned int offset)
182{
183 if (!queue_virt_boundary(q))
184 return false;
185 return __bvec_gap_to_prev(q, bprv, offset);
186}
187
5a48fc14
DW
188#ifdef CONFIG_BLK_DEV_INTEGRITY
189void blk_flush_integrity(void);
7c20f116
CH
190bool __bio_integrity_endio(struct bio *);
191static inline bool bio_integrity_endio(struct bio *bio)
192{
193 if (bio_integrity(bio))
194 return __bio_integrity_endio(bio);
195 return true;
196}
43b729bf
CH
197
198static inline bool integrity_req_gap_back_merge(struct request *req,
199 struct bio *next)
200{
201 struct bio_integrity_payload *bip = bio_integrity(req->bio);
202 struct bio_integrity_payload *bip_next = bio_integrity(next);
203
204 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
205 bip_next->bip_vec[0].bv_offset);
206}
207
208static inline bool integrity_req_gap_front_merge(struct request *req,
209 struct bio *bio)
210{
211 struct bio_integrity_payload *bip = bio_integrity(bio);
212 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
213
214 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
215 bip_next->bip_vec[0].bv_offset);
216}
217#else /* CONFIG_BLK_DEV_INTEGRITY */
218static inline bool integrity_req_gap_back_merge(struct request *req,
219 struct bio *next)
220{
221 return false;
222}
223static inline bool integrity_req_gap_front_merge(struct request *req,
224 struct bio *bio)
225{
226 return false;
227}
228
5a48fc14
DW
229static inline void blk_flush_integrity(void)
230{
231}
7c20f116
CH
232static inline bool bio_integrity_endio(struct bio *bio)
233{
234 return true;
235}
43b729bf 236#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 237
287922eb 238void blk_timeout_work(struct work_struct *work);
0d2602ca 239unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 240void blk_add_timer(struct request *req);
242f9dcb 241void blk_delete_timer(struct request *);
242f9dcb 242
320ae51f
JA
243
244bool bio_attempt_front_merge(struct request_queue *q, struct request *req,
245 struct bio *bio);
246bool bio_attempt_back_merge(struct request_queue *q, struct request *req,
247 struct bio *bio);
1e739730
CH
248bool bio_attempt_discard_merge(struct request_queue *q, struct request *req,
249 struct bio *bio);
320ae51f 250bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
5b3f341f
SL
251 unsigned int *request_count,
252 struct request **same_queue_rq);
0809e3ac 253unsigned int blk_plug_queued_count(struct request_queue *q);
320ae51f
JA
254
255void blk_account_io_start(struct request *req, bool new_io);
256void blk_account_io_completion(struct request *req, unsigned int bytes);
522a7775 257void blk_account_io_done(struct request *req, u64 now);
320ae51f 258
242f9dcb
JA
259/*
260 * EH timer and IO completion will both attempt to 'grab' the request, make
e14575b3
JA
261 * sure that only one of them succeeds. Steal the bottom bit of the
262 * __deadline field for this.
242f9dcb
JA
263 */
264static inline int blk_mark_rq_complete(struct request *rq)
265{
e14575b3 266 return test_and_set_bit(0, &rq->__deadline);
242f9dcb
JA
267}
268
269static inline void blk_clear_rq_complete(struct request *rq)
270{
e14575b3
JA
271 clear_bit(0, &rq->__deadline);
272}
273
274static inline bool blk_rq_is_complete(struct request *rq)
275{
276 return test_bit(0, &rq->__deadline);
242f9dcb 277}
86db1e29 278
158dbda0
TH
279/*
280 * Internal elevator interface
281 */
e8064021 282#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 283
ae1b1539 284void blk_insert_flush(struct request *rq);
dd831006 285
158dbda0
TH
286static inline void elv_activate_rq(struct request_queue *q, struct request *rq)
287{
288 struct elevator_queue *e = q->elevator;
289
c51ca6cf
JA
290 if (e->type->ops.sq.elevator_activate_req_fn)
291 e->type->ops.sq.elevator_activate_req_fn(q, rq);
158dbda0
TH
292}
293
294static inline void elv_deactivate_rq(struct request_queue *q, struct request *rq)
295{
296 struct elevator_queue *e = q->elevator;
297
c51ca6cf
JA
298 if (e->type->ops.sq.elevator_deactivate_req_fn)
299 e->type->ops.sq.elevator_deactivate_req_fn(q, rq);
158dbda0
TH
300}
301
ddb72532 302int elevator_init(struct request_queue *);
131d08e1 303int elevator_init_mq(struct request_queue *q);
d48ece20
JW
304int elevator_switch_mq(struct request_queue *q,
305 struct elevator_type *new_e);
a8a275c9 306void elevator_exit(struct request_queue *, struct elevator_queue *);
83d016ac
BVA
307int elv_register_queue(struct request_queue *q);
308void elv_unregister_queue(struct request_queue *q);
309
807d4af2
CH
310struct hd_struct *__disk_get_part(struct gendisk *disk, int partno);
311
581d4e28
JA
312#ifdef CONFIG_FAIL_IO_TIMEOUT
313int blk_should_fake_timeout(struct request_queue *);
314ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
315ssize_t part_timeout_store(struct device *, struct device_attribute *,
316 const char *, size_t);
317#else
318static inline int blk_should_fake_timeout(struct request_queue *q)
319{
320 return 0;
321}
322#endif
323
d6d48196
JA
324int ll_back_merge_fn(struct request_queue *q, struct request *req,
325 struct bio *bio);
326int ll_front_merge_fn(struct request_queue *q, struct request *req,
327 struct bio *bio);
b973cb7e
JA
328struct request *attempt_back_merge(struct request_queue *q, struct request *rq);
329struct request *attempt_front_merge(struct request_queue *q, struct request *rq);
5e84ea3a
JA
330int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
331 struct request *next);
d6d48196 332void blk_recalc_rq_segments(struct request *rq);
80a761fd 333void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 334bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 335enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 336
8324aa91
JA
337void blk_queue_congestion_threshold(struct request_queue *q);
338
ff88972c
AB
339int blk_dev_init(void);
340
f253b86b 341
8324aa91
JA
342/*
343 * Return the threshold (number of used requests) at which the queue is
344 * considered to be congested. It include a little hysteresis to keep the
345 * context switch rate down.
346 */
347static inline int queue_congestion_on_threshold(struct request_queue *q)
348{
349 return q->nr_congestion_on;
350}
351
352/*
353 * The threshold at which a queue is considered to be uncongested
354 */
355static inline int queue_congestion_off_threshold(struct request_queue *q)
356{
357 return q->nr_congestion_off;
358}
359
e3a2b3f9
JA
360extern int blk_update_nr_requests(struct request_queue *, unsigned int);
361
c2553b58
JA
362/*
363 * Contribute to IO statistics IFF:
364 *
365 * a) it's attached to a gendisk, and
366 * b) the queue had IO stats enabled when this request was started, and
e2a60da7 367 * c) it's a file system request
c2553b58 368 */
599d067d 369static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 370{
33659ebb 371 return rq->rq_disk &&
e8064021 372 (rq->rq_flags & RQF_IO_STAT) &&
57292b58 373 !blk_rq_is_passthrough(rq);
fb8ec18c
JA
374}
375
6cf7677f
CH
376static inline void req_set_nomerge(struct request_queue *q, struct request *req)
377{
378 req->cmd_flags |= REQ_NOMERGE;
379 if (req == q->last_merge)
380 q->last_merge = NULL;
381}
382
0a72e7f4
JA
383/*
384 * Steal a bit from this field for legacy IO path atomic IO marking. Note that
385 * setting the deadline clears the bottom bit, potentially clearing the
386 * completed bit. The user has to be OK with this (current ones are fine).
387 */
388static inline void blk_rq_set_deadline(struct request *rq, unsigned long time)
389{
390 rq->__deadline = time & ~0x1UL;
391}
392
393static inline unsigned long blk_rq_deadline(struct request *rq)
394{
395 return rq->__deadline & ~0x1UL;
396}
397
f2dbd76a
TH
398/*
399 * Internal io_context interface
400 */
401void get_io_context(struct io_context *ioc);
47fdd4ca 402struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
403struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
404 gfp_t gfp_mask);
7e5a8794 405void ioc_clear_queue(struct request_queue *q);
f2dbd76a 406
24acfc34 407int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 408
c23ecb42
JA
409/**
410 * rq_ioc - determine io_context for request allocation
411 * @bio: request being allocated is for this bio (can be %NULL)
412 *
413 * Determine io_context to use for request allocation for @bio. May return
414 * %NULL if %current->io_context doesn't exist.
415 */
416static inline struct io_context *rq_ioc(struct bio *bio)
417{
418#ifdef CONFIG_BLK_CGROUP
419 if (bio && bio->bi_ioc)
420 return bio->bi_ioc;
421#endif
422 return current->io_context;
423}
424
f2dbd76a
TH
425/**
426 * create_io_context - try to create task->io_context
f2dbd76a
TH
427 * @gfp_mask: allocation mask
428 * @node: allocation node
429 *
24acfc34
TH
430 * If %current->io_context is %NULL, allocate a new io_context and install
431 * it. Returns the current %current->io_context which may be %NULL if
432 * allocation failed.
f2dbd76a
TH
433 *
434 * Note that this function can't be called with IRQ disabled because
24acfc34 435 * task_lock which protects %current->io_context is IRQ-unsafe.
f2dbd76a 436 */
24acfc34 437static inline struct io_context *create_io_context(gfp_t gfp_mask, int node)
f2dbd76a
TH
438{
439 WARN_ON_ONCE(irqs_disabled());
24acfc34
TH
440 if (unlikely(!current->io_context))
441 create_task_io_context(current, gfp_mask, node);
442 return current->io_context;
f2dbd76a
TH
443}
444
445/*
446 * Internal throttling interface
447 */
bc9fcbf9 448#ifdef CONFIG_BLK_DEV_THROTTLING
c9a929dd 449extern void blk_throtl_drain(struct request_queue *q);
bc9fcbf9
TH
450extern int blk_throtl_init(struct request_queue *q);
451extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 452extern void blk_throtl_register_queue(struct request_queue *q);
bc9fcbf9 453#else /* CONFIG_BLK_DEV_THROTTLING */
c9a929dd 454static inline void blk_throtl_drain(struct request_queue *q) { }
bc9fcbf9
TH
455static inline int blk_throtl_init(struct request_queue *q) { return 0; }
456static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 457static inline void blk_throtl_register_queue(struct request_queue *q) { }
bc9fcbf9 458#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
459#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
460extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
461extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
462 const char *page, size_t count);
9e234eea 463extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 464extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
465#else
466static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 467static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 468#endif
bc9fcbf9 469
3bce016a
CH
470#ifdef CONFIG_BOUNCE
471extern int init_emergency_isa_pool(void);
472extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
473#else
474static inline int init_emergency_isa_pool(void)
475{
476 return 0;
477}
478static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
479{
480}
481#endif /* CONFIG_BOUNCE */
482
454be724
ML
483extern void blk_drain_queue(struct request_queue *q);
484
d7067512
JB
485#ifdef CONFIG_BLK_CGROUP_IOLATENCY
486extern int blk_iolatency_init(struct request_queue *q);
487#else
488static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
489#endif
490
a2d6b3a2
DLM
491struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
492
bf505456
DLM
493#ifdef CONFIG_BLK_DEV_ZONED
494void blk_queue_free_zone_bitmaps(struct request_queue *q);
495#else
496static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
497#endif
498
bc9fcbf9 499#endif /* BLK_INTERNAL_H */