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