block/blk-mq-tag.c

   1 /*
   2  * Fast and scalable bitmap tagging variant. Uses sparser bitmaps spread
   3  * over multiple cachelines to avoid ping-pong between multiple submitters
   4  * or submitter and completer. Uses rolling wakeups to avoid falling of
   5  * the scaling cliff when we run out of tags and have to start putting
   6  * submitters to sleep.
   7  *
   8  * Uses active queue tracking to support fairer distribution of tags
   9  * between multiple submitters when a shared tag map is used.
  10  *
  11  * Copyright (C) 2013-2014 Jens Axboe
  12  */
  13 #include <linux/kernel.h>
  14 #include <linux/module.h>
  15 #include <linux/random.h>
  16
  17 #include <linux/blk-mq.h>
  18 #include "blk.h"
  19 #include "blk-mq.h"
  20 #include "blk-mq-tag.h"
  21
  22 static bool bt_has_free_tags(struct blk_mq_bitmap_tags *bt)
  23 {
  24         int i;
  25
  26         for (i = 0; i < bt->map_nr; i++) {
  27                 struct blk_align_bitmap *bm = &bt->map[i];
  28                 int ret;
  29
  30                 ret = find_first_zero_bit(&bm->word, bm->depth);
  31                 if (ret < bm->depth)
  32                         return true;
  33         }
  34
  35         return false;
  36 }
  37
  38 bool blk_mq_has_free_tags(struct blk_mq_tags *tags)
  39 {
  40         if (!tags)
  41                 return true;
  42
  43         return bt_has_free_tags(&tags->bitmap_tags);
  44 }
  45
  46 static inline int bt_index_inc(int index)
  47 {
  48         return (index + 1) & (BT_WAIT_QUEUES - 1);
  49 }
  50
  51 static inline void bt_index_atomic_inc(atomic_t *index)
  52 {
  53         int old = atomic_read(index);
  54         int new = bt_index_inc(old);
  55         atomic_cmpxchg(index, old, new);
  56 }
  57
  58 /*
  59  * If a previously inactive queue goes active, bump the active user count.
  60  */
  61 bool __blk_mq_tag_busy(struct blk_mq_hw_ctx *hctx)
  62 {
  63         if (!test_bit(BLK_MQ_S_TAG_ACTIVE, &hctx->state) &&
  64             !test_and_set_bit(BLK_MQ_S_TAG_ACTIVE, &hctx->state))
  65                 atomic_inc(&hctx->tags->active_queues);
  66
  67         return true;
  68 }
  69
  70 /*
  71  * Wakeup all potentially sleeping on normal (non-reserved) tags
  72  */
  73 static void blk_mq_tag_wakeup_all(struct blk_mq_tags *tags)
  74 {
  75         struct blk_mq_bitmap_tags *bt;
  76         int i, wake_index;
  77
  78         bt = &tags->bitmap_tags;
  79         wake_index = atomic_read(&bt->wake_index);
  80         for (i = 0; i < BT_WAIT_QUEUES; i++) {
  81                 struct bt_wait_state *bs = &bt->bs[wake_index];
  82
  83                 if (waitqueue_active(&bs->wait))
  84                         wake_up(&bs->wait);
  85
  86                 wake_index = bt_index_inc(wake_index);
  87         }
  88 }
  89
  90 /*
  91  * If a previously busy queue goes inactive, potential waiters could now
  92  * be allowed to queue. Wake them up and check.
  93  */
  94 void __blk_mq_tag_idle(struct blk_mq_hw_ctx *hctx)
  95 {
  96         struct blk_mq_tags *tags = hctx->tags;
  97
  98         if (!test_and_clear_bit(BLK_MQ_S_TAG_ACTIVE, &hctx->state))
  99                 return;
 100
 101         atomic_dec(&tags->active_queues);
 102
 103         blk_mq_tag_wakeup_all(tags);
 104 }
 105
 106 /*
 107  * For shared tag users, we track the number of currently active users
 108  * and attempt to provide a fair share of the tag depth for each of them.
 109  */
 110 static inline bool hctx_may_queue(struct blk_mq_hw_ctx *hctx,
 111                                   struct blk_mq_bitmap_tags *bt)
 112 {
 113         unsigned int depth, users;
 114
 115         if (!hctx || !(hctx->flags & BLK_MQ_F_TAG_SHARED))
 116                 return true;
 117         if (!test_bit(BLK_MQ_S_TAG_ACTIVE, &hctx->state))
 118                 return true;
 119
 120         /*
 121          * Don't try dividing an ant
 122          */
 123         if (bt->depth == 1)
 124                 return true;
 125
 126         users = atomic_read(&hctx->tags->active_queues);
 127         if (!users)
 128                 return true;
 129
 130         /*
 131          * Allow at least some tags
 132          */
 133         depth = max((bt->depth + users - 1) / users, 4U);
 134         return atomic_read(&hctx->nr_active) < depth;
 135 }
 136
 137 static int __bt_get_word(struct blk_align_bitmap *bm, unsigned int last_tag)
 138 {
 139         int tag, org_last_tag, end;
 140
 141         org_last_tag = last_tag;
 142         end = bm->depth;
 143         do {
 144 restart:
 145                 tag = find_next_zero_bit(&bm->word, end, last_tag);
 146                 if (unlikely(tag >= end)) {
 147                         /*
 148                          * We started with an offset, start from 0 to
 149                          * exhaust the map.
 150                          */
 151                         if (org_last_tag && last_tag) {
 152                                 end = last_tag;
 153                                 last_tag = 0;
 154                                 goto restart;
 155                         }
 156                         return -1;
 157                 }
 158                 last_tag = tag + 1;
 159         } while (test_and_set_bit_lock(tag, &bm->word));
 160
 161         return tag;
 162 }
 163
 164 /*
 165  * Straight forward bitmap tag implementation, where each bit is a tag
 166  * (cleared == free, and set == busy). The small twist is using per-cpu
 167  * last_tag caches, which blk-mq stores in the blk_mq_ctx software queue
 168  * contexts. This enables us to drastically limit the space searched,
 169  * without dirtying an extra shared cacheline like we would if we stored
 170  * the cache value inside the shared blk_mq_bitmap_tags structure. On top
 171  * of that, each word of tags is in a separate cacheline. This means that
 172  * multiple users will tend to stick to different cachelines, at least
 173  * until the map is exhausted.
 174  */
 175 static int __bt_get(struct blk_mq_hw_ctx *hctx, struct blk_mq_bitmap_tags *bt,
 176                     unsigned int *tag_cache)
 177 {
 178         unsigned int last_tag, org_last_tag;
 179         int index, i, tag;
 180
 181         if (!hctx_may_queue(hctx, bt))
 182                 return -1;
 183
 184         last_tag = org_last_tag = *tag_cache;
 185         index = TAG_TO_INDEX(bt, last_tag);
 186
 187         for (i = 0; i < bt->map_nr; i++) {
 188                 tag = __bt_get_word(&bt->map[index], TAG_TO_BIT(bt, last_tag));
 189                 if (tag != -1) {
 190                         tag += (index << bt->bits_per_word);
 191                         goto done;
 192                 }
 193
 194                 last_tag = 0;
 195                 if (++index >= bt->map_nr)
 196                         index = 0;
 197         }
 198
 199         *tag_cache = 0;
 200         return -1;
 201
 202         /*
 203          * Only update the cache from the allocation path, if we ended
 204          * up using the specific cached tag.
 205          */
 206 done:
 207         if (tag == org_last_tag) {
 208                 last_tag = tag + 1;
 209                 if (last_tag >= bt->depth - 1)
 210                         last_tag = 0;
 211
 212                 *tag_cache = last_tag;
 213         }
 214
 215         return tag;
 216 }
 217
 218 static struct bt_wait_state *bt_wait_ptr(struct blk_mq_bitmap_tags *bt,
 219                                          struct blk_mq_hw_ctx *hctx)
 220 {
 221         struct bt_wait_state *bs;
 222         int wait_index;
 223
 224         if (!hctx)
 225                 return &bt->bs[0];
 226
 227         wait_index = atomic_read(&hctx->wait_index);
 228         bs = &bt->bs[wait_index];
 229         bt_index_atomic_inc(&hctx->wait_index);
 230         return bs;
 231 }
 232
 233 static int bt_get(struct blk_mq_alloc_data *data,
 234                 struct blk_mq_bitmap_tags *bt,
 235                 struct blk_mq_hw_ctx *hctx,
 236                 unsigned int *last_tag)
 237 {
 238         struct bt_wait_state *bs;
 239         DEFINE_WAIT(wait);
 240         int tag;
 241
 242         tag = __bt_get(hctx, bt, last_tag);
 243         if (tag != -1)
 244                 return tag;
 245
 246         if (!(data->gfp & __GFP_WAIT))
 247                 return -1;
 248
 249         bs = bt_wait_ptr(bt, hctx);
 250         do {
 251                 bool was_empty;
 252
 253                 was_empty = list_empty(&wait.task_list);
 254                 prepare_to_wait(&bs->wait, &wait, TASK_UNINTERRUPTIBLE);
 255
 256                 tag = __bt_get(hctx, bt, last_tag);
 257                 if (tag != -1)
 258                         break;
 259
 260                 if (was_empty)
 261                         atomic_set(&bs->wait_cnt, bt->wake_cnt);
 262
 263                 blk_mq_put_ctx(data->ctx);
 264
 265                 io_schedule();
 266
 267                 data->ctx = blk_mq_get_ctx(data->q);
 268                 data->hctx = data->q->mq_ops->map_queue(data->q,
 269                                 data->ctx->cpu);
 270                 if (data->reserved) {
 271                         bt = &data->hctx->tags->breserved_tags;
 272                 } else {
 273                         last_tag = &data->ctx->last_tag;
 274                         hctx = data->hctx;
 275                         bt = &hctx->tags->bitmap_tags;
 276                 }
 277                 finish_wait(&bs->wait, &wait);
 278                 bs = bt_wait_ptr(bt, hctx);
 279         } while (1);
 280
 281         finish_wait(&bs->wait, &wait);
 282         return tag;
 283 }
 284
 285 static unsigned int __blk_mq_get_tag(struct blk_mq_alloc_data *data)
 286 {
 287         int tag;
 288
 289         tag = bt_get(data, &data->hctx->tags->bitmap_tags, data->hctx,
 290                         &data->ctx->last_tag);
 291         if (tag >= 0)
 292                 return tag + data->hctx->tags->nr_reserved_tags;
 293
 294         return BLK_MQ_TAG_FAIL;
 295 }
 296
 297 static unsigned int __blk_mq_get_reserved_tag(struct blk_mq_alloc_data *data)
 298 {
 299         int tag, zero = 0;
 300
 301         if (unlikely(!data->hctx->tags->nr_reserved_tags)) {
 302                 WARN_ON_ONCE(1);
 303                 return BLK_MQ_TAG_FAIL;
 304         }
 305
 306         tag = bt_get(data, &data->hctx->tags->breserved_tags, NULL, &zero);
 307         if (tag < 0)
 308                 return BLK_MQ_TAG_FAIL;
 309
 310         return tag;
 311 }
 312
 313 unsigned int blk_mq_get_tag(struct blk_mq_alloc_data *data)
 314 {
 315         if (!data->reserved)
 316                 return __blk_mq_get_tag(data);
 317
 318         return __blk_mq_get_reserved_tag(data);
 319 }
 320
 321 static struct bt_wait_state *bt_wake_ptr(struct blk_mq_bitmap_tags *bt)
 322 {
 323         int i, wake_index;
 324
 325         wake_index = atomic_read(&bt->wake_index);
 326         for (i = 0; i < BT_WAIT_QUEUES; i++) {
 327                 struct bt_wait_state *bs = &bt->bs[wake_index];
 328
 329                 if (waitqueue_active(&bs->wait)) {
 330                         int o = atomic_read(&bt->wake_index);
 331                         if (wake_index != o)
 332                                 atomic_cmpxchg(&bt->wake_index, o, wake_index);
 333
 334                         return bs;
 335                 }
 336
 337                 wake_index = bt_index_inc(wake_index);
 338         }
 339
 340         return NULL;
 341 }
 342
 343 static void bt_clear_tag(struct blk_mq_bitmap_tags *bt, unsigned int tag)
 344 {
 345         const int index = TAG_TO_INDEX(bt, tag);
 346         struct bt_wait_state *bs;
 347         int wait_cnt;
 348
 349         /*
 350          * The unlock memory barrier need to order access to req in free
 351          * path and clearing tag bit
 352          */
 353         clear_bit_unlock(TAG_TO_BIT(bt, tag), &bt->map[index].word);
 354
 355         bs = bt_wake_ptr(bt);
 356         if (!bs)
 357                 return;
 358
 359         wait_cnt = atomic_dec_return(&bs->wait_cnt);
 360         if (wait_cnt == 0) {
 361 wake:
 362                 atomic_add(bt->wake_cnt, &bs->wait_cnt);
 363                 bt_index_atomic_inc(&bt->wake_index);
 364                 wake_up(&bs->wait);
 365         } else if (wait_cnt < 0) {
 366                 wait_cnt = atomic_inc_return(&bs->wait_cnt);
 367                 if (!wait_cnt)
 368                         goto wake;
 369         }
 370 }
 371
 372 static void __blk_mq_put_tag(struct blk_mq_tags *tags, unsigned int tag)
 373 {
 374         BUG_ON(tag >= tags->nr_tags);
 375
 376         bt_clear_tag(&tags->bitmap_tags, tag);
 377 }
 378
 379 static void __blk_mq_put_reserved_tag(struct blk_mq_tags *tags,
 380                                       unsigned int tag)
 381 {
 382         BUG_ON(tag >= tags->nr_reserved_tags);
 383
 384         bt_clear_tag(&tags->breserved_tags, tag);
 385 }
 386
 387 void blk_mq_put_tag(struct blk_mq_hw_ctx *hctx, unsigned int tag,
 388                     unsigned int *last_tag)
 389 {
 390         struct blk_mq_tags *tags = hctx->tags;
 391
 392         if (tag >= tags->nr_reserved_tags) {
 393                 const int real_tag = tag - tags->nr_reserved_tags;
 394
 395                 __blk_mq_put_tag(tags, real_tag);
 396                 *last_tag = real_tag;
 397         } else
 398                 __blk_mq_put_reserved_tag(tags, tag);
 399 }
 400
 401 static void bt_for_each_free(struct blk_mq_bitmap_tags *bt,
 402                              unsigned long *free_map, unsigned int off)
 403 {
 404         int i;
 405
 406         for (i = 0; i < bt->map_nr; i++) {
 407                 struct blk_align_bitmap *bm = &bt->map[i];
 408                 int bit = 0;
 409
 410                 do {
 411                         bit = find_next_zero_bit(&bm->word, bm->depth, bit);
 412                         if (bit >= bm->depth)
 413                                 break;
 414
 415                         __set_bit(bit + off, free_map);
 416                         bit++;
 417                 } while (1);
 418
 419                 off += (1 << bt->bits_per_word);
 420         }
 421 }
 422
 423 void blk_mq_tag_busy_iter(struct blk_mq_tags *tags,
 424                           void (*fn)(void *, unsigned long *), void *data)
 425 {
 426         unsigned long *tag_map;
 427         size_t map_size;
 428
 429         map_size = ALIGN(tags->nr_tags, BITS_PER_LONG) / BITS_PER_LONG;
 430         tag_map = kzalloc(map_size * sizeof(unsigned long), GFP_ATOMIC);
 431         if (!tag_map)
 432                 return;
 433
 434         bt_for_each_free(&tags->bitmap_tags, tag_map, tags->nr_reserved_tags);
 435         if (tags->nr_reserved_tags)
 436                 bt_for_each_free(&tags->breserved_tags, tag_map, 0);
 437
 438         fn(data, tag_map);
 439         kfree(tag_map);
 440 }
 441 EXPORT_SYMBOL(blk_mq_tag_busy_iter);
 442
 443 static unsigned int bt_unused_tags(struct blk_mq_bitmap_tags *bt)
 444 {
 445         unsigned int i, used;
 446
 447         for (i = 0, used = 0; i < bt->map_nr; i++) {
 448                 struct blk_align_bitmap *bm = &bt->map[i];
 449
 450                 used += bitmap_weight(&bm->word, bm->depth);
 451         }
 452
 453         return bt->depth - used;
 454 }
 455
 456 static void bt_update_count(struct blk_mq_bitmap_tags *bt,
 457                             unsigned int depth)
 458 {
 459         unsigned int tags_per_word = 1U << bt->bits_per_word;
 460         unsigned int map_depth = depth;
 461
 462         if (depth) {
 463                 int i;
 464
 465                 for (i = 0; i < bt->map_nr; i++) {
 466                         bt->map[i].depth = min(map_depth, tags_per_word);
 467                         map_depth -= bt->map[i].depth;
 468                 }
 469         }
 470
 471         bt->wake_cnt = BT_WAIT_BATCH;
 472         if (bt->wake_cnt > depth / 4)
 473                 bt->wake_cnt = max(1U, depth / 4);
 474
 475         bt->depth = depth;
 476 }
 477
 478 static int bt_alloc(struct blk_mq_bitmap_tags *bt, unsigned int depth,
 479                         int node, bool reserved)
 480 {
 481         int i;
 482
 483         bt->bits_per_word = ilog2(BITS_PER_LONG);
 484
 485         /*
 486          * Depth can be zero for reserved tags, that's not a failure
 487          * condition.
 488          */
 489         if (depth) {
 490                 unsigned int nr, tags_per_word;
 491
 492                 tags_per_word = (1 << bt->bits_per_word);
 493
 494                 /*
 495                  * If the tag space is small, shrink the number of tags
 496                  * per word so we spread over a few cachelines, at least.
 497                  * If less than 4 tags, just forget about it, it's not
 498                  * going to work optimally anyway.
 499                  */
 500                 if (depth >= 4) {
 501                         while (tags_per_word * 4 > depth) {
 502                                 bt->bits_per_word--;
 503                                 tags_per_word = (1 << bt->bits_per_word);
 504                         }
 505                 }
 506
 507                 nr = ALIGN(depth, tags_per_word) / tags_per_word;
 508                 bt->map = kzalloc_node(nr * sizeof(struct blk_align_bitmap),
 509                                                 GFP_KERNEL, node);
 510                 if (!bt->map)
 511                         return -ENOMEM;
 512
 513                 bt->map_nr = nr;
 514         }
 515
 516         bt->bs = kzalloc(BT_WAIT_QUEUES * sizeof(*bt->bs), GFP_KERNEL);
 517         if (!bt->bs) {
 518                 kfree(bt->map);
 519                 return -ENOMEM;
 520         }
 521
 522         for (i = 0; i < BT_WAIT_QUEUES; i++)
 523                 init_waitqueue_head(&bt->bs[i].wait);
 524
 525         bt_update_count(bt, depth);
 526         return 0;
 527 }
 528
 529 static void bt_free(struct blk_mq_bitmap_tags *bt)
 530 {
 531         kfree(bt->map);
 532         kfree(bt->bs);
 533 }
 534
 535 static struct blk_mq_tags *blk_mq_init_bitmap_tags(struct blk_mq_tags *tags,
 536                                                    int node)
 537 {
 538         unsigned int depth = tags->nr_tags - tags->nr_reserved_tags;
 539
 540         if (bt_alloc(&tags->bitmap_tags, depth, node, false))
 541                 goto enomem;
 542         if (bt_alloc(&tags->breserved_tags, tags->nr_reserved_tags, node, true))
 543                 goto enomem;
 544
 545         return tags;
 546 enomem:
 547         bt_free(&tags->bitmap_tags);
 548         kfree(tags);
 549         return NULL;
 550 }
 551
 552 struct blk_mq_tags *blk_mq_init_tags(unsigned int total_tags,
 553                                      unsigned int reserved_tags, int node)
 554 {
 555         struct blk_mq_tags *tags;
 556
 557         if (total_tags > BLK_MQ_TAG_MAX) {
 558                 pr_err("blk-mq: tag depth too large\n");
 559                 return NULL;
 560         }
 561
 562         tags = kzalloc_node(sizeof(*tags), GFP_KERNEL, node);
 563         if (!tags)
 564                 return NULL;
 565
 566         tags->nr_tags = total_tags;
 567         tags->nr_reserved_tags = reserved_tags;
 568
 569         return blk_mq_init_bitmap_tags(tags, node);
 570 }
 571
 572 void blk_mq_free_tags(struct blk_mq_tags *tags)
 573 {
 574         bt_free(&tags->bitmap_tags);
 575         bt_free(&tags->breserved_tags);
 576         kfree(tags);
 577 }
 578
 579 void blk_mq_tag_init_last_tag(struct blk_mq_tags *tags, unsigned int *tag)
 580 {
 581         unsigned int depth = tags->nr_tags - tags->nr_reserved_tags;
 582
 583         *tag = prandom_u32() % depth;
 584 }
 585
 586 int blk_mq_tag_update_depth(struct blk_mq_tags *tags, unsigned int tdepth)
 587 {
 588         tdepth -= tags->nr_reserved_tags;
 589         if (tdepth > tags->nr_tags)
 590                 return -EINVAL;
 591
 592         /*
 593          * Don't need (or can't) update reserved tags here, they remain
 594          * static and should never need resizing.
 595          */
 596         bt_update_count(&tags->bitmap_tags, tdepth);
 597         blk_mq_tag_wakeup_all(tags);
 598         return 0;
 599 }
 600
 601 ssize_t blk_mq_tag_sysfs_show(struct blk_mq_tags *tags, char *page)
 602 {
 603         char *orig_page = page;
 604         unsigned int free, res;
 605
 606         if (!tags)
 607                 return 0;
 608
 609         page += sprintf(page, "nr_tags=%u, reserved_tags=%u, "
 610                         "bits_per_word=%u\n",
 611                         tags->nr_tags, tags->nr_reserved_tags,
 612                         tags->bitmap_tags.bits_per_word);
 613
 614         free = bt_unused_tags(&tags->bitmap_tags);
 615         res = bt_unused_tags(&tags->breserved_tags);
 616
 617         page += sprintf(page, "nr_free=%u, nr_reserved=%u\n", free, res);
 618         page += sprintf(page, "active_queues=%u\n", atomic_read(&tags->active_queues));
 619
 620         return page - orig_page;
 621 }