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