sr: set GENHD_FL_REMOVABLE earlier
[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>
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);
c98cb5bb 58int __bio_queue_enter(struct request_queue *q, struct bio *bio);
900e0807 59bool submit_bio_checks(struct bio *bio);
c98cb5bb
JA
60
61static inline bool blk_try_enter_queue(struct request_queue *q, bool pm)
62{
63 rcu_read_lock();
64 if (!percpu_ref_tryget_live_rcu(&q->q_usage_counter))
65 goto fail;
66
67 /*
68 * The code that increments the pm_only counter must ensure that the
69 * counter is globally visible before the queue is unfrozen.
70 */
71 if (blk_queue_pm_only(q) &&
72 (!pm || queue_rpm_status(q) == RPM_SUSPENDED))
73 goto fail_put;
74
75 rcu_read_unlock();
76 return true;
77
78fail_put:
79 blk_queue_exit(q);
80fail:
81 rcu_read_unlock();
82 return false;
83}
84
85static inline int bio_queue_enter(struct bio *bio)
86{
87 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
88
89 if (blk_try_enter_queue(q, false))
90 return 0;
91 return __bio_queue_enter(q, bio);
92}
3ef28e83 93
dc0b8a57 94#define BIO_INLINE_VECS 4
7a800a20
CH
95struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs,
96 gfp_t gfp_mask);
97void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs);
eec716a1 98
3dccdae5
CH
99static inline bool biovec_phys_mergeable(struct request_queue *q,
100 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 101{
3dccdae5 102 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
103 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
104 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
105
106 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 107 return false;
0383ad43 108 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
6a9f5f24 109 return false;
3dccdae5
CH
110 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
111 return false;
6a9f5f24
CH
112 return true;
113}
114
27ca1d4e
CH
115static inline bool __bvec_gap_to_prev(struct request_queue *q,
116 struct bio_vec *bprv, unsigned int offset)
117{
df376b2e 118 return (offset & queue_virt_boundary(q)) ||
27ca1d4e
CH
119 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
120}
121
122/*
123 * Check if adding a bio_vec after bprv with offset would create a gap in
124 * the SG list. Most drivers don't care about this, but some do.
125 */
126static inline bool bvec_gap_to_prev(struct request_queue *q,
127 struct bio_vec *bprv, unsigned int offset)
128{
129 if (!queue_virt_boundary(q))
130 return false;
131 return __bvec_gap_to_prev(q, bprv, offset);
132}
133
badf7f64
CH
134static inline bool rq_mergeable(struct request *rq)
135{
136 if (blk_rq_is_passthrough(rq))
137 return false;
138
139 if (req_op(rq) == REQ_OP_FLUSH)
140 return false;
141
142 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
143 return false;
144
145 if (req_op(rq) == REQ_OP_ZONE_APPEND)
146 return false;
147
148 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
149 return false;
150 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
151 return false;
152
153 return true;
154}
155
156/*
157 * There are two different ways to handle DISCARD merges:
158 * 1) If max_discard_segments > 1, the driver treats every bio as a range and
159 * send the bios to controller together. The ranges don't need to be
160 * contiguous.
161 * 2) Otherwise, the request will be normal read/write requests. The ranges
162 * need to be contiguous.
163 */
164static inline bool blk_discard_mergable(struct request *req)
165{
166 if (req_op(req) == REQ_OP_DISCARD &&
167 queue_max_discard_segments(req->q) > 1)
168 return true;
169 return false;
170}
171
5a48fc14
DW
172#ifdef CONFIG_BLK_DEV_INTEGRITY
173void blk_flush_integrity(void);
7c20f116 174bool __bio_integrity_endio(struct bio *);
ece841ab 175void bio_integrity_free(struct bio *bio);
7c20f116
CH
176static inline bool bio_integrity_endio(struct bio *bio)
177{
178 if (bio_integrity(bio))
179 return __bio_integrity_endio(bio);
180 return true;
181}
43b729bf 182
92cf2fd1
CH
183bool blk_integrity_merge_rq(struct request_queue *, struct request *,
184 struct request *);
d59da419
CH
185bool blk_integrity_merge_bio(struct request_queue *, struct request *,
186 struct bio *);
92cf2fd1 187
43b729bf
CH
188static inline bool integrity_req_gap_back_merge(struct request *req,
189 struct bio *next)
190{
191 struct bio_integrity_payload *bip = bio_integrity(req->bio);
192 struct bio_integrity_payload *bip_next = bio_integrity(next);
193
194 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
195 bip_next->bip_vec[0].bv_offset);
196}
197
198static inline bool integrity_req_gap_front_merge(struct request *req,
199 struct bio *bio)
200{
201 struct bio_integrity_payload *bip = bio_integrity(bio);
202 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
203
204 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
205 bip_next->bip_vec[0].bv_offset);
206}
581e2600 207
614310c9 208int blk_integrity_add(struct gendisk *disk);
581e2600 209void blk_integrity_del(struct gendisk *);
43b729bf 210#else /* CONFIG_BLK_DEV_INTEGRITY */
92cf2fd1
CH
211static inline bool blk_integrity_merge_rq(struct request_queue *rq,
212 struct request *r1, struct request *r2)
213{
214 return true;
215}
d59da419
CH
216static inline bool blk_integrity_merge_bio(struct request_queue *rq,
217 struct request *r, struct bio *b)
218{
219 return true;
220}
43b729bf
CH
221static inline bool integrity_req_gap_back_merge(struct request *req,
222 struct bio *next)
223{
224 return false;
225}
226static inline bool integrity_req_gap_front_merge(struct request *req,
227 struct bio *bio)
228{
229 return false;
230}
231
5a48fc14
DW
232static inline void blk_flush_integrity(void)
233{
234}
7c20f116
CH
235static inline bool bio_integrity_endio(struct bio *bio)
236{
237 return true;
238}
ece841ab
JT
239static inline void bio_integrity_free(struct bio *bio)
240{
241}
614310c9 242static inline int blk_integrity_add(struct gendisk *disk)
581e2600 243{
614310c9 244 return 0;
581e2600
CH
245}
246static inline void blk_integrity_del(struct gendisk *disk)
247{
248}
43b729bf 249#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 250
0d2602ca 251unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 252void blk_add_timer(struct request *req);
0d7a29a2 253const char *blk_status_to_str(blk_status_t status);
320ae51f 254
320ae51f 255bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
87c037d1 256 unsigned int nr_segs, bool *same_queue_rq);
bdc6a287
BW
257bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
258 struct bio *bio, unsigned int nr_segs);
320ae51f 259
ba0ffdd8
JA
260/*
261 * Plug flush limits
262 */
263#define BLK_MAX_REQUEST_COUNT 32
264#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
265
158dbda0
TH
266/*
267 * Internal elevator interface
268 */
e8064021 269#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 270
2b504bd4 271void blk_insert_flush(struct request *rq);
dd831006 272
d48ece20
JW
273int elevator_switch_mq(struct request_queue *q,
274 struct elevator_type *new_e);
c3e22192 275void __elevator_exit(struct request_queue *, struct elevator_queue *);
cecf5d87 276int elv_register_queue(struct request_queue *q, bool uevent);
83d016ac
BVA
277void elv_unregister_queue(struct request_queue *q);
278
c3e22192
ML
279static inline void elevator_exit(struct request_queue *q,
280 struct elevator_queue *e)
281{
284b94be
ML
282 lockdep_assert_held(&q->sysfs_lock);
283
1820f4f0 284 blk_mq_sched_free_rqs(q);
c3e22192
ML
285 __elevator_exit(q, e);
286}
287
3ad5cee5
CH
288ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
289 char *buf);
290ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
291 char *buf);
292ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
293 char *buf);
294ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
295 char *buf);
296ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
297 const char *buf, size_t count);
581d4e28
JA
298ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
299ssize_t part_timeout_store(struct device *, struct device_attribute *,
300 const char *, size_t);
581d4e28 301
abd45c15
JA
302static inline bool blk_may_split(struct request_queue *q, struct bio *bio)
303{
304 switch (bio_op(bio)) {
305 case REQ_OP_DISCARD:
306 case REQ_OP_SECURE_ERASE:
307 case REQ_OP_WRITE_ZEROES:
308 case REQ_OP_WRITE_SAME:
309 return true; /* non-trivial splitting decisions */
310 default:
311 break;
312 }
313
314 /*
315 * All drivers must accept single-segments bios that are <= PAGE_SIZE.
316 * This is a quick and dirty check that relies on the fact that
317 * bi_io_vec[0] is always valid if a bio has data. The check might
318 * lead to occasional false negatives when bios are cloned, but compared
319 * to the performance impact of cloned bios themselves the loop below
320 * doesn't matter anyway.
321 */
322 return q->limits.chunk_sectors || bio->bi_vcnt != 1 ||
323 bio->bi_io_vec->bv_len + bio->bi_io_vec->bv_offset > PAGE_SIZE;
324}
325
326void __blk_queue_split(struct request_queue *q, struct bio **bio,
327 unsigned int *nr_segs);
14ccb66b
CH
328int ll_back_merge_fn(struct request *req, struct bio *bio,
329 unsigned int nr_segs);
fd2ef39c 330bool blk_attempt_req_merge(struct request_queue *q, struct request *rq,
5e84ea3a 331 struct request *next);
e9cd19c0 332unsigned int blk_recalc_rq_segments(struct request *rq);
80a761fd 333void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 334bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 335enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 336
ff88972c
AB
337int blk_dev_init(void);
338
c2553b58
JA
339/*
340 * Contribute to IO statistics IFF:
341 *
342 * a) it's attached to a gendisk, and
48d9b0d4 343 * b) the queue had IO stats enabled when this request was started
c2553b58 344 */
599d067d 345static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 346{
be6bfe36
PB
347 return (rq->rq_flags & RQF_IO_STAT) && rq->rq_disk;
348}
349
450b7879 350void update_io_ticks(struct block_device *part, unsigned long now, bool end);
fb8ec18c 351
6cf7677f
CH
352static inline void req_set_nomerge(struct request_queue *q, struct request *req)
353{
354 req->cmd_flags |= REQ_NOMERGE;
355 if (req == q->last_merge)
356 q->last_merge = NULL;
357}
358
1adfc5e4
ML
359/*
360 * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
361 * is defined as 'unsigned int', meantime it has to aligned to with logical
362 * block size which is the minimum accepted unit by hardware.
363 */
364static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
365{
366 return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
367}
368
9b15d109
CL
369/*
370 * The max bio size which is aligned to q->limits.discard_granularity. This
371 * is a hint to split large discard bio in generic block layer, then if device
372 * driver needs to split the discard bio into smaller ones, their bi_size can
373 * be very probably and easily aligned to discard_granularity of the device's
374 * queue.
375 */
376static inline unsigned int bio_aligned_discard_max_sectors(
377 struct request_queue *q)
378{
379 return round_down(UINT_MAX, q->limits.discard_granularity) >>
380 SECTOR_SHIFT;
381}
382
f2dbd76a
TH
383/*
384 * Internal io_context interface
385 */
386void get_io_context(struct io_context *ioc);
47fdd4ca 387struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
388struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
389 gfp_t gfp_mask);
7e5a8794 390void ioc_clear_queue(struct request_queue *q);
f2dbd76a 391
24acfc34 392int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 393
297e3d85
SL
394#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
395extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
396extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
397 const char *page, size_t count);
9e234eea 398extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 399extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
400#else
401static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 402static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 403#endif
bc9fcbf9 404
9bb33f24
CH
405void __blk_queue_bounce(struct request_queue *q, struct bio **bio);
406
407static inline bool blk_queue_may_bounce(struct request_queue *q)
408{
409 return IS_ENABLED(CONFIG_BOUNCE) &&
410 q->limits.bounce == BLK_BOUNCE_HIGH &&
411 max_low_pfn >= max_pfn;
412}
413
3bce016a
CH
414static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
415{
9bb33f24
CH
416 if (unlikely(blk_queue_may_bounce(q) && bio_has_data(*bio)))
417 __blk_queue_bounce(q, bio);
3bce016a 418}
3bce016a 419
d7067512
JB
420#ifdef CONFIG_BLK_CGROUP_IOLATENCY
421extern int blk_iolatency_init(struct request_queue *q);
422#else
423static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
424#endif
425
a2d6b3a2
DLM
426struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
427
bf505456
DLM
428#ifdef CONFIG_BLK_DEV_ZONED
429void blk_queue_free_zone_bitmaps(struct request_queue *q);
508aebb8 430void blk_queue_clear_zone_settings(struct request_queue *q);
bf505456
DLM
431#else
432static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
508aebb8 433static inline void blk_queue_clear_zone_settings(struct request_queue *q) {}
bf505456
DLM
434#endif
435
7c3f828b
CH
436int blk_alloc_ext_minor(void);
437void blk_free_ext_minor(unsigned int minor);
581e2600
CH
438#define ADDPART_FLAG_NONE 0
439#define ADDPART_FLAG_RAID 1
440#define ADDPART_FLAG_WHOLEDISK 2
7f6be376
CH
441int bdev_add_partition(struct gendisk *disk, int partno, sector_t start,
442 sector_t length);
926fbb16 443int bdev_del_partition(struct gendisk *disk, int partno);
3d2e7989
CH
444int bdev_resize_partition(struct gendisk *disk, int partno, sector_t start,
445 sector_t length);
581e2600 446
e4581105 447int bio_add_hw_page(struct request_queue *q, struct bio *bio,
130879f1 448 struct page *page, unsigned int len, unsigned int offset,
e4581105 449 unsigned int max_sectors, bool *same_page);
130879f1 450
da7ba729 451struct request_queue *blk_alloc_queue(int node_id);
e16e506c 452int disk_scan_partitions(struct gendisk *disk, fmode_t mode);
da7ba729 453
92e7755e 454int disk_alloc_events(struct gendisk *disk);
d5870edf
CH
455void disk_add_events(struct gendisk *disk);
456void disk_del_events(struct gendisk *disk);
457void disk_release_events(struct gendisk *disk);
2bc8cda5
CH
458extern struct device_attribute dev_attr_events;
459extern struct device_attribute dev_attr_events_async;
460extern struct device_attribute dev_attr_events_poll_msecs;
d5870edf 461
6ce913fe 462static inline void bio_clear_polled(struct bio *bio)
270a1c91
JA
463{
464 /* can't support alloc cache if we turn off polling */
465 bio_clear_flag(bio, BIO_PERCPU_CACHE);
6ce913fe 466 bio->bi_opf &= ~REQ_POLLED;
270a1c91
JA
467}
468
8a709512 469long blkdev_ioctl(struct file *file, unsigned cmd, unsigned long arg);
84b8514b
CH
470long compat_blkdev_ioctl(struct file *file, unsigned cmd, unsigned long arg);
471
cd82cca7
CH
472extern const struct address_space_operations def_blk_aops;
473
a2247f19
DLM
474int disk_register_independent_access_ranges(struct gendisk *disk,
475 struct blk_independent_access_ranges *new_iars);
476void disk_unregister_independent_access_ranges(struct gendisk *disk);
477
06c8c691
CH
478#ifdef CONFIG_FAIL_MAKE_REQUEST
479bool should_fail_request(struct block_device *part, unsigned int bytes);
480#else /* CONFIG_FAIL_MAKE_REQUEST */
481static inline bool should_fail_request(struct block_device *part,
482 unsigned int bytes)
483{
484 return false;
485}
486#endif /* CONFIG_FAIL_MAKE_REQUEST */
487
bc9fcbf9 488#endif /* BLK_INTERNAL_H */