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