block: unexport blkdev_ioctl
[linux-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>
c6a564ff 7#include <linux/part_stat.h>
a892c8d5 8#include <linux/blk-crypto.h>
9bb33f24 9#include <linux/memblock.h> /* for max_pfn/max_low_pfn */
c39ae60d 10#include <xen/xen.h>
a892c8d5 11#include "blk-crypto-internal.h"
f70ced09 12#include "blk-mq.h"
c3e22192 13#include "blk-mq-sched.h"
a73f730d 14
2e9bc346
CH
15struct elevator_type;
16
0d2602ca
JA
17/* Max future timer expiry for timeouts */
18#define BLK_MAX_TIMEOUT (5 * HZ)
19
18fbda91 20extern struct dentry *blk_debugfs_root;
18fbda91 21
7c94e1c1 22struct blk_flush_queue {
7c94e1c1
ML
23 unsigned int flush_pending_idx:1;
24 unsigned int flush_running_idx:1;
8d699663 25 blk_status_t rq_status;
7c94e1c1
ML
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 30
7c94e1c1
ML
31 spinlock_t mq_flush_lock;
32};
33
8324aa91
JA
34extern struct kmem_cache *blk_requestq_cachep;
35extern struct kobj_type blk_queue_ktype;
a73f730d 36extern struct ida blk_queue_ida;
8324aa91 37
f9afca4d
JA
38static inline struct blk_flush_queue *
39blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 40{
8ccdf4a3 41 return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
7c94e1c1
ML
42}
43
09ac46c4
TH
44static inline void __blk_get_queue(struct request_queue *q)
45{
46 kobject_get(&q->kobj);
47}
48
a9ed27a7 49bool is_flush_rq(struct request *req);
8d699663 50
754a1572
GJ
51struct blk_flush_queue *blk_alloc_flush_queue(int node, int cmd_size,
52 gfp_t flags);
f70ced09 53void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 54
3ef28e83 55void blk_freeze_queue(struct request_queue *q);
aec89dc5 56void __blk_mq_unfreeze_queue(struct request_queue *q, bool force_atomic);
8e141f9e 57void blk_queue_start_drain(struct request_queue *q);
3ef28e83 58
dc0b8a57 59#define BIO_INLINE_VECS 4
7a800a20
CH
60struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs,
61 gfp_t gfp_mask);
62void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs);
eec716a1 63
3dccdae5
CH
64static inline bool biovec_phys_mergeable(struct request_queue *q,
65 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 66{
3dccdae5 67 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
68 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
69 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
70
71 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 72 return false;
0383ad43 73 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
6a9f5f24 74 return false;
3dccdae5
CH
75 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
76 return false;
6a9f5f24
CH
77 return true;
78}
79
27ca1d4e
CH
80static inline bool __bvec_gap_to_prev(struct request_queue *q,
81 struct bio_vec *bprv, unsigned int offset)
82{
df376b2e 83 return (offset & queue_virt_boundary(q)) ||
27ca1d4e
CH
84 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
85}
86
87/*
88 * Check if adding a bio_vec after bprv with offset would create a gap in
89 * the SG list. Most drivers don't care about this, but some do.
90 */
91static inline bool bvec_gap_to_prev(struct request_queue *q,
92 struct bio_vec *bprv, unsigned int offset)
93{
94 if (!queue_virt_boundary(q))
95 return false;
96 return __bvec_gap_to_prev(q, bprv, offset);
97}
98
badf7f64
CH
99static inline bool rq_mergeable(struct request *rq)
100{
101 if (blk_rq_is_passthrough(rq))
102 return false;
103
104 if (req_op(rq) == REQ_OP_FLUSH)
105 return false;
106
107 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
108 return false;
109
110 if (req_op(rq) == REQ_OP_ZONE_APPEND)
111 return false;
112
113 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
114 return false;
115 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
116 return false;
117
118 return true;
119}
120
121/*
122 * There are two different ways to handle DISCARD merges:
123 * 1) If max_discard_segments > 1, the driver treats every bio as a range and
124 * send the bios to controller together. The ranges don't need to be
125 * contiguous.
126 * 2) Otherwise, the request will be normal read/write requests. The ranges
127 * need to be contiguous.
128 */
129static inline bool blk_discard_mergable(struct request *req)
130{
131 if (req_op(req) == REQ_OP_DISCARD &&
132 queue_max_discard_segments(req->q) > 1)
133 return true;
134 return false;
135}
136
5a48fc14
DW
137#ifdef CONFIG_BLK_DEV_INTEGRITY
138void blk_flush_integrity(void);
7c20f116 139bool __bio_integrity_endio(struct bio *);
ece841ab 140void bio_integrity_free(struct bio *bio);
7c20f116
CH
141static inline bool bio_integrity_endio(struct bio *bio)
142{
143 if (bio_integrity(bio))
144 return __bio_integrity_endio(bio);
145 return true;
146}
43b729bf 147
92cf2fd1
CH
148bool blk_integrity_merge_rq(struct request_queue *, struct request *,
149 struct request *);
d59da419
CH
150bool blk_integrity_merge_bio(struct request_queue *, struct request *,
151 struct bio *);
92cf2fd1 152
43b729bf
CH
153static inline bool integrity_req_gap_back_merge(struct request *req,
154 struct bio *next)
155{
156 struct bio_integrity_payload *bip = bio_integrity(req->bio);
157 struct bio_integrity_payload *bip_next = bio_integrity(next);
158
159 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
160 bip_next->bip_vec[0].bv_offset);
161}
162
163static inline bool integrity_req_gap_front_merge(struct request *req,
164 struct bio *bio)
165{
166 struct bio_integrity_payload *bip = bio_integrity(bio);
167 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
168
169 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
170 bip_next->bip_vec[0].bv_offset);
171}
581e2600 172
614310c9 173int blk_integrity_add(struct gendisk *disk);
581e2600 174void blk_integrity_del(struct gendisk *);
43b729bf 175#else /* CONFIG_BLK_DEV_INTEGRITY */
92cf2fd1
CH
176static inline bool blk_integrity_merge_rq(struct request_queue *rq,
177 struct request *r1, struct request *r2)
178{
179 return true;
180}
d59da419
CH
181static inline bool blk_integrity_merge_bio(struct request_queue *rq,
182 struct request *r, struct bio *b)
183{
184 return true;
185}
43b729bf
CH
186static inline bool integrity_req_gap_back_merge(struct request *req,
187 struct bio *next)
188{
189 return false;
190}
191static inline bool integrity_req_gap_front_merge(struct request *req,
192 struct bio *bio)
193{
194 return false;
195}
196
5a48fc14
DW
197static inline void blk_flush_integrity(void)
198{
199}
7c20f116
CH
200static inline bool bio_integrity_endio(struct bio *bio)
201{
202 return true;
203}
ece841ab
JT
204static inline void bio_integrity_free(struct bio *bio)
205{
206}
614310c9 207static inline int blk_integrity_add(struct gendisk *disk)
581e2600 208{
614310c9 209 return 0;
581e2600
CH
210}
211static inline void blk_integrity_del(struct gendisk *disk)
212{
213}
43b729bf 214#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 215
0d2602ca 216unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 217void blk_add_timer(struct request *req);
320ae51f 218
320ae51f 219bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
14ccb66b 220 unsigned int nr_segs, struct request **same_queue_rq);
bdc6a287
BW
221bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
222 struct bio *bio, unsigned int nr_segs);
320ae51f 223
b5af37ab 224void blk_account_io_start(struct request *req);
522a7775 225void blk_account_io_done(struct request *req, u64 now);
320ae51f 226
ba0ffdd8
JA
227/*
228 * Plug flush limits
229 */
230#define BLK_MAX_REQUEST_COUNT 32
231#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
232
158dbda0
TH
233/*
234 * Internal elevator interface
235 */
e8064021 236#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 237
ae1b1539 238void blk_insert_flush(struct request *rq);
dd831006 239
d48ece20
JW
240int elevator_switch_mq(struct request_queue *q,
241 struct elevator_type *new_e);
c3e22192 242void __elevator_exit(struct request_queue *, struct elevator_queue *);
cecf5d87 243int elv_register_queue(struct request_queue *q, bool uevent);
83d016ac
BVA
244void elv_unregister_queue(struct request_queue *q);
245
c3e22192
ML
246static inline void elevator_exit(struct request_queue *q,
247 struct elevator_queue *e)
248{
284b94be
ML
249 lockdep_assert_held(&q->sysfs_lock);
250
1820f4f0 251 blk_mq_sched_free_rqs(q);
c3e22192
ML
252 __elevator_exit(q, e);
253}
254
3ad5cee5
CH
255ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
256 char *buf);
257ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
258 char *buf);
259ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
260 char *buf);
261ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
262 char *buf);
263ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
264 const char *buf, size_t count);
581d4e28
JA
265ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
266ssize_t part_timeout_store(struct device *, struct device_attribute *,
267 const char *, size_t);
581d4e28 268
f695ca38 269void __blk_queue_split(struct bio **bio, unsigned int *nr_segs);
14ccb66b
CH
270int ll_back_merge_fn(struct request *req, struct bio *bio,
271 unsigned int nr_segs);
fd2ef39c 272bool blk_attempt_req_merge(struct request_queue *q, struct request *rq,
5e84ea3a 273 struct request *next);
e9cd19c0 274unsigned int blk_recalc_rq_segments(struct request *rq);
80a761fd 275void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 276bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 277enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 278
ff88972c
AB
279int blk_dev_init(void);
280
c2553b58
JA
281/*
282 * Contribute to IO statistics IFF:
283 *
284 * a) it's attached to a gendisk, and
48d9b0d4 285 * b) the queue had IO stats enabled when this request was started
c2553b58 286 */
599d067d 287static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 288{
48d9b0d4 289 return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
fb8ec18c
JA
290}
291
6cf7677f
CH
292static inline void req_set_nomerge(struct request_queue *q, struct request *req)
293{
294 req->cmd_flags |= REQ_NOMERGE;
295 if (req == q->last_merge)
296 q->last_merge = NULL;
297}
298
1adfc5e4
ML
299/*
300 * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
301 * is defined as 'unsigned int', meantime it has to aligned to with logical
302 * block size which is the minimum accepted unit by hardware.
303 */
304static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
305{
306 return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
307}
308
9b15d109
CL
309/*
310 * The max bio size which is aligned to q->limits.discard_granularity. This
311 * is a hint to split large discard bio in generic block layer, then if device
312 * driver needs to split the discard bio into smaller ones, their bi_size can
313 * be very probably and easily aligned to discard_granularity of the device's
314 * queue.
315 */
316static inline unsigned int bio_aligned_discard_max_sectors(
317 struct request_queue *q)
318{
319 return round_down(UINT_MAX, q->limits.discard_granularity) >>
320 SECTOR_SHIFT;
321}
322
f2dbd76a
TH
323/*
324 * Internal io_context interface
325 */
326void get_io_context(struct io_context *ioc);
47fdd4ca 327struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
328struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
329 gfp_t gfp_mask);
7e5a8794 330void ioc_clear_queue(struct request_queue *q);
f2dbd76a 331
24acfc34 332int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 333
297e3d85
SL
334#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
335extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
336extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
337 const char *page, size_t count);
9e234eea 338extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 339extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
340#else
341static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 342static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 343#endif
bc9fcbf9 344
9bb33f24
CH
345void __blk_queue_bounce(struct request_queue *q, struct bio **bio);
346
347static inline bool blk_queue_may_bounce(struct request_queue *q)
348{
349 return IS_ENABLED(CONFIG_BOUNCE) &&
350 q->limits.bounce == BLK_BOUNCE_HIGH &&
351 max_low_pfn >= max_pfn;
352}
353
3bce016a
CH
354static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
355{
9bb33f24
CH
356 if (unlikely(blk_queue_may_bounce(q) && bio_has_data(*bio)))
357 __blk_queue_bounce(q, bio);
3bce016a 358}
3bce016a 359
d7067512
JB
360#ifdef CONFIG_BLK_CGROUP_IOLATENCY
361extern int blk_iolatency_init(struct request_queue *q);
362#else
363static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
364#endif
365
a2d6b3a2
DLM
366struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
367
bf505456
DLM
368#ifdef CONFIG_BLK_DEV_ZONED
369void blk_queue_free_zone_bitmaps(struct request_queue *q);
508aebb8 370void blk_queue_clear_zone_settings(struct request_queue *q);
bf505456
DLM
371#else
372static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
508aebb8 373static inline void blk_queue_clear_zone_settings(struct request_queue *q) {}
bf505456
DLM
374#endif
375
7c3f828b
CH
376int blk_alloc_ext_minor(void);
377void blk_free_ext_minor(unsigned int minor);
581e2600
CH
378#define ADDPART_FLAG_NONE 0
379#define ADDPART_FLAG_RAID 1
380#define ADDPART_FLAG_WHOLEDISK 2
7f6be376
CH
381int bdev_add_partition(struct gendisk *disk, int partno, sector_t start,
382 sector_t length);
926fbb16 383int bdev_del_partition(struct gendisk *disk, int partno);
3d2e7989
CH
384int bdev_resize_partition(struct gendisk *disk, int partno, sector_t start,
385 sector_t length);
581e2600 386
e4581105 387int bio_add_hw_page(struct request_queue *q, struct bio *bio,
130879f1 388 struct page *page, unsigned int len, unsigned int offset,
e4581105 389 unsigned int max_sectors, bool *same_page);
130879f1 390
da7ba729
CH
391struct request_queue *blk_alloc_queue(int node_id);
392
92e7755e 393int disk_alloc_events(struct gendisk *disk);
d5870edf
CH
394void disk_add_events(struct gendisk *disk);
395void disk_del_events(struct gendisk *disk);
396void disk_release_events(struct gendisk *disk);
2bc8cda5
CH
397extern struct device_attribute dev_attr_events;
398extern struct device_attribute dev_attr_events_async;
399extern struct device_attribute dev_attr_events_poll_msecs;
d5870edf 400
270a1c91
JA
401static inline void bio_clear_hipri(struct bio *bio)
402{
403 /* can't support alloc cache if we turn off polling */
404 bio_clear_flag(bio, BIO_PERCPU_CACHE);
405 bio->bi_opf &= ~REQ_HIPRI;
406}
407
cd82cca7
CH
408extern const struct address_space_operations def_blk_aops;
409
bc9fcbf9 410#endif /* BLK_INTERNAL_H */