2 * Copyright (C) 2016 Red Hat, Inc. All rights reserved.
4 * This file is released under the GPL.
10 #include <linux/elevator.h> /* for rq_end_sector() */
11 #include <linux/blk-mq.h>
13 #define DM_MSG_PREFIX "core-rq"
15 #define DM_MQ_NR_HW_QUEUES 1
16 #define DM_MQ_QUEUE_DEPTH 2048
17 static unsigned dm_mq_nr_hw_queues = DM_MQ_NR_HW_QUEUES;
18 static unsigned dm_mq_queue_depth = DM_MQ_QUEUE_DEPTH;
21 * Request-based DM's mempools' reserved IOs set by the user.
23 #define RESERVED_REQUEST_BASED_IOS 256
24 static unsigned reserved_rq_based_ios = RESERVED_REQUEST_BASED_IOS;
26 static bool use_blk_mq = IS_ENABLED(CONFIG_DM_MQ_DEFAULT);
28 bool dm_use_blk_mq_default(void)
33 bool dm_use_blk_mq(struct mapped_device *md)
35 return md->use_blk_mq;
37 EXPORT_SYMBOL_GPL(dm_use_blk_mq);
39 unsigned dm_get_reserved_rq_based_ios(void)
41 return __dm_get_module_param(&reserved_rq_based_ios,
42 RESERVED_REQUEST_BASED_IOS, DM_RESERVED_MAX_IOS);
44 EXPORT_SYMBOL_GPL(dm_get_reserved_rq_based_ios);
46 static unsigned dm_get_blk_mq_nr_hw_queues(void)
48 return __dm_get_module_param(&dm_mq_nr_hw_queues, 1, 32);
51 static unsigned dm_get_blk_mq_queue_depth(void)
53 return __dm_get_module_param(&dm_mq_queue_depth,
54 DM_MQ_QUEUE_DEPTH, BLK_MQ_MAX_DEPTH);
57 int dm_request_based(struct mapped_device *md)
59 return blk_queue_stackable(md->queue);
62 static void dm_old_start_queue(struct request_queue *q)
66 spin_lock_irqsave(q->queue_lock, flags);
67 if (blk_queue_stopped(q))
69 spin_unlock_irqrestore(q->queue_lock, flags);
72 static void dm_mq_start_queue(struct request_queue *q)
74 blk_mq_unquiesce_queue(q);
75 blk_mq_kick_requeue_list(q);
78 void dm_start_queue(struct request_queue *q)
81 dm_old_start_queue(q);
86 static void dm_old_stop_queue(struct request_queue *q)
90 spin_lock_irqsave(q->queue_lock, flags);
91 if (!blk_queue_stopped(q))
93 spin_unlock_irqrestore(q->queue_lock, flags);
96 static void dm_mq_stop_queue(struct request_queue *q)
98 blk_mq_quiesce_queue(q);
101 void dm_stop_queue(struct request_queue *q)
104 dm_old_stop_queue(q);
110 * Partial completion handling for request-based dm
112 static void end_clone_bio(struct bio *clone)
114 struct dm_rq_clone_bio_info *info =
115 container_of(clone, struct dm_rq_clone_bio_info, clone);
116 struct dm_rq_target_io *tio = info->tio;
117 unsigned int nr_bytes = info->orig->bi_iter.bi_size;
118 blk_status_t error = clone->bi_status;
119 bool is_last = !clone->bi_next;
125 * An error has already been detected on the request.
126 * Once error occurred, just let clone->end_io() handle
132 * Don't notice the error to the upper layer yet.
133 * The error handling decision is made by the target driver,
134 * when the request is completed.
141 * I/O for the bio successfully completed.
142 * Notice the data completion to the upper layer.
144 tio->completed += nr_bytes;
147 * Update the original request.
148 * Do not use blk_end_request() here, because it may complete
149 * the original request before the clone, and break the ordering.
153 blk_update_request(tio->orig, BLK_STS_OK, tio->completed);
156 static struct dm_rq_target_io *tio_from_request(struct request *rq)
158 return blk_mq_rq_to_pdu(rq);
161 static void rq_end_stats(struct mapped_device *md, struct request *orig)
163 if (unlikely(dm_stats_used(&md->stats))) {
164 struct dm_rq_target_io *tio = tio_from_request(orig);
165 tio->duration_jiffies = jiffies - tio->duration_jiffies;
166 dm_stats_account_io(&md->stats, rq_data_dir(orig),
167 blk_rq_pos(orig), tio->n_sectors, true,
168 tio->duration_jiffies, &tio->stats_aux);
173 * Don't touch any member of the md after calling this function because
174 * the md may be freed in dm_put() at the end of this function.
175 * Or do dm_get() before calling this function and dm_put() later.
177 static void rq_completed(struct mapped_device *md, int rw, bool run_queue)
179 struct request_queue *q = md->queue;
182 atomic_dec(&md->pending[rw]);
184 /* nudge anyone waiting on suspend queue */
185 if (!md_in_flight(md))
189 * Run this off this callpath, as drivers could invoke end_io while
190 * inside their request_fn (and holding the queue lock). Calling
191 * back into ->request_fn() could deadlock attempting to grab the
194 if (!q->mq_ops && run_queue) {
195 spin_lock_irqsave(q->queue_lock, flags);
196 blk_run_queue_async(q);
197 spin_unlock_irqrestore(q->queue_lock, flags);
201 * dm_put() must be at the end of this function. See the comment above
207 * Complete the clone and the original request.
208 * Must be called without clone's queue lock held,
209 * see end_clone_request() for more details.
211 static void dm_end_request(struct request *clone, blk_status_t error)
213 int rw = rq_data_dir(clone);
214 struct dm_rq_target_io *tio = clone->end_io_data;
215 struct mapped_device *md = tio->md;
216 struct request *rq = tio->orig;
218 blk_rq_unprep_clone(clone);
219 tio->ti->type->release_clone_rq(clone);
221 rq_end_stats(md, rq);
223 blk_end_request_all(rq, error);
225 blk_mq_end_request(rq, error);
226 rq_completed(md, rw, true);
230 * Requeue the original request of a clone.
232 static void dm_old_requeue_request(struct request *rq, unsigned long delay_ms)
234 struct request_queue *q = rq->q;
237 spin_lock_irqsave(q->queue_lock, flags);
238 blk_requeue_request(q, rq);
239 blk_delay_queue(q, delay_ms);
240 spin_unlock_irqrestore(q->queue_lock, flags);
243 static void __dm_mq_kick_requeue_list(struct request_queue *q, unsigned long msecs)
245 blk_mq_delay_kick_requeue_list(q, msecs);
248 void dm_mq_kick_requeue_list(struct mapped_device *md)
250 __dm_mq_kick_requeue_list(dm_get_md_queue(md), 0);
252 EXPORT_SYMBOL(dm_mq_kick_requeue_list);
254 static void dm_mq_delay_requeue_request(struct request *rq, unsigned long msecs)
256 blk_mq_requeue_request(rq, false);
257 __dm_mq_kick_requeue_list(rq->q, msecs);
260 static void dm_requeue_original_request(struct dm_rq_target_io *tio, bool delay_requeue)
262 struct mapped_device *md = tio->md;
263 struct request *rq = tio->orig;
264 int rw = rq_data_dir(rq);
265 unsigned long delay_ms = delay_requeue ? 100 : 0;
267 rq_end_stats(md, rq);
269 blk_rq_unprep_clone(tio->clone);
270 tio->ti->type->release_clone_rq(tio->clone);
274 dm_old_requeue_request(rq, delay_ms);
276 dm_mq_delay_requeue_request(rq, delay_ms);
278 rq_completed(md, rw, false);
281 static void dm_done(struct request *clone, blk_status_t error, bool mapped)
283 int r = DM_ENDIO_DONE;
284 struct dm_rq_target_io *tio = clone->end_io_data;
285 dm_request_endio_fn rq_end_io = NULL;
288 rq_end_io = tio->ti->type->rq_end_io;
290 if (mapped && rq_end_io)
291 r = rq_end_io(tio->ti, clone, error, &tio->info);
294 if (unlikely(error == BLK_STS_TARGET)) {
295 if (req_op(clone) == REQ_OP_WRITE_SAME &&
296 !clone->q->limits.max_write_same_sectors)
297 disable_write_same(tio->md);
298 if (req_op(clone) == REQ_OP_WRITE_ZEROES &&
299 !clone->q->limits.max_write_zeroes_sectors)
300 disable_write_zeroes(tio->md);
305 /* The target wants to complete the I/O */
306 dm_end_request(clone, error);
308 case DM_ENDIO_INCOMPLETE:
309 /* The target will handle the I/O */
311 case DM_ENDIO_REQUEUE:
312 /* The target wants to requeue the I/O */
313 dm_requeue_original_request(tio, false);
316 DMWARN("unimplemented target endio return value: %d", r);
322 * Request completion handler for request-based dm
324 static void dm_softirq_done(struct request *rq)
327 struct dm_rq_target_io *tio = tio_from_request(rq);
328 struct request *clone = tio->clone;
332 struct mapped_device *md = tio->md;
334 rq_end_stats(md, rq);
335 rw = rq_data_dir(rq);
337 blk_end_request_all(rq, tio->error);
339 blk_mq_end_request(rq, tio->error);
340 rq_completed(md, rw, false);
344 if (rq->rq_flags & RQF_FAILED)
347 dm_done(clone, tio->error, mapped);
351 * Complete the clone and the original request with the error status
352 * through softirq context.
354 static void dm_complete_request(struct request *rq, blk_status_t error)
356 struct dm_rq_target_io *tio = tio_from_request(rq);
360 blk_complete_request(rq);
362 blk_mq_complete_request(rq);
366 * Complete the not-mapped clone and the original request with the error status
367 * through softirq context.
368 * Target's rq_end_io() function isn't called.
369 * This may be used when the target's map_rq() or clone_and_map_rq() functions fail.
371 static void dm_kill_unmapped_request(struct request *rq, blk_status_t error)
373 rq->rq_flags |= RQF_FAILED;
374 dm_complete_request(rq, error);
378 * Called with the clone's queue lock held (in the case of .request_fn)
380 static void end_clone_request(struct request *clone, blk_status_t error)
382 struct dm_rq_target_io *tio = clone->end_io_data;
385 * Actual request completion is done in a softirq context which doesn't
386 * hold the clone's queue lock. Otherwise, deadlock could occur because:
387 * - another request may be submitted by the upper level driver
388 * of the stacking during the completion
389 * - the submission which requires queue lock may be done
390 * against this clone's queue
392 dm_complete_request(tio->orig, error);
395 static void dm_dispatch_clone_request(struct request *clone, struct request *rq)
399 if (blk_queue_io_stat(clone->q))
400 clone->rq_flags |= RQF_IO_STAT;
402 clone->start_time = jiffies;
403 r = blk_insert_cloned_request(clone->q, clone);
405 /* must complete clone in terms of original request */
406 dm_complete_request(rq, r);
409 static int dm_rq_bio_constructor(struct bio *bio, struct bio *bio_orig,
412 struct dm_rq_target_io *tio = data;
413 struct dm_rq_clone_bio_info *info =
414 container_of(bio, struct dm_rq_clone_bio_info, clone);
416 info->orig = bio_orig;
418 bio->bi_end_io = end_clone_bio;
423 static int setup_clone(struct request *clone, struct request *rq,
424 struct dm_rq_target_io *tio, gfp_t gfp_mask)
428 r = blk_rq_prep_clone(clone, rq, tio->md->bs, gfp_mask,
429 dm_rq_bio_constructor, tio);
433 clone->end_io = end_clone_request;
434 clone->end_io_data = tio;
441 static void map_tio_request(struct kthread_work *work);
443 static void init_tio(struct dm_rq_target_io *tio, struct request *rq,
444 struct mapped_device *md)
453 * Avoid initializing info for blk-mq; it passes
454 * target-specific data through info.ptr
455 * (see: dm_mq_init_request)
457 if (!md->init_tio_pdu)
458 memset(&tio->info, 0, sizeof(tio->info));
459 if (md->kworker_task)
460 kthread_init_work(&tio->work, map_tio_request);
465 * DM_MAPIO_* : the request has been processed as indicated
466 * DM_MAPIO_REQUEUE : the original request needs to be immediately requeued
467 * < 0 : the request was completed due to failure
469 static int map_request(struct dm_rq_target_io *tio)
472 struct dm_target *ti = tio->ti;
473 struct mapped_device *md = tio->md;
474 struct request *rq = tio->orig;
475 struct request *clone = NULL;
477 r = ti->type->clone_and_map_rq(ti, rq, &tio->info, &clone);
479 case DM_MAPIO_SUBMITTED:
480 /* The target has taken the I/O to submit by itself later */
482 case DM_MAPIO_REMAPPED:
483 if (setup_clone(clone, rq, tio, GFP_ATOMIC)) {
485 ti->type->release_clone_rq(clone);
486 return DM_MAPIO_REQUEUE;
489 /* The target has remapped the I/O so dispatch it */
490 trace_block_rq_remap(clone->q, clone, disk_devt(dm_disk(md)),
492 dm_dispatch_clone_request(clone, rq);
494 case DM_MAPIO_REQUEUE:
495 /* The target wants to requeue the I/O */
497 case DM_MAPIO_DELAY_REQUEUE:
498 /* The target wants to requeue the I/O after a delay */
499 dm_requeue_original_request(tio, true);
502 /* The target wants to complete the I/O */
503 dm_kill_unmapped_request(rq, BLK_STS_IOERR);
506 DMWARN("unimplemented target map return value: %d", r);
513 static void dm_start_request(struct mapped_device *md, struct request *orig)
515 if (!orig->q->mq_ops)
516 blk_start_request(orig);
518 blk_mq_start_request(orig);
519 atomic_inc(&md->pending[rq_data_dir(orig)]);
521 if (md->seq_rq_merge_deadline_usecs) {
522 md->last_rq_pos = rq_end_sector(orig);
523 md->last_rq_rw = rq_data_dir(orig);
524 md->last_rq_start_time = ktime_get();
527 if (unlikely(dm_stats_used(&md->stats))) {
528 struct dm_rq_target_io *tio = tio_from_request(orig);
529 tio->duration_jiffies = jiffies;
530 tio->n_sectors = blk_rq_sectors(orig);
531 dm_stats_account_io(&md->stats, rq_data_dir(orig),
532 blk_rq_pos(orig), tio->n_sectors, false, 0,
537 * Hold the md reference here for the in-flight I/O.
538 * We can't rely on the reference count by device opener,
539 * because the device may be closed during the request completion
540 * when all bios are completed.
541 * See the comment in rq_completed() too.
546 static int __dm_rq_init_rq(struct mapped_device *md, struct request *rq)
548 struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
551 * Must initialize md member of tio, otherwise it won't
552 * be available in dm_mq_queue_rq.
556 if (md->init_tio_pdu) {
557 /* target-specific per-io data is immediately after the tio */
558 tio->info.ptr = tio + 1;
564 static int dm_rq_init_rq(struct request_queue *q, struct request *rq, gfp_t gfp)
566 return __dm_rq_init_rq(q->rq_alloc_data, rq);
569 static void map_tio_request(struct kthread_work *work)
571 struct dm_rq_target_io *tio = container_of(work, struct dm_rq_target_io, work);
573 if (map_request(tio) == DM_MAPIO_REQUEUE)
574 dm_requeue_original_request(tio, false);
577 ssize_t dm_attr_rq_based_seq_io_merge_deadline_show(struct mapped_device *md, char *buf)
579 return sprintf(buf, "%u\n", md->seq_rq_merge_deadline_usecs);
582 #define MAX_SEQ_RQ_MERGE_DEADLINE_USECS 100000
584 ssize_t dm_attr_rq_based_seq_io_merge_deadline_store(struct mapped_device *md,
585 const char *buf, size_t count)
589 if (dm_get_md_type(md) != DM_TYPE_REQUEST_BASED)
592 if (kstrtouint(buf, 10, &deadline))
595 if (deadline > MAX_SEQ_RQ_MERGE_DEADLINE_USECS)
596 deadline = MAX_SEQ_RQ_MERGE_DEADLINE_USECS;
598 md->seq_rq_merge_deadline_usecs = deadline;
603 static bool dm_old_request_peeked_before_merge_deadline(struct mapped_device *md)
607 if (!md->seq_rq_merge_deadline_usecs)
610 kt_deadline = ns_to_ktime((u64)md->seq_rq_merge_deadline_usecs * NSEC_PER_USEC);
611 kt_deadline = ktime_add_safe(md->last_rq_start_time, kt_deadline);
613 return !ktime_after(ktime_get(), kt_deadline);
617 * q->request_fn for old request-based dm.
618 * Called with the queue lock held.
620 static void dm_old_request_fn(struct request_queue *q)
622 struct mapped_device *md = q->queuedata;
623 struct dm_target *ti = md->immutable_target;
625 struct dm_rq_target_io *tio;
630 struct dm_table *map = dm_get_live_table(md, &srcu_idx);
632 if (unlikely(!map)) {
633 dm_put_live_table(md, srcu_idx);
636 ti = dm_table_find_target(map, pos);
637 dm_put_live_table(md, srcu_idx);
641 * For suspend, check blk_queue_stopped() and increment
642 * ->pending within a single queue_lock not to increment the
643 * number of in-flight I/Os after the queue is stopped in
646 while (!blk_queue_stopped(q)) {
647 rq = blk_peek_request(q);
651 /* always use block 0 to find the target for flushes for now */
653 if (req_op(rq) != REQ_OP_FLUSH)
654 pos = blk_rq_pos(rq);
656 if ((dm_old_request_peeked_before_merge_deadline(md) &&
657 md_in_flight(md) && rq->bio && !bio_multiple_segments(rq->bio) &&
658 md->last_rq_pos == pos && md->last_rq_rw == rq_data_dir(rq)) ||
659 (ti->type->busy && ti->type->busy(ti))) {
660 blk_delay_queue(q, 10);
664 dm_start_request(md, rq);
666 tio = tio_from_request(rq);
667 init_tio(tio, rq, md);
668 /* Establish tio->ti before queuing work (map_tio_request) */
670 kthread_queue_work(&md->kworker, &tio->work);
671 BUG_ON(!irqs_disabled());
676 * Fully initialize a .request_fn request-based queue.
678 int dm_old_init_request_queue(struct mapped_device *md, struct dm_table *t)
680 struct dm_target *immutable_tgt;
682 /* Fully initialize the queue */
683 md->queue->cmd_size = sizeof(struct dm_rq_target_io);
684 md->queue->rq_alloc_data = md;
685 md->queue->request_fn = dm_old_request_fn;
686 md->queue->init_rq_fn = dm_rq_init_rq;
688 immutable_tgt = dm_table_get_immutable_target(t);
689 if (immutable_tgt && immutable_tgt->per_io_data_size) {
690 /* any target-specific per-io data is immediately after the tio */
691 md->queue->cmd_size += immutable_tgt->per_io_data_size;
692 md->init_tio_pdu = true;
694 if (blk_init_allocated_queue(md->queue) < 0)
697 /* disable dm_old_request_fn's merge heuristic by default */
698 md->seq_rq_merge_deadline_usecs = 0;
700 dm_init_normal_md_queue(md);
701 blk_queue_softirq_done(md->queue, dm_softirq_done);
703 /* Initialize the request-based DM worker thread */
704 kthread_init_worker(&md->kworker);
705 md->kworker_task = kthread_run(kthread_worker_fn, &md->kworker,
706 "kdmwork-%s", dm_device_name(md));
707 if (IS_ERR(md->kworker_task)) {
708 int error = PTR_ERR(md->kworker_task);
709 md->kworker_task = NULL;
713 elv_register_queue(md->queue);
718 static int dm_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
719 unsigned int hctx_idx, unsigned int numa_node)
721 return __dm_rq_init_rq(set->driver_data, rq);
724 static blk_status_t dm_mq_queue_rq(struct blk_mq_hw_ctx *hctx,
725 const struct blk_mq_queue_data *bd)
727 struct request *rq = bd->rq;
728 struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
729 struct mapped_device *md = tio->md;
730 struct dm_target *ti = md->immutable_target;
734 struct dm_table *map = dm_get_live_table(md, &srcu_idx);
736 ti = dm_table_find_target(map, 0);
737 dm_put_live_table(md, srcu_idx);
740 if (ti->type->busy && ti->type->busy(ti))
741 return BLK_STS_RESOURCE;
743 dm_start_request(md, rq);
745 /* Init tio using md established in .init_request */
746 init_tio(tio, rq, md);
749 * Establish tio->ti before calling map_request().
753 /* Direct call is fine since .queue_rq allows allocations */
754 if (map_request(tio) == DM_MAPIO_REQUEUE) {
755 /* Undo dm_start_request() before requeuing */
756 rq_end_stats(md, rq);
757 rq_completed(md, rq_data_dir(rq), false);
758 blk_mq_delay_run_hw_queue(hctx, 100/*ms*/);
759 return BLK_STS_RESOURCE;
765 static const struct blk_mq_ops dm_mq_ops = {
766 .queue_rq = dm_mq_queue_rq,
767 .complete = dm_softirq_done,
768 .init_request = dm_mq_init_request,
771 int dm_mq_init_request_queue(struct mapped_device *md, struct dm_table *t)
773 struct request_queue *q;
774 struct dm_target *immutable_tgt;
777 if (!dm_table_all_blk_mq_devices(t)) {
778 DMERR("request-based dm-mq may only be stacked on blk-mq device(s)");
782 md->tag_set = kzalloc_node(sizeof(struct blk_mq_tag_set), GFP_KERNEL, md->numa_node_id);
786 md->tag_set->ops = &dm_mq_ops;
787 md->tag_set->queue_depth = dm_get_blk_mq_queue_depth();
788 md->tag_set->numa_node = md->numa_node_id;
789 md->tag_set->flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
790 md->tag_set->nr_hw_queues = dm_get_blk_mq_nr_hw_queues();
791 md->tag_set->driver_data = md;
793 md->tag_set->cmd_size = sizeof(struct dm_rq_target_io);
794 immutable_tgt = dm_table_get_immutable_target(t);
795 if (immutable_tgt && immutable_tgt->per_io_data_size) {
796 /* any target-specific per-io data is immediately after the tio */
797 md->tag_set->cmd_size += immutable_tgt->per_io_data_size;
798 md->init_tio_pdu = true;
801 err = blk_mq_alloc_tag_set(md->tag_set);
803 goto out_kfree_tag_set;
805 q = blk_mq_init_allocated_queue(md->tag_set, md->queue);
810 dm_init_md_queue(md);
812 /* backfill 'mq' sysfs registration normally done in blk_register_queue */
813 err = blk_mq_register_dev(disk_to_dev(md->disk), q);
815 goto out_cleanup_queue;
820 blk_cleanup_queue(q);
822 blk_mq_free_tag_set(md->tag_set);
830 void dm_mq_cleanup_mapped_device(struct mapped_device *md)
833 blk_mq_free_tag_set(md->tag_set);
839 module_param(reserved_rq_based_ios, uint, S_IRUGO | S_IWUSR);
840 MODULE_PARM_DESC(reserved_rq_based_ios, "Reserved IOs in request-based mempools");
842 module_param(use_blk_mq, bool, S_IRUGO | S_IWUSR);
843 MODULE_PARM_DESC(use_blk_mq, "Use block multiqueue for request-based DM devices");
845 module_param(dm_mq_nr_hw_queues, uint, S_IRUGO | S_IWUSR);
846 MODULE_PARM_DESC(dm_mq_nr_hw_queues, "Number of hardware queues for request-based dm-mq devices");
848 module_param(dm_mq_queue_depth, uint, S_IRUGO | S_IWUSR);
849 MODULE_PARM_DESC(dm_mq_queue_depth, "Queue depth for request-based dm-mq devices");