2 * Copyright (C) 2002 Sistina Software (UK) Limited.
3 * Copyright (C) 2006 Red Hat GmbH
5 * This file is released under the GPL.
7 * Kcopyd provides a simple interface for copying an area of one
8 * block-device to one or more other block-devices, with an asynchronous
9 * completion notification.
12 #include <linux/types.h>
13 #include <linux/atomic.h>
14 #include <linux/blkdev.h>
16 #include <linux/init.h>
17 #include <linux/list.h>
18 #include <linux/mempool.h>
19 #include <linux/module.h>
20 #include <linux/pagemap.h>
21 #include <linux/slab.h>
22 #include <linux/vmalloc.h>
23 #include <linux/workqueue.h>
24 #include <linux/mutex.h>
25 #include <linux/delay.h>
26 #include <linux/device-mapper.h>
27 #include <linux/dm-kcopyd.h>
31 #define SUB_JOB_SIZE 128
34 #define RESERVE_PAGES (DIV_ROUND_UP(SUB_JOB_SIZE << SECTOR_SHIFT, PAGE_SIZE))
36 /*-----------------------------------------------------------------
37 * Each kcopyd client has its own little pool of preallocated
38 * pages for kcopyd io.
39 *---------------------------------------------------------------*/
40 struct dm_kcopyd_client
{
41 struct page_list
*pages
;
42 unsigned nr_reserved_pages
;
43 unsigned nr_free_pages
;
45 struct dm_io_client
*io_client
;
47 wait_queue_head_t destroyq
;
51 struct workqueue_struct
*kcopyd_wq
;
52 struct work_struct kcopyd_work
;
54 struct dm_kcopyd_throttle
*throttle
;
59 * We maintain three lists of jobs:
61 * i) jobs waiting for pages
62 * ii) jobs that have pages, and are waiting for the io to be issued.
63 * iii) jobs that have completed.
65 * All three of these are protected by job_lock.
68 struct list_head complete_jobs
;
69 struct list_head io_jobs
;
70 struct list_head pages_jobs
;
73 static struct page_list zero_page_list
;
75 static DEFINE_SPINLOCK(throttle_spinlock
);
78 * IO/IDLE accounting slowly decays after (1 << ACCOUNT_INTERVAL_SHIFT) period.
79 * When total_period >= (1 << ACCOUNT_INTERVAL_SHIFT) the counters are divided
82 #define ACCOUNT_INTERVAL_SHIFT SHIFT_HZ
85 * Sleep this number of milliseconds.
87 * The value was decided experimentally.
88 * Smaller values seem to cause an increased copy rate above the limit.
89 * The reason for this is unknown but possibly due to jiffies rounding errors
90 * or read/write cache inside the disk.
92 #define SLEEP_MSEC 100
95 * Maximum number of sleep events. There is a theoretical livelock if more
96 * kcopyd clients do work simultaneously which this limit avoids.
100 static void io_job_start(struct dm_kcopyd_throttle
*t
)
102 unsigned throttle
, now
, difference
;
109 spin_lock_irq(&throttle_spinlock
);
111 throttle
= READ_ONCE(t
->throttle
);
113 if (likely(throttle
>= 100))
117 difference
= now
- t
->last_jiffies
;
118 t
->last_jiffies
= now
;
120 t
->io_period
+= difference
;
121 t
->total_period
+= difference
;
124 * Maintain sane values if we got a temporary overflow.
126 if (unlikely(t
->io_period
> t
->total_period
))
127 t
->io_period
= t
->total_period
;
129 if (unlikely(t
->total_period
>= (1 << ACCOUNT_INTERVAL_SHIFT
))) {
130 int shift
= fls(t
->total_period
>> ACCOUNT_INTERVAL_SHIFT
);
131 t
->total_period
>>= shift
;
132 t
->io_period
>>= shift
;
135 skew
= t
->io_period
- throttle
* t
->total_period
/ 100;
137 if (unlikely(skew
> 0) && slept
< MAX_SLEEPS
) {
139 spin_unlock_irq(&throttle_spinlock
);
147 spin_unlock_irq(&throttle_spinlock
);
150 static void io_job_finish(struct dm_kcopyd_throttle
*t
)
157 spin_lock_irqsave(&throttle_spinlock
, flags
);
161 if (likely(READ_ONCE(t
->throttle
) >= 100))
164 if (!t
->num_io_jobs
) {
165 unsigned now
, difference
;
168 difference
= now
- t
->last_jiffies
;
169 t
->last_jiffies
= now
;
171 t
->io_period
+= difference
;
172 t
->total_period
+= difference
;
175 * Maintain sane values if we got a temporary overflow.
177 if (unlikely(t
->io_period
> t
->total_period
))
178 t
->io_period
= t
->total_period
;
182 spin_unlock_irqrestore(&throttle_spinlock
, flags
);
186 static void wake(struct dm_kcopyd_client
*kc
)
188 queue_work(kc
->kcopyd_wq
, &kc
->kcopyd_work
);
192 * Obtain one page for the use of kcopyd.
194 static struct page_list
*alloc_pl(gfp_t gfp
)
196 struct page_list
*pl
;
198 pl
= kmalloc(sizeof(*pl
), gfp
);
202 pl
->page
= alloc_page(gfp
);
211 static void free_pl(struct page_list
*pl
)
213 __free_page(pl
->page
);
218 * Add the provided pages to a client's free page list, releasing
219 * back to the system any beyond the reserved_pages limit.
221 static void kcopyd_put_pages(struct dm_kcopyd_client
*kc
, struct page_list
*pl
)
223 struct page_list
*next
;
228 if (kc
->nr_free_pages
>= kc
->nr_reserved_pages
)
231 pl
->next
= kc
->pages
;
240 static int kcopyd_get_pages(struct dm_kcopyd_client
*kc
,
241 unsigned int nr
, struct page_list
**pages
)
243 struct page_list
*pl
;
248 pl
= alloc_pl(__GFP_NOWARN
| __GFP_NORETRY
| __GFP_KSWAPD_RECLAIM
);
250 /* Use reserved pages */
254 kc
->pages
= pl
->next
;
265 kcopyd_put_pages(kc
, *pages
);
270 * These three functions resize the page pool.
272 static void drop_pages(struct page_list
*pl
)
274 struct page_list
*next
;
284 * Allocate and reserve nr_pages for the use of a specific client.
286 static int client_reserve_pages(struct dm_kcopyd_client
*kc
, unsigned nr_pages
)
289 struct page_list
*pl
= NULL
, *next
;
291 for (i
= 0; i
< nr_pages
; i
++) {
292 next
= alloc_pl(GFP_KERNEL
);
302 kc
->nr_reserved_pages
+= nr_pages
;
303 kcopyd_put_pages(kc
, pl
);
308 static void client_free_pages(struct dm_kcopyd_client
*kc
)
310 BUG_ON(kc
->nr_free_pages
!= kc
->nr_reserved_pages
);
311 drop_pages(kc
->pages
);
313 kc
->nr_free_pages
= kc
->nr_reserved_pages
= 0;
316 /*-----------------------------------------------------------------
317 * kcopyd_jobs need to be allocated by the *clients* of kcopyd,
318 * for this reason we use a mempool to prevent the client from
319 * ever having to do io (which could cause a deadlock).
320 *---------------------------------------------------------------*/
322 struct dm_kcopyd_client
*kc
;
323 struct list_head list
;
327 * Error state of the job.
330 unsigned long write_err
;
333 * Either READ or WRITE
336 struct dm_io_region source
;
339 * The destinations for the transfer.
341 unsigned int num_dests
;
342 struct dm_io_region dests
[DM_KCOPYD_MAX_REGIONS
];
344 struct page_list
*pages
;
347 * Set this to ensure you are notified when the job has
348 * completed. 'context' is for callback to use.
350 dm_kcopyd_notify_fn fn
;
354 * These fields are only used if the job has been split
355 * into more manageable parts.
360 sector_t write_offset
;
362 struct kcopyd_job
*master_job
;
365 static struct kmem_cache
*_job_cache
;
367 int __init
dm_kcopyd_init(void)
369 _job_cache
= kmem_cache_create("kcopyd_job",
370 sizeof(struct kcopyd_job
) * (SPLIT_COUNT
+ 1),
371 __alignof__(struct kcopyd_job
), 0, NULL
);
375 zero_page_list
.next
= &zero_page_list
;
376 zero_page_list
.page
= ZERO_PAGE(0);
381 void dm_kcopyd_exit(void)
383 kmem_cache_destroy(_job_cache
);
388 * Functions to push and pop a job onto the head of a given job
391 static struct kcopyd_job
*pop_io_job(struct list_head
*jobs
,
392 struct dm_kcopyd_client
*kc
)
394 struct kcopyd_job
*job
;
397 * For I/O jobs, pop any read, any write without sequential write
398 * constraint and sequential writes that are at the right position.
400 list_for_each_entry(job
, jobs
, list
) {
401 if (job
->rw
== READ
|| !test_bit(DM_KCOPYD_WRITE_SEQ
, &job
->flags
)) {
402 list_del(&job
->list
);
406 if (job
->write_offset
== job
->master_job
->write_offset
) {
407 job
->master_job
->write_offset
+= job
->source
.count
;
408 list_del(&job
->list
);
416 static struct kcopyd_job
*pop(struct list_head
*jobs
,
417 struct dm_kcopyd_client
*kc
)
419 struct kcopyd_job
*job
= NULL
;
422 spin_lock_irqsave(&kc
->job_lock
, flags
);
424 if (!list_empty(jobs
)) {
425 if (jobs
== &kc
->io_jobs
)
426 job
= pop_io_job(jobs
, kc
);
428 job
= list_entry(jobs
->next
, struct kcopyd_job
, list
);
429 list_del(&job
->list
);
432 spin_unlock_irqrestore(&kc
->job_lock
, flags
);
437 static void push(struct list_head
*jobs
, struct kcopyd_job
*job
)
440 struct dm_kcopyd_client
*kc
= job
->kc
;
442 spin_lock_irqsave(&kc
->job_lock
, flags
);
443 list_add_tail(&job
->list
, jobs
);
444 spin_unlock_irqrestore(&kc
->job_lock
, flags
);
448 static void push_head(struct list_head
*jobs
, struct kcopyd_job
*job
)
451 struct dm_kcopyd_client
*kc
= job
->kc
;
453 spin_lock_irqsave(&kc
->job_lock
, flags
);
454 list_add(&job
->list
, jobs
);
455 spin_unlock_irqrestore(&kc
->job_lock
, flags
);
459 * These three functions process 1 item from the corresponding
465 * > 0: can't process yet.
467 static int run_complete_job(struct kcopyd_job
*job
)
469 void *context
= job
->context
;
470 int read_err
= job
->read_err
;
471 unsigned long write_err
= job
->write_err
;
472 dm_kcopyd_notify_fn fn
= job
->fn
;
473 struct dm_kcopyd_client
*kc
= job
->kc
;
475 if (job
->pages
&& job
->pages
!= &zero_page_list
)
476 kcopyd_put_pages(kc
, job
->pages
);
478 * If this is the master job, the sub jobs have already
479 * completed so we can free everything.
481 if (job
->master_job
== job
) {
482 mutex_destroy(&job
->lock
);
483 mempool_free(job
, &kc
->job_pool
);
485 fn(read_err
, write_err
, context
);
487 if (atomic_dec_and_test(&kc
->nr_jobs
))
488 wake_up(&kc
->destroyq
);
495 static void complete_io(unsigned long error
, void *context
)
497 struct kcopyd_job
*job
= (struct kcopyd_job
*) context
;
498 struct dm_kcopyd_client
*kc
= job
->kc
;
500 io_job_finish(kc
->throttle
);
503 if (op_is_write(job
->rw
))
504 job
->write_err
|= error
;
508 if (!test_bit(DM_KCOPYD_IGNORE_ERROR
, &job
->flags
)) {
509 push(&kc
->complete_jobs
, job
);
515 if (op_is_write(job
->rw
))
516 push(&kc
->complete_jobs
, job
);
520 push(&kc
->io_jobs
, job
);
527 * Request io on as many buffer heads as we can currently get for
530 static int run_io_job(struct kcopyd_job
*job
)
533 struct dm_io_request io_req
= {
536 .mem
.type
= DM_IO_PAGE_LIST
,
537 .mem
.ptr
.pl
= job
->pages
,
539 .notify
.fn
= complete_io
,
540 .notify
.context
= job
,
541 .client
= job
->kc
->io_client
,
545 * If we need to write sequentially and some reads or writes failed,
546 * no point in continuing.
548 if (test_bit(DM_KCOPYD_WRITE_SEQ
, &job
->flags
) &&
549 job
->master_job
->write_err
)
552 io_job_start(job
->kc
->throttle
);
555 r
= dm_io(&io_req
, 1, &job
->source
, NULL
);
557 r
= dm_io(&io_req
, job
->num_dests
, job
->dests
, NULL
);
562 static int run_pages_job(struct kcopyd_job
*job
)
565 unsigned nr_pages
= dm_div_up(job
->dests
[0].count
, PAGE_SIZE
>> 9);
567 r
= kcopyd_get_pages(job
->kc
, nr_pages
, &job
->pages
);
569 /* this job is ready for io */
570 push(&job
->kc
->io_jobs
, job
);
575 /* can't complete now */
582 * Run through a list for as long as possible. Returns the count
583 * of successful jobs.
585 static int process_jobs(struct list_head
*jobs
, struct dm_kcopyd_client
*kc
,
586 int (*fn
) (struct kcopyd_job
*))
588 struct kcopyd_job
*job
;
591 while ((job
= pop(jobs
, kc
))) {
596 /* error this rogue job */
597 if (op_is_write(job
->rw
))
598 job
->write_err
= (unsigned long) -1L;
601 push(&kc
->complete_jobs
, job
);
607 * We couldn't service this job ATM, so
608 * push this job back onto the list.
610 push_head(jobs
, job
);
621 * kcopyd does this every time it's woken up.
623 static void do_work(struct work_struct
*work
)
625 struct dm_kcopyd_client
*kc
= container_of(work
,
626 struct dm_kcopyd_client
, kcopyd_work
);
627 struct blk_plug plug
;
630 * The order that these are called is *very* important.
631 * complete jobs can free some pages for pages jobs.
632 * Pages jobs when successful will jump onto the io jobs
633 * list. io jobs call wake when they complete and it all
636 blk_start_plug(&plug
);
637 process_jobs(&kc
->complete_jobs
, kc
, run_complete_job
);
638 process_jobs(&kc
->pages_jobs
, kc
, run_pages_job
);
639 process_jobs(&kc
->io_jobs
, kc
, run_io_job
);
640 blk_finish_plug(&plug
);
644 * If we are copying a small region we just dispatch a single job
645 * to do the copy, otherwise the io has to be split up into many
648 static void dispatch_job(struct kcopyd_job
*job
)
650 struct dm_kcopyd_client
*kc
= job
->kc
;
651 atomic_inc(&kc
->nr_jobs
);
652 if (unlikely(!job
->source
.count
))
653 push(&kc
->complete_jobs
, job
);
654 else if (job
->pages
== &zero_page_list
)
655 push(&kc
->io_jobs
, job
);
657 push(&kc
->pages_jobs
, job
);
661 static void segment_complete(int read_err
, unsigned long write_err
,
664 /* FIXME: tidy this function */
665 sector_t progress
= 0;
667 struct kcopyd_job
*sub_job
= (struct kcopyd_job
*) context
;
668 struct kcopyd_job
*job
= sub_job
->master_job
;
669 struct dm_kcopyd_client
*kc
= job
->kc
;
671 mutex_lock(&job
->lock
);
673 /* update the error */
678 job
->write_err
|= write_err
;
681 * Only dispatch more work if there hasn't been an error.
683 if ((!job
->read_err
&& !job
->write_err
) ||
684 test_bit(DM_KCOPYD_IGNORE_ERROR
, &job
->flags
)) {
685 /* get the next chunk of work */
686 progress
= job
->progress
;
687 count
= job
->source
.count
- progress
;
689 if (count
> SUB_JOB_SIZE
)
690 count
= SUB_JOB_SIZE
;
692 job
->progress
+= count
;
695 mutex_unlock(&job
->lock
);
701 sub_job
->write_offset
= progress
;
702 sub_job
->source
.sector
+= progress
;
703 sub_job
->source
.count
= count
;
705 for (i
= 0; i
< job
->num_dests
; i
++) {
706 sub_job
->dests
[i
].sector
+= progress
;
707 sub_job
->dests
[i
].count
= count
;
710 sub_job
->fn
= segment_complete
;
711 sub_job
->context
= sub_job
;
712 dispatch_job(sub_job
);
714 } else if (atomic_dec_and_test(&job
->sub_jobs
)) {
717 * Queue the completion callback to the kcopyd thread.
719 * Some callers assume that all the completions are called
720 * from a single thread and don't race with each other.
722 * We must not call the callback directly here because this
723 * code may not be executing in the thread.
725 push(&kc
->complete_jobs
, job
);
731 * Create some sub jobs to share the work between them.
733 static void split_job(struct kcopyd_job
*master_job
)
737 atomic_inc(&master_job
->kc
->nr_jobs
);
739 atomic_set(&master_job
->sub_jobs
, SPLIT_COUNT
);
740 for (i
= 0; i
< SPLIT_COUNT
; i
++) {
741 master_job
[i
+ 1].master_job
= master_job
;
742 segment_complete(0, 0u, &master_job
[i
+ 1]);
746 void dm_kcopyd_copy(struct dm_kcopyd_client
*kc
, struct dm_io_region
*from
,
747 unsigned int num_dests
, struct dm_io_region
*dests
,
748 unsigned int flags
, dm_kcopyd_notify_fn fn
, void *context
)
750 struct kcopyd_job
*job
;
754 * Allocate an array of jobs consisting of one master job
755 * followed by SPLIT_COUNT sub jobs.
757 job
= mempool_alloc(&kc
->job_pool
, GFP_NOIO
);
758 mutex_init(&job
->lock
);
761 * set up for the read.
768 job
->num_dests
= num_dests
;
769 memcpy(&job
->dests
, dests
, sizeof(*dests
) * num_dests
);
772 * If one of the destination is a host-managed zoned block device,
773 * we need to write sequentially. If one of the destination is a
774 * host-aware device, then leave it to the caller to choose what to do.
776 if (!test_bit(DM_KCOPYD_WRITE_SEQ
, &job
->flags
)) {
777 for (i
= 0; i
< job
->num_dests
; i
++) {
778 if (bdev_zoned_model(dests
[i
].bdev
) == BLK_ZONED_HM
) {
779 set_bit(DM_KCOPYD_WRITE_SEQ
, &job
->flags
);
786 * If we need to write sequentially, errors cannot be ignored.
788 if (test_bit(DM_KCOPYD_WRITE_SEQ
, &job
->flags
) &&
789 test_bit(DM_KCOPYD_IGNORE_ERROR
, &job
->flags
))
790 clear_bit(DM_KCOPYD_IGNORE_ERROR
, &job
->flags
);
797 memset(&job
->source
, 0, sizeof job
->source
);
798 job
->source
.count
= job
->dests
[0].count
;
799 job
->pages
= &zero_page_list
;
802 * Use WRITE ZEROES to optimize zeroing if all dests support it.
804 job
->rw
= REQ_OP_WRITE_ZEROES
;
805 for (i
= 0; i
< job
->num_dests
; i
++)
806 if (!bdev_write_zeroes_sectors(job
->dests
[i
].bdev
)) {
813 job
->context
= context
;
814 job
->master_job
= job
;
815 job
->write_offset
= 0;
817 if (job
->source
.count
<= SUB_JOB_SIZE
)
824 EXPORT_SYMBOL(dm_kcopyd_copy
);
826 void dm_kcopyd_zero(struct dm_kcopyd_client
*kc
,
827 unsigned num_dests
, struct dm_io_region
*dests
,
828 unsigned flags
, dm_kcopyd_notify_fn fn
, void *context
)
830 dm_kcopyd_copy(kc
, NULL
, num_dests
, dests
, flags
, fn
, context
);
832 EXPORT_SYMBOL(dm_kcopyd_zero
);
834 void *dm_kcopyd_prepare_callback(struct dm_kcopyd_client
*kc
,
835 dm_kcopyd_notify_fn fn
, void *context
)
837 struct kcopyd_job
*job
;
839 job
= mempool_alloc(&kc
->job_pool
, GFP_NOIO
);
841 memset(job
, 0, sizeof(struct kcopyd_job
));
844 job
->context
= context
;
845 job
->master_job
= job
;
847 atomic_inc(&kc
->nr_jobs
);
851 EXPORT_SYMBOL(dm_kcopyd_prepare_callback
);
853 void dm_kcopyd_do_callback(void *j
, int read_err
, unsigned long write_err
)
855 struct kcopyd_job
*job
= j
;
856 struct dm_kcopyd_client
*kc
= job
->kc
;
858 job
->read_err
= read_err
;
859 job
->write_err
= write_err
;
861 push(&kc
->complete_jobs
, job
);
864 EXPORT_SYMBOL(dm_kcopyd_do_callback
);
867 * Cancels a kcopyd job, eg. someone might be deactivating a
871 int kcopyd_cancel(struct kcopyd_job
*job
, int block
)
878 /*-----------------------------------------------------------------
880 *---------------------------------------------------------------*/
881 struct dm_kcopyd_client
*dm_kcopyd_client_create(struct dm_kcopyd_throttle
*throttle
)
884 struct dm_kcopyd_client
*kc
;
886 kc
= kzalloc(sizeof(*kc
), GFP_KERNEL
);
888 return ERR_PTR(-ENOMEM
);
890 spin_lock_init(&kc
->job_lock
);
891 INIT_LIST_HEAD(&kc
->complete_jobs
);
892 INIT_LIST_HEAD(&kc
->io_jobs
);
893 INIT_LIST_HEAD(&kc
->pages_jobs
);
894 kc
->throttle
= throttle
;
896 r
= mempool_init_slab_pool(&kc
->job_pool
, MIN_JOBS
, _job_cache
);
900 INIT_WORK(&kc
->kcopyd_work
, do_work
);
901 kc
->kcopyd_wq
= alloc_workqueue("kcopyd", WQ_MEM_RECLAIM
, 0);
902 if (!kc
->kcopyd_wq
) {
908 kc
->nr_reserved_pages
= kc
->nr_free_pages
= 0;
909 r
= client_reserve_pages(kc
, RESERVE_PAGES
);
911 goto bad_client_pages
;
913 kc
->io_client
= dm_io_client_create();
914 if (IS_ERR(kc
->io_client
)) {
915 r
= PTR_ERR(kc
->io_client
);
919 init_waitqueue_head(&kc
->destroyq
);
920 atomic_set(&kc
->nr_jobs
, 0);
925 client_free_pages(kc
);
927 destroy_workqueue(kc
->kcopyd_wq
);
929 mempool_exit(&kc
->job_pool
);
935 EXPORT_SYMBOL(dm_kcopyd_client_create
);
937 void dm_kcopyd_client_destroy(struct dm_kcopyd_client
*kc
)
939 /* Wait for completion of all jobs submitted by this client. */
940 wait_event(kc
->destroyq
, !atomic_read(&kc
->nr_jobs
));
942 BUG_ON(!list_empty(&kc
->complete_jobs
));
943 BUG_ON(!list_empty(&kc
->io_jobs
));
944 BUG_ON(!list_empty(&kc
->pages_jobs
));
945 destroy_workqueue(kc
->kcopyd_wq
);
946 dm_io_client_destroy(kc
->io_client
);
947 client_free_pages(kc
);
948 mempool_exit(&kc
->job_pool
);
951 EXPORT_SYMBOL(dm_kcopyd_client_destroy
);