]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - block/blk.h
usb: dwc3: gadget: Bail from dwc3_gadget_exit() if dwc->gadget is NULL
[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>
c6a564ff 7#include <linux/part_stat.h>
a892c8d5 8#include <linux/blk-crypto.h>
c39ae60d 9#include <xen/xen.h>
a892c8d5 10#include "blk-crypto-internal.h"
f70ced09 11#include "blk-mq.h"
c3e22192 12#include "blk-mq-sched.h"
a73f730d 13
0d2602ca
JA
14/* Max future timer expiry for timeouts */
15#define BLK_MAX_TIMEOUT (5 * HZ)
16
18fbda91 17extern struct dentry *blk_debugfs_root;
18fbda91 18
7c94e1c1 19struct blk_flush_queue {
7c94e1c1
ML
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 27
7c94e1c1
ML
28 spinlock_t mq_flush_lock;
29};
30
8324aa91
JA
31extern struct kmem_cache *blk_requestq_cachep;
32extern struct kobj_type blk_queue_ktype;
a73f730d 33extern struct ida blk_queue_ida;
8324aa91 34
f9afca4d
JA
35static inline struct blk_flush_queue *
36blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 37{
8ccdf4a3 38 return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
7c94e1c1
ML
39}
40
09ac46c4
TH
41static inline void __blk_get_queue(struct request_queue *q)
42{
43 kobject_get(&q->kobj);
44}
45
8d699663
YY
46static inline bool
47is_flush_rq(struct request *req, struct blk_mq_hw_ctx *hctx)
48{
49 return hctx->fq->flush_rq == req;
50}
51
754a1572
GJ
52struct blk_flush_queue *blk_alloc_flush_queue(int node, int cmd_size,
53 gfp_t flags);
f70ced09 54void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 55
3ef28e83
DW
56void blk_freeze_queue(struct request_queue *q);
57
3dccdae5
CH
58static inline bool biovec_phys_mergeable(struct request_queue *q,
59 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 60{
3dccdae5 61 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
62 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
63 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
64
65 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 66 return false;
0383ad43 67 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
6a9f5f24 68 return false;
3dccdae5
CH
69 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
70 return false;
6a9f5f24
CH
71 return true;
72}
73
27ca1d4e
CH
74static inline bool __bvec_gap_to_prev(struct request_queue *q,
75 struct bio_vec *bprv, unsigned int offset)
76{
df376b2e 77 return (offset & queue_virt_boundary(q)) ||
27ca1d4e
CH
78 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
79}
80
81/*
82 * Check if adding a bio_vec after bprv with offset would create a gap in
83 * the SG list. Most drivers don't care about this, but some do.
84 */
85static inline bool bvec_gap_to_prev(struct request_queue *q,
86 struct bio_vec *bprv, unsigned int offset)
87{
88 if (!queue_virt_boundary(q))
89 return false;
90 return __bvec_gap_to_prev(q, bprv, offset);
91}
92
5a48fc14
DW
93#ifdef CONFIG_BLK_DEV_INTEGRITY
94void blk_flush_integrity(void);
7c20f116 95bool __bio_integrity_endio(struct bio *);
ece841ab 96void bio_integrity_free(struct bio *bio);
7c20f116
CH
97static inline bool bio_integrity_endio(struct bio *bio)
98{
99 if (bio_integrity(bio))
100 return __bio_integrity_endio(bio);
101 return true;
102}
43b729bf 103
92cf2fd1
CH
104bool blk_integrity_merge_rq(struct request_queue *, struct request *,
105 struct request *);
d59da419
CH
106bool blk_integrity_merge_bio(struct request_queue *, struct request *,
107 struct bio *);
92cf2fd1 108
43b729bf
CH
109static inline bool integrity_req_gap_back_merge(struct request *req,
110 struct bio *next)
111{
112 struct bio_integrity_payload *bip = bio_integrity(req->bio);
113 struct bio_integrity_payload *bip_next = bio_integrity(next);
114
115 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
116 bip_next->bip_vec[0].bv_offset);
117}
118
119static inline bool integrity_req_gap_front_merge(struct request *req,
120 struct bio *bio)
121{
122 struct bio_integrity_payload *bip = bio_integrity(bio);
123 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
124
125 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
126 bip_next->bip_vec[0].bv_offset);
127}
581e2600
CH
128
129void blk_integrity_add(struct gendisk *);
130void blk_integrity_del(struct gendisk *);
43b729bf 131#else /* CONFIG_BLK_DEV_INTEGRITY */
92cf2fd1
CH
132static inline bool blk_integrity_merge_rq(struct request_queue *rq,
133 struct request *r1, struct request *r2)
134{
135 return true;
136}
d59da419
CH
137static inline bool blk_integrity_merge_bio(struct request_queue *rq,
138 struct request *r, struct bio *b)
139{
140 return true;
141}
43b729bf
CH
142static inline bool integrity_req_gap_back_merge(struct request *req,
143 struct bio *next)
144{
145 return false;
146}
147static inline bool integrity_req_gap_front_merge(struct request *req,
148 struct bio *bio)
149{
150 return false;
151}
152
5a48fc14
DW
153static inline void blk_flush_integrity(void)
154{
155}
7c20f116
CH
156static inline bool bio_integrity_endio(struct bio *bio)
157{
158 return true;
159}
ece841ab
JT
160static inline void bio_integrity_free(struct bio *bio)
161{
162}
581e2600
CH
163static inline void blk_integrity_add(struct gendisk *disk)
164{
165}
166static inline void blk_integrity_del(struct gendisk *disk)
167{
168}
43b729bf 169#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 170
0d2602ca 171unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 172void blk_add_timer(struct request *req);
320ae51f 173
320ae51f 174bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
14ccb66b 175 unsigned int nr_segs, struct request **same_queue_rq);
bdc6a287
BW
176bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
177 struct bio *bio, unsigned int nr_segs);
320ae51f 178
b5af37ab 179void blk_account_io_start(struct request *req);
522a7775 180void blk_account_io_done(struct request *req, u64 now);
320ae51f 181
158dbda0
TH
182/*
183 * Internal elevator interface
184 */
e8064021 185#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 186
ae1b1539 187void blk_insert_flush(struct request *rq);
dd831006 188
954b4a5c 189void elevator_init_mq(struct request_queue *q);
d48ece20
JW
190int elevator_switch_mq(struct request_queue *q,
191 struct elevator_type *new_e);
c3e22192 192void __elevator_exit(struct request_queue *, struct elevator_queue *);
cecf5d87 193int elv_register_queue(struct request_queue *q, bool uevent);
83d016ac
BVA
194void elv_unregister_queue(struct request_queue *q);
195
c3e22192
ML
196static inline void elevator_exit(struct request_queue *q,
197 struct elevator_queue *e)
198{
284b94be
ML
199 lockdep_assert_held(&q->sysfs_lock);
200
c3e22192
ML
201 blk_mq_sched_free_requests(q);
202 __elevator_exit(q, e);
203}
204
8446fe92 205struct block_device *__disk_get_part(struct gendisk *disk, int partno);
807d4af2 206
3ad5cee5
CH
207ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
208 char *buf);
209ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
210 char *buf);
211ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
212 char *buf);
213ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
214 char *buf);
215ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
216 const char *buf, size_t count);
581d4e28
JA
217ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
218ssize_t part_timeout_store(struct device *, struct device_attribute *,
219 const char *, size_t);
581d4e28 220
f695ca38 221void __blk_queue_split(struct bio **bio, unsigned int *nr_segs);
14ccb66b
CH
222int ll_back_merge_fn(struct request *req, struct bio *bio,
223 unsigned int nr_segs);
5e84ea3a
JA
224int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
225 struct request *next);
e9cd19c0 226unsigned int blk_recalc_rq_segments(struct request *rq);
80a761fd 227void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 228bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 229enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 230
ff88972c
AB
231int blk_dev_init(void);
232
c2553b58
JA
233/*
234 * Contribute to IO statistics IFF:
235 *
236 * a) it's attached to a gendisk, and
48d9b0d4 237 * b) the queue had IO stats enabled when this request was started
c2553b58 238 */
599d067d 239static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 240{
48d9b0d4 241 return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
fb8ec18c
JA
242}
243
6cf7677f
CH
244static inline void req_set_nomerge(struct request_queue *q, struct request *req)
245{
246 req->cmd_flags |= REQ_NOMERGE;
247 if (req == q->last_merge)
248 q->last_merge = NULL;
249}
250
1adfc5e4
ML
251/*
252 * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
253 * is defined as 'unsigned int', meantime it has to aligned to with logical
254 * block size which is the minimum accepted unit by hardware.
255 */
256static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
257{
258 return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
259}
260
9b15d109
CL
261/*
262 * The max bio size which is aligned to q->limits.discard_granularity. This
263 * is a hint to split large discard bio in generic block layer, then if device
264 * driver needs to split the discard bio into smaller ones, their bi_size can
265 * be very probably and easily aligned to discard_granularity of the device's
266 * queue.
267 */
268static inline unsigned int bio_aligned_discard_max_sectors(
269 struct request_queue *q)
270{
271 return round_down(UINT_MAX, q->limits.discard_granularity) >>
272 SECTOR_SHIFT;
273}
274
f2dbd76a
TH
275/*
276 * Internal io_context interface
277 */
278void get_io_context(struct io_context *ioc);
47fdd4ca 279struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
280struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
281 gfp_t gfp_mask);
7e5a8794 282void ioc_clear_queue(struct request_queue *q);
f2dbd76a 283
24acfc34 284int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 285
f2dbd76a
TH
286/*
287 * Internal throttling interface
288 */
bc9fcbf9 289#ifdef CONFIG_BLK_DEV_THROTTLING
bc9fcbf9
TH
290extern int blk_throtl_init(struct request_queue *q);
291extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 292extern void blk_throtl_register_queue(struct request_queue *q);
db18a53e 293bool blk_throtl_bio(struct bio *bio);
bc9fcbf9 294#else /* CONFIG_BLK_DEV_THROTTLING */
bc9fcbf9
TH
295static inline int blk_throtl_init(struct request_queue *q) { return 0; }
296static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 297static inline void blk_throtl_register_queue(struct request_queue *q) { }
db18a53e 298static inline bool blk_throtl_bio(struct bio *bio) { return false; }
bc9fcbf9 299#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
300#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
301extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
302extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
303 const char *page, size_t count);
9e234eea 304extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 305extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
306#else
307static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 308static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 309#endif
bc9fcbf9 310
3bce016a
CH
311#ifdef CONFIG_BOUNCE
312extern int init_emergency_isa_pool(void);
313extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
314#else
315static inline int init_emergency_isa_pool(void)
316{
317 return 0;
318}
319static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
320{
321}
322#endif /* CONFIG_BOUNCE */
323
d7067512
JB
324#ifdef CONFIG_BLK_CGROUP_IOLATENCY
325extern int blk_iolatency_init(struct request_queue *q);
326#else
327static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
328#endif
329
a2d6b3a2
DLM
330struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
331
bf505456
DLM
332#ifdef CONFIG_BLK_DEV_ZONED
333void blk_queue_free_zone_bitmaps(struct request_queue *q);
334#else
335static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
336#endif
337
8446fe92 338struct block_device *disk_map_sector_rcu(struct gendisk *disk, sector_t sector);
581e2600 339
9fc995a6 340int blk_alloc_devt(struct block_device *part, dev_t *devt);
581e2600 341void blk_free_devt(dev_t devt);
581e2600
CH
342char *disk_name(struct gendisk *hd, int partno, char *buf);
343#define ADDPART_FLAG_NONE 0
344#define ADDPART_FLAG_RAID 1
345#define ADDPART_FLAG_WHOLEDISK 2
0d02129e 346void delete_partition(struct block_device *part);
fa9156ae
CH
347int bdev_add_partition(struct block_device *bdev, int partno,
348 sector_t start, sector_t length);
349int bdev_del_partition(struct block_device *bdev, int partno);
350int bdev_resize_partition(struct block_device *bdev, int partno,
351 sector_t start, sector_t length);
581e2600 352int disk_expand_part_tbl(struct gendisk *disk, int target);
581e2600 353
e4581105 354int bio_add_hw_page(struct request_queue *q, struct bio *bio,
130879f1 355 struct page *page, unsigned int len, unsigned int offset,
e4581105 356 unsigned int max_sectors, bool *same_page);
130879f1 357
bc9fcbf9 358#endif /* BLK_INTERNAL_H */