]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - block/blk.h
lkdtm: Add tests for NULL pointer dereference
[thirdparty/kernel/stable.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
ML
6#include <linux/blk-mq.h>
7#include "blk-mq.h"
a73f730d 8
86db1e29
JA
9/* Amount of time in which a process may batch requests */
10#define BLK_BATCH_TIME (HZ/50UL)
11
12/* Number of requests a "batching" process may submit */
13#define BLK_BATCH_REQ 32
14
0d2602ca
JA
15/* Max future timer expiry for timeouts */
16#define BLK_MAX_TIMEOUT (5 * HZ)
17
18fbda91
OS
18#ifdef CONFIG_DEBUG_FS
19extern struct dentry *blk_debugfs_root;
20#endif
21
7c94e1c1
ML
22struct blk_flush_queue {
23 unsigned int flush_queue_delayed:1;
24 unsigned int flush_pending_idx:1;
25 unsigned int flush_running_idx:1;
26 unsigned long flush_pending_since;
27 struct list_head flush_queue[2];
28 struct list_head flush_data_in_flight;
29 struct request *flush_rq;
0048b483
ML
30
31 /*
32 * flush_rq shares tag with this rq, both can't be active
33 * at the same time
34 */
35 struct request *orig_rq;
7c94e1c1
ML
36 spinlock_t mq_flush_lock;
37};
38
8324aa91 39extern struct kmem_cache *blk_requestq_cachep;
320ae51f 40extern struct kmem_cache *request_cachep;
8324aa91 41extern struct kobj_type blk_queue_ktype;
a73f730d 42extern struct ida blk_queue_ida;
8324aa91 43
7c94e1c1 44static inline struct blk_flush_queue *blk_get_flush_queue(
e97c293c 45 struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 46{
7d7e0f90
CH
47 if (q->mq_ops)
48 return blk_mq_map_queue(q, ctx->cpu)->fq;
49 return q->fq;
7c94e1c1
ML
50}
51
09ac46c4
TH
52static inline void __blk_get_queue(struct request_queue *q)
53{
54 kobject_get(&q->kobj);
55}
56
f70ced09
ML
57struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
58 int node, int cmd_size);
59void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 60
5b788ce3
TH
61int blk_init_rl(struct request_list *rl, struct request_queue *q,
62 gfp_t gfp_mask);
b425e504 63void blk_exit_rl(struct request_queue *q, struct request_list *rl);
86db1e29
JA
64void blk_rq_bio_prep(struct request_queue *q, struct request *rq,
65 struct bio *bio);
d732580b
TH
66void blk_queue_bypass_start(struct request_queue *q);
67void blk_queue_bypass_end(struct request_queue *q);
8324aa91 68void __blk_queue_free_tags(struct request_queue *q);
3ef28e83
DW
69void blk_freeze_queue(struct request_queue *q);
70
71static inline void blk_queue_enter_live(struct request_queue *q)
72{
73 /*
74 * Given that running in generic_make_request() context
75 * guarantees that a live reference against q_usage_counter has
76 * been established, further references under that same context
77 * need not check that the queue has been frozen (marked dead).
78 */
79 percpu_ref_get(&q->q_usage_counter);
80}
8324aa91 81
5a48fc14
DW
82#ifdef CONFIG_BLK_DEV_INTEGRITY
83void blk_flush_integrity(void);
7c20f116
CH
84bool __bio_integrity_endio(struct bio *);
85static inline bool bio_integrity_endio(struct bio *bio)
86{
87 if (bio_integrity(bio))
88 return __bio_integrity_endio(bio);
89 return true;
90}
5a48fc14
DW
91#else
92static inline void blk_flush_integrity(void)
93{
94}
7c20f116
CH
95static inline bool bio_integrity_endio(struct bio *bio)
96{
97 return true;
98}
5a48fc14 99#endif
8324aa91 100
287922eb 101void blk_timeout_work(struct work_struct *work);
0d2602ca 102unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 103void blk_add_timer(struct request *req);
242f9dcb 104void blk_delete_timer(struct request *);
242f9dcb 105
320ae51f
JA
106
107bool bio_attempt_front_merge(struct request_queue *q, struct request *req,
108 struct bio *bio);
109bool bio_attempt_back_merge(struct request_queue *q, struct request *req,
110 struct bio *bio);
1e739730
CH
111bool bio_attempt_discard_merge(struct request_queue *q, struct request *req,
112 struct bio *bio);
320ae51f 113bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
5b3f341f
SL
114 unsigned int *request_count,
115 struct request **same_queue_rq);
0809e3ac 116unsigned int blk_plug_queued_count(struct request_queue *q);
320ae51f
JA
117
118void blk_account_io_start(struct request *req, bool new_io);
119void blk_account_io_completion(struct request *req, unsigned int bytes);
120void blk_account_io_done(struct request *req);
121
242f9dcb
JA
122/*
123 * Internal atomic flags for request handling
124 */
125enum rq_atomic_flags {
126 REQ_ATOM_COMPLETE = 0,
320ae51f 127 REQ_ATOM_STARTED,
06426adf 128 REQ_ATOM_POLL_SLEPT,
242f9dcb
JA
129};
130
131/*
132 * EH timer and IO completion will both attempt to 'grab' the request, make
25985edc 133 * sure that only one of them succeeds
242f9dcb
JA
134 */
135static inline int blk_mark_rq_complete(struct request *rq)
136{
137 return test_and_set_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
138}
139
140static inline void blk_clear_rq_complete(struct request *rq)
141{
142 clear_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
143}
86db1e29 144
158dbda0
TH
145/*
146 * Internal elevator interface
147 */
e8064021 148#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 149
ae1b1539 150void blk_insert_flush(struct request *rq);
dd831006 151
158dbda0
TH
152static inline struct request *__elv_next_request(struct request_queue *q)
153{
154 struct request *rq;
e97c293c 155 struct blk_flush_queue *fq = blk_get_flush_queue(q, NULL);
158dbda0 156
332ebbf7
BVA
157 WARN_ON_ONCE(q->mq_ops);
158
158dbda0 159 while (1) {
ae1b1539 160 if (!list_empty(&q->queue_head)) {
158dbda0 161 rq = list_entry_rq(q->queue_head.next);
ae1b1539 162 return rq;
158dbda0
TH
163 }
164
3ac0cc45 165 /*
166 * Flush request is running and flush request isn't queueable
167 * in the drive, we can hold the queue till flush request is
168 * finished. Even we don't do this, driver can't dispatch next
169 * requests and will requeue them. And this can improve
170 * throughput too. For example, we have request flush1, write1,
171 * flush 2. flush1 is dispatched, then queue is hold, write1
172 * isn't inserted to queue. After flush1 is finished, flush2
173 * will be dispatched. Since disk cache is already clean,
174 * flush2 will be finished very soon, so looks like flush2 is
175 * folded to flush1.
176 * Since the queue is hold, a flag is set to indicate the queue
177 * should be restarted later. Please see flush_end_io() for
178 * details.
179 */
7c94e1c1 180 if (fq->flush_pending_idx != fq->flush_running_idx &&
3ac0cc45 181 !queue_flush_queueable(q)) {
7c94e1c1 182 fq->flush_queue_delayed = 1;
3ac0cc45 183 return NULL;
184 }
556ee818 185 if (unlikely(blk_queue_bypass(q)) ||
c51ca6cf 186 !q->elevator->type->ops.sq.elevator_dispatch_fn(q, 0))
158dbda0
TH
187 return NULL;
188 }
189}
190
191static inline void elv_activate_rq(struct request_queue *q, struct request *rq)
192{
193 struct elevator_queue *e = q->elevator;
194
c51ca6cf
JA
195 if (e->type->ops.sq.elevator_activate_req_fn)
196 e->type->ops.sq.elevator_activate_req_fn(q, rq);
158dbda0
TH
197}
198
199static inline void elv_deactivate_rq(struct request_queue *q, struct request *rq)
200{
201 struct elevator_queue *e = q->elevator;
202
c51ca6cf
JA
203 if (e->type->ops.sq.elevator_deactivate_req_fn)
204 e->type->ops.sq.elevator_deactivate_req_fn(q, rq);
158dbda0
TH
205}
206
807d4af2
CH
207struct hd_struct *__disk_get_part(struct gendisk *disk, int partno);
208
581d4e28
JA
209#ifdef CONFIG_FAIL_IO_TIMEOUT
210int blk_should_fake_timeout(struct request_queue *);
211ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
212ssize_t part_timeout_store(struct device *, struct device_attribute *,
213 const char *, size_t);
214#else
215static inline int blk_should_fake_timeout(struct request_queue *q)
216{
217 return 0;
218}
219#endif
220
d6d48196
JA
221int ll_back_merge_fn(struct request_queue *q, struct request *req,
222 struct bio *bio);
223int ll_front_merge_fn(struct request_queue *q, struct request *req,
224 struct bio *bio);
b973cb7e
JA
225struct request *attempt_back_merge(struct request_queue *q, struct request *rq);
226struct request *attempt_front_merge(struct request_queue *q, struct request *rq);
5e84ea3a
JA
227int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
228 struct request *next);
d6d48196 229void blk_recalc_rq_segments(struct request *rq);
80a761fd 230void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 231bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 232enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 233
8324aa91
JA
234void blk_queue_congestion_threshold(struct request_queue *q);
235
ff88972c
AB
236int blk_dev_init(void);
237
f253b86b 238
8324aa91
JA
239/*
240 * Return the threshold (number of used requests) at which the queue is
241 * considered to be congested. It include a little hysteresis to keep the
242 * context switch rate down.
243 */
244static inline int queue_congestion_on_threshold(struct request_queue *q)
245{
246 return q->nr_congestion_on;
247}
248
249/*
250 * The threshold at which a queue is considered to be uncongested
251 */
252static inline int queue_congestion_off_threshold(struct request_queue *q)
253{
254 return q->nr_congestion_off;
255}
256
e3a2b3f9
JA
257extern int blk_update_nr_requests(struct request_queue *, unsigned int);
258
c2553b58
JA
259/*
260 * Contribute to IO statistics IFF:
261 *
262 * a) it's attached to a gendisk, and
263 * b) the queue had IO stats enabled when this request was started, and
e2a60da7 264 * c) it's a file system request
c2553b58 265 */
26308eab 266static inline int blk_do_io_stat(struct request *rq)
fb8ec18c 267{
33659ebb 268 return rq->rq_disk &&
e8064021 269 (rq->rq_flags & RQF_IO_STAT) &&
57292b58 270 !blk_rq_is_passthrough(rq);
fb8ec18c
JA
271}
272
6cf7677f
CH
273static inline void req_set_nomerge(struct request_queue *q, struct request *req)
274{
275 req->cmd_flags |= REQ_NOMERGE;
276 if (req == q->last_merge)
277 q->last_merge = NULL;
278}
279
f2dbd76a
TH
280/*
281 * Internal io_context interface
282 */
283void get_io_context(struct io_context *ioc);
47fdd4ca 284struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
285struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
286 gfp_t gfp_mask);
7e5a8794 287void ioc_clear_queue(struct request_queue *q);
f2dbd76a 288
24acfc34 289int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 290
c23ecb42
JA
291/**
292 * rq_ioc - determine io_context for request allocation
293 * @bio: request being allocated is for this bio (can be %NULL)
294 *
295 * Determine io_context to use for request allocation for @bio. May return
296 * %NULL if %current->io_context doesn't exist.
297 */
298static inline struct io_context *rq_ioc(struct bio *bio)
299{
300#ifdef CONFIG_BLK_CGROUP
301 if (bio && bio->bi_ioc)
302 return bio->bi_ioc;
303#endif
304 return current->io_context;
305}
306
f2dbd76a
TH
307/**
308 * create_io_context - try to create task->io_context
f2dbd76a
TH
309 * @gfp_mask: allocation mask
310 * @node: allocation node
311 *
24acfc34
TH
312 * If %current->io_context is %NULL, allocate a new io_context and install
313 * it. Returns the current %current->io_context which may be %NULL if
314 * allocation failed.
f2dbd76a
TH
315 *
316 * Note that this function can't be called with IRQ disabled because
24acfc34 317 * task_lock which protects %current->io_context is IRQ-unsafe.
f2dbd76a 318 */
24acfc34 319static inline struct io_context *create_io_context(gfp_t gfp_mask, int node)
f2dbd76a
TH
320{
321 WARN_ON_ONCE(irqs_disabled());
24acfc34
TH
322 if (unlikely(!current->io_context))
323 create_task_io_context(current, gfp_mask, node);
324 return current->io_context;
f2dbd76a
TH
325}
326
327/*
328 * Internal throttling interface
329 */
bc9fcbf9 330#ifdef CONFIG_BLK_DEV_THROTTLING
c9a929dd 331extern void blk_throtl_drain(struct request_queue *q);
bc9fcbf9
TH
332extern int blk_throtl_init(struct request_queue *q);
333extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 334extern void blk_throtl_register_queue(struct request_queue *q);
bc9fcbf9 335#else /* CONFIG_BLK_DEV_THROTTLING */
c9a929dd 336static inline void blk_throtl_drain(struct request_queue *q) { }
bc9fcbf9
TH
337static inline int blk_throtl_init(struct request_queue *q) { return 0; }
338static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 339static inline void blk_throtl_register_queue(struct request_queue *q) { }
bc9fcbf9 340#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
341#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
342extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
343extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
344 const char *page, size_t count);
9e234eea 345extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 346extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
347#else
348static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 349static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 350#endif
bc9fcbf9 351
3bce016a
CH
352#ifdef CONFIG_BOUNCE
353extern int init_emergency_isa_pool(void);
354extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
355#else
356static inline int init_emergency_isa_pool(void)
357{
358 return 0;
359}
360static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
361{
362}
363#endif /* CONFIG_BOUNCE */
364
7e3acce1
ML
365extern void blk_drain_queue(struct request_queue *q);
366
bc9fcbf9 367#endif /* BLK_INTERNAL_H */