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