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 <linux/blk-mq.h>
   6 #include "blk-stat.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         struct request_queue    *queue;
  29         struct blk_mq_ctxs      *ctxs;
  30         struct kobject          kobj;
  31 } ____cacheline_aligned_in_smp;
  32
  33 enum {
  34         BLK_MQ_NO_TAG           = -1U,
  35         BLK_MQ_TAG_MIN          = 1,
  36         BLK_MQ_TAG_MAX          = BLK_MQ_NO_TAG - 1,
  37 };
  38
  39 void blk_mq_submit_bio(struct bio *bio);
  40 int blk_mq_poll(struct request_queue *q, blk_qc_t cookie, struct io_comp_batch *iob,
  41                 unsigned int flags);
  42 void blk_mq_exit_queue(struct request_queue *q);
  43 int blk_mq_update_nr_requests(struct request_queue *q, unsigned int nr);
  44 void blk_mq_wake_waiters(struct request_queue *q);
  45 bool blk_mq_dispatch_rq_list(struct blk_mq_hw_ctx *hctx, struct list_head *,
  46                              unsigned int);
  47 void blk_mq_add_to_requeue_list(struct request *rq, bool at_head,
  48                                 bool kick_requeue_list);
  49 void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx *hctx, struct list_head *list);
  50 struct request *blk_mq_dequeue_from_ctx(struct blk_mq_hw_ctx *hctx,
  51                                         struct blk_mq_ctx *start);
  52 void blk_mq_put_rq_ref(struct request *rq);
  53
  54 /*
  55  * Internal helpers for allocating/freeing the request map
  56  */
  57 void blk_mq_free_rqs(struct blk_mq_tag_set *set, struct blk_mq_tags *tags,
  58                      unsigned int hctx_idx);
  59 void blk_mq_free_rq_map(struct blk_mq_tags *tags);
  60 struct blk_mq_tags *blk_mq_alloc_map_and_rqs(struct blk_mq_tag_set *set,
  61                                 unsigned int hctx_idx, unsigned int depth);
  62 void blk_mq_free_map_and_rqs(struct blk_mq_tag_set *set,
  63                              struct blk_mq_tags *tags,
  64                              unsigned int hctx_idx);
  65 /*
  66  * Internal helpers for request insertion into sw queues
  67  */
  68 void blk_mq_request_bypass_insert(struct request *rq, bool at_head);
  69
  70 /*
  71  * CPU -> queue mappings
  72  */
  73 extern int blk_mq_hw_queue_to_node(struct blk_mq_queue_map *qmap, unsigned int);
  74
  75 /*
  76  * blk_mq_map_queue_type() - map (hctx_type,cpu) to hardware queue
  77  * @q: request queue
  78  * @type: the hctx type index
  79  * @cpu: CPU
  80  */
  81 static inline struct blk_mq_hw_ctx *blk_mq_map_queue_type(struct request_queue *q,
  82                                                           enum hctx_type type,
  83                                                           unsigned int cpu)
  84 {
  85         return xa_load(&q->hctx_table, q->tag_set->map[type].mq_map[cpu]);
  86 }
  87
  88 static inline enum hctx_type blk_mq_get_hctx_type(blk_opf_t opf)
  89 {
  90         enum hctx_type type = HCTX_TYPE_DEFAULT;
  91
  92         /*
  93          * The caller ensure that if REQ_POLLED, poll must be enabled.
  94          */
  95         if (opf & REQ_POLLED)
  96                 type = HCTX_TYPE_POLL;
  97         else if ((opf & REQ_OP_MASK) == REQ_OP_READ)
  98                 type = HCTX_TYPE_READ;
  99         return type;
 100 }
 101
 102 /*
 103  * blk_mq_map_queue() - map (cmd_flags,type) to hardware queue
 104  * @q: request queue
 105  * @opf: operation type (REQ_OP_*) and flags (e.g. REQ_POLLED).
 106  * @ctx: software queue cpu ctx
 107  */
 108 static inline struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *q,
 109                                                      blk_opf_t opf,
 110                                                      struct blk_mq_ctx *ctx)
 111 {
 112         return ctx->hctxs[blk_mq_get_hctx_type(opf)];
 113 }
 114
 115 /*
 116  * sysfs helpers
 117  */
 118 extern void blk_mq_sysfs_init(struct request_queue *q);
 119 extern void blk_mq_sysfs_deinit(struct request_queue *q);
 120 int blk_mq_sysfs_register(struct gendisk *disk);
 121 void blk_mq_sysfs_unregister(struct gendisk *disk);
 122 int blk_mq_sysfs_register_hctxs(struct request_queue *q);
 123 void blk_mq_sysfs_unregister_hctxs(struct request_queue *q);
 124 extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);
 125 void blk_mq_free_plug_rqs(struct blk_plug *plug);
 126 void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
 127
 128 void blk_mq_cancel_work_sync(struct request_queue *q);
 129
 130 void blk_mq_release(struct request_queue *q);
 131
 132 static inline struct blk_mq_ctx *__blk_mq_get_ctx(struct request_queue *q,
 133                                            unsigned int cpu)
 134 {
 135         return per_cpu_ptr(q->queue_ctx, cpu);
 136 }
 137
 138 /*
 139  * This assumes per-cpu software queueing queues. They could be per-node
 140  * as well, for instance. For now this is hardcoded as-is. Note that we don't
 141  * care about preemption, since we know the ctx's are persistent. This does
 142  * mean that we can't rely on ctx always matching the currently running CPU.
 143  */
 144 static inline struct blk_mq_ctx *blk_mq_get_ctx(struct request_queue *q)
 145 {
 146         return __blk_mq_get_ctx(q, raw_smp_processor_id());
 147 }
 148
 149 struct blk_mq_alloc_data {
 150         /* input parameter */
 151         struct request_queue *q;
 152         blk_mq_req_flags_t flags;
 153         unsigned int shallow_depth;
 154         blk_opf_t cmd_flags;
 155         req_flags_t rq_flags;
 156
 157         /* allocate multiple requests/tags in one go */
 158         unsigned int nr_tags;
 159         struct request **cached_rq;
 160
 161         /* input & output parameter */
 162         struct blk_mq_ctx *ctx;
 163         struct blk_mq_hw_ctx *hctx;
 164 };
 165
 166 struct blk_mq_tags *blk_mq_init_tags(unsigned int nr_tags,
 167                 unsigned int reserved_tags, int node, int alloc_policy);
 168 void blk_mq_free_tags(struct blk_mq_tags *tags);
 169 int blk_mq_init_bitmaps(struct sbitmap_queue *bitmap_tags,
 170                 struct sbitmap_queue *breserved_tags, unsigned int queue_depth,
 171                 unsigned int reserved, int node, int alloc_policy);
 172
 173 unsigned int blk_mq_get_tag(struct blk_mq_alloc_data *data);
 174 unsigned long blk_mq_get_tags(struct blk_mq_alloc_data *data, int nr_tags,
 175                 unsigned int *offset);
 176 void blk_mq_put_tag(struct blk_mq_tags *tags, struct blk_mq_ctx *ctx,
 177                 unsigned int tag);
 178 void blk_mq_put_tags(struct blk_mq_tags *tags, int *tag_array, int nr_tags);
 179 int blk_mq_tag_update_depth(struct blk_mq_hw_ctx *hctx,
 180                 struct blk_mq_tags **tags, unsigned int depth, bool can_grow);
 181 void blk_mq_tag_resize_shared_tags(struct blk_mq_tag_set *set,
 182                 unsigned int size);
 183 void blk_mq_tag_update_sched_shared_tags(struct request_queue *q);
 184
 185 void blk_mq_tag_wakeup_all(struct blk_mq_tags *tags, bool);
 186 void blk_mq_queue_tag_busy_iter(struct request_queue *q, busy_tag_iter_fn *fn,
 187                 void *priv);
 188 void blk_mq_all_tag_iter(struct blk_mq_tags *tags, busy_tag_iter_fn *fn,
 189                 void *priv);
 190
 191 static inline struct sbq_wait_state *bt_wait_ptr(struct sbitmap_queue *bt,
 192                                                  struct blk_mq_hw_ctx *hctx)
 193 {
 194         if (!hctx)
 195                 return &bt->ws[0];
 196         return sbq_wait_ptr(bt, &hctx->wait_index);
 197 }
 198
 199 void __blk_mq_tag_busy(struct blk_mq_hw_ctx *);
 200 void __blk_mq_tag_idle(struct blk_mq_hw_ctx *);
 201
 202 static inline void blk_mq_tag_busy(struct blk_mq_hw_ctx *hctx)
 203 {
 204         if (hctx->flags & BLK_MQ_F_TAG_QUEUE_SHARED)
 205                 __blk_mq_tag_busy(hctx);
 206 }
 207
 208 static inline void blk_mq_tag_idle(struct blk_mq_hw_ctx *hctx)
 209 {
 210         if (hctx->flags & BLK_MQ_F_TAG_QUEUE_SHARED)
 211                 __blk_mq_tag_idle(hctx);
 212 }
 213
 214 static inline bool blk_mq_tag_is_reserved(struct blk_mq_tags *tags,
 215                                           unsigned int tag)
 216 {
 217         return tag < tags->nr_reserved_tags;
 218 }
 219
 220 static inline bool blk_mq_is_shared_tags(unsigned int flags)
 221 {
 222         return flags & BLK_MQ_F_TAG_HCTX_SHARED;
 223 }
 224
 225 static inline struct blk_mq_tags *blk_mq_tags_from_data(struct blk_mq_alloc_data *data)
 226 {
 227         if (!(data->rq_flags & RQF_ELV))
 228                 return data->hctx->tags;
 229         return data->hctx->sched_tags;
 230 }
 231
 232 static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
 233 {
 234         return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
 235 }
 236
 237 static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
 238 {
 239         return hctx->nr_ctx && hctx->tags;
 240 }
 241
 242 unsigned int blk_mq_in_flight(struct request_queue *q,
 243                 struct block_device *part);
 244 void blk_mq_in_flight_rw(struct request_queue *q, struct block_device *part,
 245                 unsigned int inflight[2]);
 246
 247 static inline void blk_mq_put_dispatch_budget(struct request_queue *q,
 248                                               int budget_token)
 249 {
 250         if (q->mq_ops->put_budget)
 251                 q->mq_ops->put_budget(q, budget_token);
 252 }
 253
 254 static inline int blk_mq_get_dispatch_budget(struct request_queue *q)
 255 {
 256         if (q->mq_ops->get_budget)
 257                 return q->mq_ops->get_budget(q);
 258         return 0;
 259 }
 260
 261 static inline void blk_mq_set_rq_budget_token(struct request *rq, int token)
 262 {
 263         if (token < 0)
 264                 return;
 265
 266         if (rq->q->mq_ops->set_rq_budget_token)
 267                 rq->q->mq_ops->set_rq_budget_token(rq, token);
 268 }
 269
 270 static inline int blk_mq_get_rq_budget_token(struct request *rq)
 271 {
 272         if (rq->q->mq_ops->get_rq_budget_token)
 273                 return rq->q->mq_ops->get_rq_budget_token(rq);
 274         return -1;
 275 }
 276
 277 static inline void __blk_mq_inc_active_requests(struct blk_mq_hw_ctx *hctx)
 278 {
 279         if (blk_mq_is_shared_tags(hctx->flags))
 280                 atomic_inc(&hctx->queue->nr_active_requests_shared_tags);
 281         else
 282                 atomic_inc(&hctx->nr_active);
 283 }
 284
 285 static inline void __blk_mq_sub_active_requests(struct blk_mq_hw_ctx *hctx,
 286                 int val)
 287 {
 288         if (blk_mq_is_shared_tags(hctx->flags))
 289                 atomic_sub(val, &hctx->queue->nr_active_requests_shared_tags);
 290         else
 291                 atomic_sub(val, &hctx->nr_active);
 292 }
 293
 294 static inline void __blk_mq_dec_active_requests(struct blk_mq_hw_ctx *hctx)
 295 {
 296         __blk_mq_sub_active_requests(hctx, 1);
 297 }
 298
 299 static inline int __blk_mq_active_requests(struct blk_mq_hw_ctx *hctx)
 300 {
 301         if (blk_mq_is_shared_tags(hctx->flags))
 302                 return atomic_read(&hctx->queue->nr_active_requests_shared_tags);
 303         return atomic_read(&hctx->nr_active);
 304 }
 305 static inline void __blk_mq_put_driver_tag(struct blk_mq_hw_ctx *hctx,
 306                                            struct request *rq)
 307 {
 308         blk_mq_put_tag(hctx->tags, rq->mq_ctx, rq->tag);
 309         rq->tag = BLK_MQ_NO_TAG;
 310
 311         if (rq->rq_flags & RQF_MQ_INFLIGHT) {
 312                 rq->rq_flags &= ~RQF_MQ_INFLIGHT;
 313                 __blk_mq_dec_active_requests(hctx);
 314         }
 315 }
 316
 317 static inline void blk_mq_put_driver_tag(struct request *rq)
 318 {
 319         if (rq->tag == BLK_MQ_NO_TAG || rq->internal_tag == BLK_MQ_NO_TAG)
 320                 return;
 321
 322         __blk_mq_put_driver_tag(rq->mq_hctx, rq);
 323 }
 324
 325 bool __blk_mq_get_driver_tag(struct blk_mq_hw_ctx *hctx, struct request *rq);
 326
 327 static inline bool blk_mq_get_driver_tag(struct request *rq)
 328 {
 329         struct blk_mq_hw_ctx *hctx = rq->mq_hctx;
 330
 331         if (rq->tag != BLK_MQ_NO_TAG &&
 332             !(hctx->flags & BLK_MQ_F_TAG_QUEUE_SHARED)) {
 333                 hctx->tags->rqs[rq->tag] = rq;
 334                 return true;
 335         }
 336
 337         return __blk_mq_get_driver_tag(hctx, rq);
 338 }
 339
 340 static inline void blk_mq_clear_mq_map(struct blk_mq_queue_map *qmap)
 341 {
 342         int cpu;
 343
 344         for_each_possible_cpu(cpu)
 345                 qmap->mq_map[cpu] = 0;
 346 }
 347
 348 /*
 349  * blk_mq_plug() - Get caller context plug
 350  * @bio : the bio being submitted by the caller context
 351  *
 352  * Plugging, by design, may delay the insertion of BIOs into the elevator in
 353  * order to increase BIO merging opportunities. This however can cause BIO
 354  * insertion order to change from the order in which submit_bio() is being
 355  * executed in the case of multiple contexts concurrently issuing BIOs to a
 356  * device, even if these context are synchronized to tightly control BIO issuing
 357  * order. While this is not a problem with regular block devices, this ordering
 358  * change can cause write BIO failures with zoned block devices as these
 359  * require sequential write patterns to zones. Prevent this from happening by
 360  * ignoring the plug state of a BIO issuing context if it is for a zoned block
 361  * device and the BIO to plug is a write operation.
 362  *
 363  * Return current->plug if the bio can be plugged and NULL otherwise
 364  */
 365 static inline struct blk_plug *blk_mq_plug( struct bio *bio)
 366 {
 367         /* Zoned block device write operation case: do not plug the BIO */
 368         if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
 369             bdev_op_is_zoned_write(bio->bi_bdev, bio_op(bio)))
 370                 return NULL;
 371
 372         /*
 373          * For regular block devices or read operations, use the context plug
 374          * which may be NULL if blk_start_plug() was not executed.
 375          */
 376         return current->plug;
 377 }
 378
 379 /* Free all requests on the list */
 380 static inline void blk_mq_free_requests(struct list_head *list)
 381 {
 382         while (!list_empty(list)) {
 383                 struct request *rq = list_entry_rq(list->next);
 384
 385                 list_del_init(&rq->queuelist);
 386                 blk_mq_free_request(rq);
 387         }
 388 }
 389
 390 /*
 391  * For shared tag users, we track the number of currently active users
 392  * and attempt to provide a fair share of the tag depth for each of them.
 393  */
 394 static inline bool hctx_may_queue(struct blk_mq_hw_ctx *hctx,
 395                                   struct sbitmap_queue *bt)
 396 {
 397         unsigned int depth, users;
 398
 399         if (!hctx || !(hctx->flags & BLK_MQ_F_TAG_QUEUE_SHARED))
 400                 return true;
 401
 402         /*
 403          * Don't try dividing an ant
 404          */
 405         if (bt->sb.depth == 1)
 406                 return true;
 407
 408         if (blk_mq_is_shared_tags(hctx->flags)) {
 409                 struct request_queue *q = hctx->queue;
 410
 411                 if (!test_bit(QUEUE_FLAG_HCTX_ACTIVE, &q->queue_flags))
 412                         return true;
 413         } else {
 414                 if (!test_bit(BLK_MQ_S_TAG_ACTIVE, &hctx->state))
 415                         return true;
 416         }
 417
 418         users = atomic_read(&hctx->tags->active_queues);
 419
 420         if (!users)
 421                 return true;
 422
 423         /*
 424          * Allow at least some tags
 425          */
 426         depth = max((bt->sb.depth + users - 1) / users, 4U);
 427         return __blk_mq_active_requests(hctx) < depth;
 428 }
 429
 430 /* run the code block in @dispatch_ops with rcu/srcu read lock held */
 431 #define __blk_mq_run_dispatch_ops(q, check_sleep, dispatch_ops) \
 432 do {                                                            \
 433         if ((q)->tag_set->flags & BLK_MQ_F_BLOCKING) {          \
 434                 int srcu_idx;                                   \
 435                                                                 \
 436                 might_sleep_if(check_sleep);                    \
 437                 srcu_idx = srcu_read_lock((q)->tag_set->srcu);  \
 438                 (dispatch_ops);                                 \
 439                 srcu_read_unlock((q)->tag_set->srcu, srcu_idx); \
 440         } else {                                                \
 441                 rcu_read_lock();                                \
 442                 (dispatch_ops);                                 \
 443                 rcu_read_unlock();                              \
 444         }                                                       \
 445 } while (0)
 446
 447 #define blk_mq_run_dispatch_ops(q, dispatch_ops)                \
 448         __blk_mq_run_dispatch_ops(q, true, dispatch_ops)        \
 449
 450 #endif