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         if ((flags & REQ_HIPRI) &&
 110             q->tag_set->nr_maps > HCTX_TYPE_POLL &&
 111             q->tag_set->map[HCTX_TYPE_POLL].nr_queues &&
 112             test_bit(QUEUE_FLAG_POLL, &q->queue_flags))
 113                 type = HCTX_TYPE_POLL;
 114
 115         else if (((flags & REQ_OP_MASK) == REQ_OP_READ) &&
 116                  q->tag_set->nr_maps > HCTX_TYPE_READ &&
 117                  q->tag_set->map[HCTX_TYPE_READ].nr_queues)
 118                 type = HCTX_TYPE_READ;
 119
 120         return ctx->hctxs[type];
 121 }
 122
 123 /*
 124  * sysfs helpers
 125  */
 126 extern void blk_mq_sysfs_init(struct request_queue *q);
 127 extern void blk_mq_sysfs_deinit(struct request_queue *q);
 128 extern int __blk_mq_register_dev(struct device *dev, struct request_queue *q);
 129 extern int blk_mq_sysfs_register(struct request_queue *q);
 130 extern void blk_mq_sysfs_unregister(struct request_queue *q);
 131 extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);
 132
 133 void blk_mq_release(struct request_queue *q);
 134
 135 /**
 136  * blk_mq_rq_state() - read the current MQ_RQ_* state of a request
 137  * @rq: target request.
 138  */
 139 static inline enum mq_rq_state blk_mq_rq_state(struct request *rq)
 140 {
 141         return READ_ONCE(rq->state);
 142 }
 143
 144 static inline struct blk_mq_ctx *__blk_mq_get_ctx(struct request_queue *q,
 145                                            unsigned int cpu)
 146 {
 147         return per_cpu_ptr(q->queue_ctx, cpu);
 148 }
 149
 150 /*
 151  * This assumes per-cpu software queueing queues. They could be per-node
 152  * as well, for instance. For now this is hardcoded as-is. Note that we don't
 153  * care about preemption, since we know the ctx's are persistent. This does
 154  * mean that we can't rely on ctx always matching the currently running CPU.
 155  */
 156 static inline struct blk_mq_ctx *blk_mq_get_ctx(struct request_queue *q)
 157 {
 158         return __blk_mq_get_ctx(q, get_cpu());
 159 }
 160
 161 static inline void blk_mq_put_ctx(struct blk_mq_ctx *ctx)
 162 {
 163         put_cpu();
 164 }
 165
 166 struct blk_mq_alloc_data {
 167         /* input parameter */
 168         struct request_queue *q;
 169         blk_mq_req_flags_t flags;
 170         unsigned int shallow_depth;
 171         unsigned int cmd_flags;
 172
 173         /* input & output parameter */
 174         struct blk_mq_ctx *ctx;
 175         struct blk_mq_hw_ctx *hctx;
 176 };
 177
 178 static inline struct blk_mq_tags *blk_mq_tags_from_data(struct blk_mq_alloc_data *data)
 179 {
 180         if (data->flags & BLK_MQ_REQ_INTERNAL)
 181                 return data->hctx->sched_tags;
 182
 183         return data->hctx->tags;
 184 }
 185
 186 static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
 187 {
 188         return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
 189 }
 190
 191 static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
 192 {
 193         return hctx->nr_ctx && hctx->tags;
 194 }
 195
 196 unsigned int blk_mq_in_flight(struct request_queue *q, struct hd_struct *part);
 197 void blk_mq_in_flight_rw(struct request_queue *q, struct hd_struct *part,
 198                          unsigned int inflight[2]);
 199
 200 static inline void blk_mq_put_dispatch_budget(struct blk_mq_hw_ctx *hctx)
 201 {
 202         struct request_queue *q = hctx->queue;
 203
 204         if (q->mq_ops->put_budget)
 205                 q->mq_ops->put_budget(hctx);
 206 }
 207
 208 static inline bool blk_mq_get_dispatch_budget(struct blk_mq_hw_ctx *hctx)
 209 {
 210         struct request_queue *q = hctx->queue;
 211
 212         if (q->mq_ops->get_budget)
 213                 return q->mq_ops->get_budget(hctx);
 214         return true;
 215 }
 216
 217 static inline void __blk_mq_put_driver_tag(struct blk_mq_hw_ctx *hctx,
 218                                            struct request *rq)
 219 {
 220         blk_mq_put_tag(hctx, hctx->tags, rq->mq_ctx, rq->tag);
 221         rq->tag = -1;
 222
 223         if (rq->rq_flags & RQF_MQ_INFLIGHT) {
 224                 rq->rq_flags &= ~RQF_MQ_INFLIGHT;
 225                 atomic_dec(&hctx->nr_active);
 226         }
 227 }
 228
 229 static inline void blk_mq_put_driver_tag_hctx(struct blk_mq_hw_ctx *hctx,
 230                                        struct request *rq)
 231 {
 232         if (rq->tag == -1 || rq->internal_tag == -1)
 233                 return;
 234
 235         __blk_mq_put_driver_tag(hctx, rq);
 236 }
 237
 238 static inline void blk_mq_put_driver_tag(struct request *rq)
 239 {
 240         if (rq->tag == -1 || rq->internal_tag == -1)
 241                 return;
 242
 243         __blk_mq_put_driver_tag(rq->mq_hctx, rq);
 244 }
 245
 246 static inline void blk_mq_clear_mq_map(struct blk_mq_queue_map *qmap)
 247 {
 248         int cpu;
 249
 250         for_each_possible_cpu(cpu)
 251                 qmap->mq_map[cpu] = 0;
 252 }
 253
 254 #endif