git.rot13.org Git - linux/blob - block/blk-mq.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef INT_BLK_MQ_H
   3 #define INT_BLK_MQ_H
   4
   5 #include "blk-stat.h"
   6 #include "blk-mq-tag.h"
   7
   8 struct blk_mq_tag_set;
   9
  10 struct blk_mq_ctxs {
  11         struct kobject kobj;
  12         struct blk_mq_ctx __percpu      *queue_ctx;
  13 };
  14
  15 /**
  16  * struct blk_mq_ctx - State for a software queue facing the submitting CPUs
  17  */
  18 struct blk_mq_ctx {
  19         struct {
  20                 spinlock_t              lock;
  21                 struct list_head        rq_lists[HCTX_MAX_TYPES];
  22         } ____cacheline_aligned_in_smp;
  23
  24         unsigned int            cpu;
  25         unsigned short          index_hw[HCTX_MAX_TYPES];
  26         struct blk_mq_hw_ctx    *hctxs[HCTX_MAX_TYPES];
  27
  28         /* incremented at dispatch time */
  29         unsigned long           rq_dispatched[2];
  30         unsigned long           rq_merged;
  31
  32         /* incremented at completion time */
  33         unsigned long           ____cacheline_aligned_in_smp rq_completed[2];
  34
  35         struct request_queue    *queue;
  36         struct blk_mq_ctxs      *ctxs;
  37         struct kobject          kobj;
  38 } ____cacheline_aligned_in_smp;
  39
  40 void blk_mq_freeze_queue(struct request_queue *q);
  41 void blk_mq_free_queue(struct request_queue *q);
  42 int blk_mq_update_nr_requests(struct request_queue *q, unsigned int nr);
  43 void blk_mq_wake_waiters(struct request_queue *q);
  44 bool blk_mq_dispatch_rq_list(struct request_queue *, struct list_head *, bool);
  45 void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx *hctx, struct list_head *list);
  46 bool blk_mq_get_driver_tag(struct request *rq);
  47 struct request *blk_mq_dequeue_from_ctx(struct blk_mq_hw_ctx *hctx,
  48                                         struct blk_mq_ctx *start);
  49
  50 /*
  51  * Internal helpers for allocating/freeing the request map
  52  */
  53 void blk_mq_free_rqs(struct blk_mq_tag_set *set, struct blk_mq_tags *tags,
  54                      unsigned int hctx_idx);
  55 void blk_mq_free_rq_map(struct blk_mq_tags *tags);
  56 struct blk_mq_tags *blk_mq_alloc_rq_map(struct blk_mq_tag_set *set,
  57                                         unsigned int hctx_idx,
  58                                         unsigned int nr_tags,
  59                                         unsigned int reserved_tags);
  60 int blk_mq_alloc_rqs(struct blk_mq_tag_set *set, struct blk_mq_tags *tags,
  61                      unsigned int hctx_idx, unsigned int depth);
  62
  63 /*
  64  * Internal helpers for request insertion into sw queues
  65  */
  66 void __blk_mq_insert_request(struct blk_mq_hw_ctx *hctx, struct request *rq,
  67                                 bool at_head);
  68 void blk_mq_request_bypass_insert(struct request *rq, bool run_queue);
  69 void blk_mq_insert_requests(struct blk_mq_hw_ctx *hctx, struct blk_mq_ctx *ctx,
  70                                 struct list_head *list);
  71
  72 blk_status_t blk_mq_try_issue_directly(struct blk_mq_hw_ctx *hctx,
  73                                                 struct request *rq,
  74                                                 blk_qc_t *cookie,
  75                                                 bool bypass, bool last);
  76 void blk_mq_try_issue_list_directly(struct blk_mq_hw_ctx *hctx,
  77                                     struct list_head *list);
  78
  79 /*
  80  * CPU -> queue mappings
  81  */
  82 extern int blk_mq_hw_queue_to_node(struct blk_mq_queue_map *qmap, unsigned int);
  83
  84 /*
  85  * blk_mq_map_queue_type() - map (hctx_type,cpu) to hardware queue
  86  * @q: request queue
  87  * @type: the hctx type index
  88  * @cpu: CPU
  89  */
  90 static inline struct blk_mq_hw_ctx *blk_mq_map_queue_type(struct request_queue *q,
  91                                                           enum hctx_type type,
  92                                                           unsigned int cpu)
  93 {
  94         return q->queue_hw_ctx[q->tag_set->map[type].mq_map[cpu]];
  95 }
  96
  97 /*
  98  * blk_mq_map_queue() - map (cmd_flags,type) to hardware queue
  99  * @q: request queue
 100  * @flags: request command flags
 101  * @cpu: cpu ctx
 102  */
 103 static inline struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *q,
 104                                                      unsigned int flags,
 105                                                      struct blk_mq_ctx *ctx)
 106 {
 107         enum hctx_type type = HCTX_TYPE_DEFAULT;
 108
 109         /*
 110          * The caller ensure that if REQ_HIPRI, poll must be enabled.
 111          */
 112         if (flags & REQ_HIPRI)
 113                 type = HCTX_TYPE_POLL;
 114         else if ((flags & REQ_OP_MASK) == REQ_OP_READ)
 115                 type = HCTX_TYPE_READ;
 116
 117         return ctx->hctxs[type];
 118 }
 119
 120 /*
 121  * sysfs helpers
 122  */
 123 extern void blk_mq_sysfs_init(struct request_queue *q);
 124 extern void blk_mq_sysfs_deinit(struct request_queue *q);
 125 extern int __blk_mq_register_dev(struct device *dev, struct request_queue *q);
 126 extern int blk_mq_sysfs_register(struct request_queue *q);
 127 extern void blk_mq_sysfs_unregister(struct request_queue *q);
 128 extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);
 129
 130 void blk_mq_release(struct request_queue *q);
 131
 132 /**
 133  * blk_mq_rq_state() - read the current MQ_RQ_* state of a request
 134  * @rq: target request.
 135  */
 136 static inline enum mq_rq_state blk_mq_rq_state(struct request *rq)
 137 {
 138         return READ_ONCE(rq->state);
 139 }
 140
 141 static inline struct blk_mq_ctx *__blk_mq_get_ctx(struct request_queue *q,
 142                                            unsigned int cpu)
 143 {
 144         return per_cpu_ptr(q->queue_ctx, cpu);
 145 }
 146
 147 /*
 148  * This assumes per-cpu software queueing queues. They could be per-node
 149  * as well, for instance. For now this is hardcoded as-is. Note that we don't
 150  * care about preemption, since we know the ctx's are persistent. This does
 151  * mean that we can't rely on ctx always matching the currently running CPU.
 152  */
 153 static inline struct blk_mq_ctx *blk_mq_get_ctx(struct request_queue *q)
 154 {
 155         return __blk_mq_get_ctx(q, get_cpu());
 156 }
 157
 158 static inline void blk_mq_put_ctx(struct blk_mq_ctx *ctx)
 159 {
 160         put_cpu();
 161 }
 162
 163 struct blk_mq_alloc_data {
 164         /* input parameter */
 165         struct request_queue *q;
 166         blk_mq_req_flags_t flags;
 167         unsigned int shallow_depth;
 168         unsigned int cmd_flags;
 169
 170         /* input & output parameter */
 171         struct blk_mq_ctx *ctx;
 172         struct blk_mq_hw_ctx *hctx;
 173 };
 174
 175 static inline struct blk_mq_tags *blk_mq_tags_from_data(struct blk_mq_alloc_data *data)
 176 {
 177         if (data->flags & BLK_MQ_REQ_INTERNAL)
 178                 return data->hctx->sched_tags;
 179
 180         return data->hctx->tags;
 181 }
 182
 183 static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
 184 {
 185         return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
 186 }
 187
 188 static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
 189 {
 190         return hctx->nr_ctx && hctx->tags;
 191 }
 192
 193 unsigned int blk_mq_in_flight(struct request_queue *q, struct hd_struct *part);
 194 void blk_mq_in_flight_rw(struct request_queue *q, struct hd_struct *part,
 195                          unsigned int inflight[2]);
 196
 197 static inline void blk_mq_put_dispatch_budget(struct blk_mq_hw_ctx *hctx)
 198 {
 199         struct request_queue *q = hctx->queue;
 200
 201         if (q->mq_ops->put_budget)
 202                 q->mq_ops->put_budget(hctx);
 203 }
 204
 205 static inline bool blk_mq_get_dispatch_budget(struct blk_mq_hw_ctx *hctx)
 206 {
 207         struct request_queue *q = hctx->queue;
 208
 209         if (q->mq_ops->get_budget)
 210                 return q->mq_ops->get_budget(hctx);
 211         return true;
 212 }
 213
 214 static inline void __blk_mq_put_driver_tag(struct blk_mq_hw_ctx *hctx,
 215                                            struct request *rq)
 216 {
 217         blk_mq_put_tag(hctx, hctx->tags, rq->mq_ctx, rq->tag);
 218         rq->tag = -1;
 219
 220         if (rq->rq_flags & RQF_MQ_INFLIGHT) {
 221                 rq->rq_flags &= ~RQF_MQ_INFLIGHT;
 222                 atomic_dec(&hctx->nr_active);
 223         }
 224 }
 225
 226 static inline void blk_mq_put_driver_tag_hctx(struct blk_mq_hw_ctx *hctx,
 227                                        struct request *rq)
 228 {
 229         if (rq->tag == -1 || rq->internal_tag == -1)
 230                 return;
 231
 232         __blk_mq_put_driver_tag(hctx, rq);
 233 }
 234
 235 static inline void blk_mq_put_driver_tag(struct request *rq)
 236 {
 237         if (rq->tag == -1 || rq->internal_tag == -1)
 238                 return;
 239
 240         __blk_mq_put_driver_tag(rq->mq_hctx, rq);
 241 }
 242
 243 static inline void blk_mq_clear_mq_map(struct blk_mq_queue_map *qmap)
 244 {
 245         int cpu;
 246
 247         for_each_possible_cpu(cpu)
 248                 qmap->mq_map[cpu] = 0;
 249 }
 250
 251 #endif