blk-mq-sched: add framework for MQ capable IO schedulers
[platform/kernel/linux-rpi.git] / block / blk-mq.h
1 #ifndef INT_BLK_MQ_H
2 #define INT_BLK_MQ_H
3
4 #include "blk-stat.h"
5
6 struct blk_mq_tag_set;
7
8 struct blk_mq_ctx {
9         struct {
10                 spinlock_t              lock;
11                 struct list_head        rq_list;
12         }  ____cacheline_aligned_in_smp;
13
14         unsigned int            cpu;
15         unsigned int            index_hw;
16
17         /* incremented at dispatch time */
18         unsigned long           rq_dispatched[2];
19         unsigned long           rq_merged;
20
21         /* incremented at completion time */
22         unsigned long           ____cacheline_aligned_in_smp rq_completed[2];
23         struct blk_rq_stat      stat[2];
24
25         struct request_queue    *queue;
26         struct kobject          kobj;
27 } ____cacheline_aligned_in_smp;
28
29 void blk_mq_run_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
30 void blk_mq_freeze_queue(struct request_queue *q);
31 void blk_mq_free_queue(struct request_queue *q);
32 int blk_mq_update_nr_requests(struct request_queue *q, unsigned int nr);
33 void blk_mq_wake_waiters(struct request_queue *q);
34 bool blk_mq_dispatch_rq_list(struct blk_mq_hw_ctx *, struct list_head *);
35 void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx *hctx, struct list_head *list);
36
37 /*
38  * Internal helpers for allocating/freeing the request map
39  */
40 void blk_mq_free_rqs(struct blk_mq_tag_set *set, struct blk_mq_tags *tags,
41                      unsigned int hctx_idx);
42 void blk_mq_free_rq_map(struct blk_mq_tags *tags);
43 struct blk_mq_tags *blk_mq_alloc_rq_map(struct blk_mq_tag_set *set,
44                                         unsigned int hctx_idx,
45                                         unsigned int nr_tags,
46                                         unsigned int reserved_tags);
47 int blk_mq_alloc_rqs(struct blk_mq_tag_set *set, struct blk_mq_tags *tags,
48                      unsigned int hctx_idx, unsigned int depth);
49
50 /*
51  * Internal helpers for request insertion into sw queues
52  */
53 void __blk_mq_insert_request(struct blk_mq_hw_ctx *hctx, struct request *rq,
54                                 bool at_head);
55 void blk_mq_insert_requests(struct blk_mq_hw_ctx *hctx, struct blk_mq_ctx *ctx,
56                                 struct list_head *list);
57 /*
58  * CPU hotplug helpers
59  */
60 void blk_mq_enable_hotplug(void);
61 void blk_mq_disable_hotplug(void);
62
63 /*
64  * CPU -> queue mappings
65  */
66 extern int blk_mq_hw_queue_to_node(unsigned int *map, unsigned int);
67
68 static inline struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *q,
69                 int cpu)
70 {
71         return q->queue_hw_ctx[q->mq_map[cpu]];
72 }
73
74 /*
75  * sysfs helpers
76  */
77 extern int blk_mq_sysfs_register(struct request_queue *q);
78 extern void blk_mq_sysfs_unregister(struct request_queue *q);
79 extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);
80
81 extern void blk_mq_rq_timed_out(struct request *req, bool reserved);
82
83 void blk_mq_release(struct request_queue *q);
84
85 static inline struct blk_mq_ctx *__blk_mq_get_ctx(struct request_queue *q,
86                                            unsigned int cpu)
87 {
88         return per_cpu_ptr(q->queue_ctx, cpu);
89 }
90
91 /*
92  * This assumes per-cpu software queueing queues. They could be per-node
93  * as well, for instance. For now this is hardcoded as-is. Note that we don't
94  * care about preemption, since we know the ctx's are persistent. This does
95  * mean that we can't rely on ctx always matching the currently running CPU.
96  */
97 static inline struct blk_mq_ctx *blk_mq_get_ctx(struct request_queue *q)
98 {
99         return __blk_mq_get_ctx(q, get_cpu());
100 }
101
102 static inline void blk_mq_put_ctx(struct blk_mq_ctx *ctx)
103 {
104         put_cpu();
105 }
106
107 struct blk_mq_alloc_data {
108         /* input parameter */
109         struct request_queue *q;
110         unsigned int flags;
111
112         /* input & output parameter */
113         struct blk_mq_ctx *ctx;
114         struct blk_mq_hw_ctx *hctx;
115 };
116
117 static inline void blk_mq_set_alloc_data(struct blk_mq_alloc_data *data,
118                 struct request_queue *q, unsigned int flags,
119                 struct blk_mq_ctx *ctx, struct blk_mq_hw_ctx *hctx)
120 {
121         data->q = q;
122         data->flags = flags;
123         data->ctx = ctx;
124         data->hctx = hctx;
125 }
126
127 static inline struct blk_mq_tags *blk_mq_tags_from_data(struct blk_mq_alloc_data *data)
128 {
129         if (data->flags & BLK_MQ_REQ_INTERNAL)
130                 return data->hctx->sched_tags;
131
132         return data->hctx->tags;
133 }
134
135 /*
136  * Internal helpers for request allocation/init/free
137  */
138 void blk_mq_rq_ctx_init(struct request_queue *q, struct blk_mq_ctx *ctx,
139                         struct request *rq, unsigned int op);
140 void __blk_mq_finish_request(struct blk_mq_hw_ctx *hctx, struct blk_mq_ctx *ctx,
141                                 struct request *rq);
142 void blk_mq_finish_request(struct request *rq);
143 struct request *__blk_mq_alloc_request(struct blk_mq_alloc_data *data,
144                                         unsigned int op);
145
146 static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
147 {
148         return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
149 }
150
151 static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
152 {
153         return hctx->nr_ctx && hctx->tags;
154 }
155
156 #endif