block: re-organize fields of 'struct hd_part'
[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>
c39ae60d 8#include <xen/xen.h>
f70ced09 9#include "blk-mq.h"
c3e22192 10#include "blk-mq-sched.h"
a73f730d 11
0d2602ca
JA
12/* Max future timer expiry for timeouts */
13#define BLK_MAX_TIMEOUT (5 * HZ)
14
18fbda91
OS
15#ifdef CONFIG_DEBUG_FS
16extern struct dentry *blk_debugfs_root;
17#endif
18
7c94e1c1
ML
19struct blk_flush_queue {
20 unsigned int flush_queue_delayed:1;
21 unsigned int flush_pending_idx:1;
22 unsigned int flush_running_idx:1;
8d699663 23 blk_status_t rq_status;
7c94e1c1
ML
24 unsigned long flush_pending_since;
25 struct list_head flush_queue[2];
26 struct list_head flush_data_in_flight;
27 struct request *flush_rq;
0048b483
ML
28
29 /*
30 * flush_rq shares tag with this rq, both can't be active
31 * at the same time
32 */
33 struct request *orig_rq;
b3c6a599 34 struct lock_class_key key;
7c94e1c1
ML
35 spinlock_t mq_flush_lock;
36};
37
8324aa91
JA
38extern struct kmem_cache *blk_requestq_cachep;
39extern struct kobj_type blk_queue_ktype;
a73f730d 40extern struct ida blk_queue_ida;
8324aa91 41
f9afca4d
JA
42static inline struct blk_flush_queue *
43blk_get_flush_queue(struct request_queue *q, struct blk_mq_ctx *ctx)
7c94e1c1 44{
8ccdf4a3 45 return blk_mq_map_queue(q, REQ_OP_FLUSH, ctx)->fq;
7c94e1c1
ML
46}
47
09ac46c4
TH
48static inline void __blk_get_queue(struct request_queue *q)
49{
50 kobject_get(&q->kobj);
51}
52
8d699663
YY
53static inline bool
54is_flush_rq(struct request *req, struct blk_mq_hw_ctx *hctx)
55{
56 return hctx->fq->flush_rq == req;
57}
58
754a1572
GJ
59struct blk_flush_queue *blk_alloc_flush_queue(int node, int cmd_size,
60 gfp_t flags);
f70ced09 61void blk_free_flush_queue(struct blk_flush_queue *q);
f3552655 62
3ef28e83
DW
63void blk_freeze_queue(struct request_queue *q);
64
65static inline void blk_queue_enter_live(struct request_queue *q)
66{
67 /*
68 * Given that running in generic_make_request() context
69 * guarantees that a live reference against q_usage_counter has
70 * been established, further references under that same context
71 * need not check that the queue has been frozen (marked dead).
72 */
73 percpu_ref_get(&q->q_usage_counter);
74}
8324aa91 75
3dccdae5
CH
76static inline bool biovec_phys_mergeable(struct request_queue *q,
77 struct bio_vec *vec1, struct bio_vec *vec2)
6a9f5f24 78{
3dccdae5 79 unsigned long mask = queue_segment_boundary(q);
6e768461
CH
80 phys_addr_t addr1 = page_to_phys(vec1->bv_page) + vec1->bv_offset;
81 phys_addr_t addr2 = page_to_phys(vec2->bv_page) + vec2->bv_offset;
3dccdae5
CH
82
83 if (addr1 + vec1->bv_len != addr2)
6a9f5f24 84 return false;
0383ad43 85 if (xen_domain() && !xen_biovec_phys_mergeable(vec1, vec2->bv_page))
6a9f5f24 86 return false;
3dccdae5
CH
87 if ((addr1 | mask) != ((addr2 + vec2->bv_len - 1) | mask))
88 return false;
6a9f5f24
CH
89 return true;
90}
91
27ca1d4e
CH
92static inline bool __bvec_gap_to_prev(struct request_queue *q,
93 struct bio_vec *bprv, unsigned int offset)
94{
df376b2e 95 return (offset & queue_virt_boundary(q)) ||
27ca1d4e
CH
96 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
97}
98
99/*
100 * Check if adding a bio_vec after bprv with offset would create a gap in
101 * the SG list. Most drivers don't care about this, but some do.
102 */
103static inline bool bvec_gap_to_prev(struct request_queue *q,
104 struct bio_vec *bprv, unsigned int offset)
105{
106 if (!queue_virt_boundary(q))
107 return false;
108 return __bvec_gap_to_prev(q, bprv, offset);
109}
110
1aa0a133
CH
111static inline void blk_rq_bio_prep(struct request *rq, struct bio *bio,
112 unsigned int nr_segs)
113{
114 rq->nr_phys_segments = nr_segs;
115 rq->__data_len = bio->bi_iter.bi_size;
116 rq->bio = rq->biotail = bio;
117 rq->ioprio = bio_prio(bio);
118
119 if (bio->bi_disk)
120 rq->rq_disk = bio->bi_disk;
121}
122
5a48fc14
DW
123#ifdef CONFIG_BLK_DEV_INTEGRITY
124void blk_flush_integrity(void);
7c20f116 125bool __bio_integrity_endio(struct bio *);
ece841ab 126void bio_integrity_free(struct bio *bio);
7c20f116
CH
127static inline bool bio_integrity_endio(struct bio *bio)
128{
129 if (bio_integrity(bio))
130 return __bio_integrity_endio(bio);
131 return true;
132}
43b729bf
CH
133
134static inline bool integrity_req_gap_back_merge(struct request *req,
135 struct bio *next)
136{
137 struct bio_integrity_payload *bip = bio_integrity(req->bio);
138 struct bio_integrity_payload *bip_next = bio_integrity(next);
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
144static inline bool integrity_req_gap_front_merge(struct request *req,
145 struct bio *bio)
146{
147 struct bio_integrity_payload *bip = bio_integrity(bio);
148 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
149
150 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
151 bip_next->bip_vec[0].bv_offset);
152}
581e2600
CH
153
154void blk_integrity_add(struct gendisk *);
155void blk_integrity_del(struct gendisk *);
43b729bf
CH
156#else /* CONFIG_BLK_DEV_INTEGRITY */
157static inline bool integrity_req_gap_back_merge(struct request *req,
158 struct bio *next)
159{
160 return false;
161}
162static inline bool integrity_req_gap_front_merge(struct request *req,
163 struct bio *bio)
164{
165 return false;
166}
167
5a48fc14
DW
168static inline void blk_flush_integrity(void)
169{
170}
7c20f116
CH
171static inline bool bio_integrity_endio(struct bio *bio)
172{
173 return true;
174}
ece841ab
JT
175static inline void bio_integrity_free(struct bio *bio)
176{
177}
581e2600
CH
178static inline void blk_integrity_add(struct gendisk *disk)
179{
180}
181static inline void blk_integrity_del(struct gendisk *disk)
182{
183}
43b729bf 184#endif /* CONFIG_BLK_DEV_INTEGRITY */
8324aa91 185
0d2602ca 186unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11 187void blk_add_timer(struct request *req);
320ae51f 188
14ccb66b
CH
189bool bio_attempt_front_merge(struct request *req, struct bio *bio,
190 unsigned int nr_segs);
191bool bio_attempt_back_merge(struct request *req, struct bio *bio,
192 unsigned int nr_segs);
1e739730
CH
193bool bio_attempt_discard_merge(struct request_queue *q, struct request *req,
194 struct bio *bio);
320ae51f 195bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
14ccb66b 196 unsigned int nr_segs, struct request **same_queue_rq);
320ae51f
JA
197
198void blk_account_io_start(struct request *req, bool new_io);
199void blk_account_io_completion(struct request *req, unsigned int bytes);
522a7775 200void blk_account_io_done(struct request *req, u64 now);
320ae51f 201
158dbda0
TH
202/*
203 * Internal elevator interface
204 */
e8064021 205#define ELV_ON_HASH(rq) ((rq)->rq_flags & RQF_HASHED)
158dbda0 206
ae1b1539 207void blk_insert_flush(struct request *rq);
dd831006 208
954b4a5c 209void elevator_init_mq(struct request_queue *q);
d48ece20
JW
210int elevator_switch_mq(struct request_queue *q,
211 struct elevator_type *new_e);
c3e22192 212void __elevator_exit(struct request_queue *, struct elevator_queue *);
cecf5d87 213int elv_register_queue(struct request_queue *q, bool uevent);
83d016ac
BVA
214void elv_unregister_queue(struct request_queue *q);
215
c3e22192
ML
216static inline void elevator_exit(struct request_queue *q,
217 struct elevator_queue *e)
218{
284b94be
ML
219 lockdep_assert_held(&q->sysfs_lock);
220
c3e22192
ML
221 blk_mq_sched_free_requests(q);
222 __elevator_exit(q, e);
223}
224
807d4af2
CH
225struct hd_struct *__disk_get_part(struct gendisk *disk, int partno);
226
3ad5cee5
CH
227ssize_t part_size_show(struct device *dev, struct device_attribute *attr,
228 char *buf);
229ssize_t part_stat_show(struct device *dev, struct device_attribute *attr,
230 char *buf);
231ssize_t part_inflight_show(struct device *dev, struct device_attribute *attr,
232 char *buf);
233ssize_t part_fail_show(struct device *dev, struct device_attribute *attr,
234 char *buf);
235ssize_t part_fail_store(struct device *dev, struct device_attribute *attr,
236 const char *buf, size_t count);
237
581d4e28
JA
238#ifdef CONFIG_FAIL_IO_TIMEOUT
239int blk_should_fake_timeout(struct request_queue *);
240ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
241ssize_t part_timeout_store(struct device *, struct device_attribute *,
242 const char *, size_t);
243#else
244static inline int blk_should_fake_timeout(struct request_queue *q)
245{
246 return 0;
247}
248#endif
249
14ccb66b
CH
250void __blk_queue_split(struct request_queue *q, struct bio **bio,
251 unsigned int *nr_segs);
252int ll_back_merge_fn(struct request *req, struct bio *bio,
253 unsigned int nr_segs);
254int ll_front_merge_fn(struct request *req, struct bio *bio,
255 unsigned int nr_segs);
b973cb7e
JA
256struct request *attempt_back_merge(struct request_queue *q, struct request *rq);
257struct request *attempt_front_merge(struct request_queue *q, struct request *rq);
5e84ea3a
JA
258int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
259 struct request *next);
e9cd19c0 260unsigned int blk_recalc_rq_segments(struct request *rq);
80a761fd 261void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 262bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
34fe7c05 263enum elv_merge blk_try_merge(struct request *rq, struct bio *bio);
d6d48196 264
ff88972c
AB
265int blk_dev_init(void);
266
c2553b58
JA
267/*
268 * Contribute to IO statistics IFF:
269 *
270 * a) it's attached to a gendisk, and
48d9b0d4 271 * b) the queue had IO stats enabled when this request was started
c2553b58 272 */
599d067d 273static inline bool blk_do_io_stat(struct request *rq)
fb8ec18c 274{
48d9b0d4 275 return rq->rq_disk && (rq->rq_flags & RQF_IO_STAT);
fb8ec18c
JA
276}
277
6cf7677f
CH
278static inline void req_set_nomerge(struct request_queue *q, struct request *req)
279{
280 req->cmd_flags |= REQ_NOMERGE;
281 if (req == q->last_merge)
282 q->last_merge = NULL;
283}
284
1adfc5e4
ML
285/*
286 * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
287 * is defined as 'unsigned int', meantime it has to aligned to with logical
288 * block size which is the minimum accepted unit by hardware.
289 */
290static inline unsigned int bio_allowed_max_sectors(struct request_queue *q)
291{
292 return round_down(UINT_MAX, queue_logical_block_size(q)) >> 9;
293}
294
f2dbd76a
TH
295/*
296 * Internal io_context interface
297 */
298void get_io_context(struct io_context *ioc);
47fdd4ca 299struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
24acfc34
TH
300struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
301 gfp_t gfp_mask);
7e5a8794 302void ioc_clear_queue(struct request_queue *q);
f2dbd76a 303
24acfc34 304int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a 305
f2dbd76a
TH
306/*
307 * Internal throttling interface
308 */
bc9fcbf9 309#ifdef CONFIG_BLK_DEV_THROTTLING
c9a929dd 310extern void blk_throtl_drain(struct request_queue *q);
bc9fcbf9
TH
311extern int blk_throtl_init(struct request_queue *q);
312extern void blk_throtl_exit(struct request_queue *q);
d61fcfa4 313extern void blk_throtl_register_queue(struct request_queue *q);
bc9fcbf9 314#else /* CONFIG_BLK_DEV_THROTTLING */
c9a929dd 315static inline void blk_throtl_drain(struct request_queue *q) { }
bc9fcbf9
TH
316static inline int blk_throtl_init(struct request_queue *q) { return 0; }
317static inline void blk_throtl_exit(struct request_queue *q) { }
d61fcfa4 318static inline void blk_throtl_register_queue(struct request_queue *q) { }
bc9fcbf9 319#endif /* CONFIG_BLK_DEV_THROTTLING */
297e3d85
SL
320#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
321extern ssize_t blk_throtl_sample_time_show(struct request_queue *q, char *page);
322extern ssize_t blk_throtl_sample_time_store(struct request_queue *q,
323 const char *page, size_t count);
9e234eea 324extern void blk_throtl_bio_endio(struct bio *bio);
b9147dd1 325extern void blk_throtl_stat_add(struct request *rq, u64 time);
9e234eea
SL
326#else
327static inline void blk_throtl_bio_endio(struct bio *bio) { }
b9147dd1 328static inline void blk_throtl_stat_add(struct request *rq, u64 time) { }
297e3d85 329#endif
bc9fcbf9 330
3bce016a
CH
331#ifdef CONFIG_BOUNCE
332extern int init_emergency_isa_pool(void);
333extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
334#else
335static inline int init_emergency_isa_pool(void)
336{
337 return 0;
338}
339static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
340{
341}
342#endif /* CONFIG_BOUNCE */
343
d7067512
JB
344#ifdef CONFIG_BLK_CGROUP_IOLATENCY
345extern int blk_iolatency_init(struct request_queue *q);
346#else
347static inline int blk_iolatency_init(struct request_queue *q) { return 0; }
348#endif
349
a2d6b3a2
DLM
350struct bio *blk_next_bio(struct bio *bio, unsigned int nr_pages, gfp_t gfp);
351
bf505456
DLM
352#ifdef CONFIG_BLK_DEV_ZONED
353void blk_queue_free_zone_bitmaps(struct request_queue *q);
354#else
355static inline void blk_queue_free_zone_bitmaps(struct request_queue *q) {}
356#endif
357
581e2600
CH
358void part_dec_in_flight(struct request_queue *q, struct hd_struct *part,
359 int rw);
360void part_inc_in_flight(struct request_queue *q, struct hd_struct *part,
361 int rw);
362void update_io_ticks(struct hd_struct *part, unsigned long now, bool end);
363struct hd_struct *disk_map_sector_rcu(struct gendisk *disk, sector_t sector);
364
365int blk_alloc_devt(struct hd_struct *part, dev_t *devt);
366void blk_free_devt(dev_t devt);
367void blk_invalidate_devt(dev_t devt);
368char *disk_name(struct gendisk *hd, int partno, char *buf);
369#define ADDPART_FLAG_NONE 0
370#define ADDPART_FLAG_RAID 1
371#define ADDPART_FLAG_WHOLEDISK 2
cddae808 372void delete_partition(struct gendisk *disk, struct hd_struct *part);
fa9156ae
CH
373int bdev_add_partition(struct block_device *bdev, int partno,
374 sector_t start, sector_t length);
375int bdev_del_partition(struct block_device *bdev, int partno);
376int bdev_resize_partition(struct block_device *bdev, int partno,
377 sector_t start, sector_t length);
581e2600 378int disk_expand_part_tbl(struct gendisk *disk, int target);
8da2892e 379int hd_ref_init(struct hd_struct *part);
581e2600
CH
380
381static inline void hd_struct_get(struct hd_struct *part)
382{
383 percpu_ref_get(&part->ref);
384}
385
386static inline int hd_struct_try_get(struct hd_struct *part)
387{
388 return percpu_ref_tryget_live(&part->ref);
389}
390
391static inline void hd_struct_put(struct hd_struct *part)
392{
393 percpu_ref_put(&part->ref);
394}
395
581e2600
CH
396static inline void hd_free_part(struct hd_struct *part)
397{
398 free_part_stats(part);
399 kfree(part->info);
400 percpu_ref_exit(&part->ref);
401}
402
403/*
404 * Any access of part->nr_sects which is not protected by partition
405 * bd_mutex or gendisk bdev bd_mutex, should be done using this
406 * accessor function.
407 *
408 * Code written along the lines of i_size_read() and i_size_write().
409 * CONFIG_PREEMPTION case optimizes the case of UP kernel with preemption
410 * on.
411 */
412static inline sector_t part_nr_sects_read(struct hd_struct *part)
413{
414#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
415 sector_t nr_sects;
416 unsigned seq;
417 do {
418 seq = read_seqcount_begin(&part->nr_sects_seq);
419 nr_sects = part->nr_sects;
420 } while (read_seqcount_retry(&part->nr_sects_seq, seq));
421 return nr_sects;
422#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
423 sector_t nr_sects;
424
425 preempt_disable();
426 nr_sects = part->nr_sects;
427 preempt_enable();
428 return nr_sects;
429#else
430 return part->nr_sects;
431#endif
432}
433
434/*
435 * Should be called with mutex lock held (typically bd_mutex) of partition
436 * to provide mutual exlusion among writers otherwise seqcount might be
437 * left in wrong state leaving the readers spinning infinitely.
438 */
439static inline void part_nr_sects_write(struct hd_struct *part, sector_t size)
440{
441#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
442 write_seqcount_begin(&part->nr_sects_seq);
443 part->nr_sects = size;
444 write_seqcount_end(&part->nr_sects_seq);
445#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
446 preempt_disable();
447 part->nr_sects = size;
448 preempt_enable();
449#else
450 part->nr_sects = size;
451#endif
452}
453
3d745ea5
CH
454struct request_queue *__blk_alloc_queue(int node_id);
455
130879f1
CH
456int __bio_add_pc_page(struct request_queue *q, struct bio *bio,
457 struct page *page, unsigned int len, unsigned int offset,
458 bool *same_page);
459
bc9fcbf9 460#endif /* BLK_INTERNAL_H */