Merge remote-tracking branches 'spi/topic/jcore', 'spi/topic/kconfig', 'spi/topic...
[linux-2.6-block.git] / drivers / md / dm-kcopyd.c
CommitLineData
1da177e4
LT
1/*
2 * Copyright (C) 2002 Sistina Software (UK) Limited.
373a392b 3 * Copyright (C) 2006 Red Hat GmbH
1da177e4
LT
4 *
5 * This file is released under the GPL.
6 *
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.
10 */
11
eb69aca5 12#include <linux/types.h>
60063497 13#include <linux/atomic.h>
1da177e4 14#include <linux/blkdev.h>
1da177e4
LT
15#include <linux/fs.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>
48c9c27b 24#include <linux/mutex.h>
df5d2e90 25#include <linux/delay.h>
586e80e6 26#include <linux/device-mapper.h>
a765e20e 27#include <linux/dm-kcopyd.h>
1da177e4 28
4cc96131 29#include "dm-core.h"
1da177e4 30
c6ea41fb
MP
31#define SUB_JOB_SIZE 128
32#define SPLIT_COUNT 8
33#define MIN_JOBS 8
5f43ba29 34#define RESERVE_PAGES (DIV_ROUND_UP(SUB_JOB_SIZE << SECTOR_SHIFT, PAGE_SIZE))
c6ea41fb 35
1da177e4
LT
36/*-----------------------------------------------------------------
37 * Each kcopyd client has its own little pool of preallocated
38 * pages for kcopyd io.
39 *---------------------------------------------------------------*/
eb69aca5 40struct dm_kcopyd_client {
1da177e4 41 struct page_list *pages;
d0471458
MP
42 unsigned nr_reserved_pages;
43 unsigned nr_free_pages;
138728dc 44
373a392b
MB
45 struct dm_io_client *io_client;
46
138728dc
AK
47 wait_queue_head_t destroyq;
48 atomic_t nr_jobs;
8c0cbc2f 49
08d8757a
MP
50 mempool_t *job_pool;
51
8c0cbc2f
MP
52 struct workqueue_struct *kcopyd_wq;
53 struct work_struct kcopyd_work;
54
df5d2e90
MP
55 struct dm_kcopyd_throttle *throttle;
56
8c0cbc2f
MP
57/*
58 * We maintain three lists of jobs:
59 *
60 * i) jobs waiting for pages
61 * ii) jobs that have pages, and are waiting for the io to be issued.
62 * iii) jobs that have completed.
63 *
64 * All three of these are protected by job_lock.
65 */
66 spinlock_t job_lock;
67 struct list_head complete_jobs;
68 struct list_head io_jobs;
69 struct list_head pages_jobs;
1da177e4
LT
70};
71
7f069653
MP
72static struct page_list zero_page_list;
73
df5d2e90
MP
74static DEFINE_SPINLOCK(throttle_spinlock);
75
76/*
77 * IO/IDLE accounting slowly decays after (1 << ACCOUNT_INTERVAL_SHIFT) period.
78 * When total_period >= (1 << ACCOUNT_INTERVAL_SHIFT) the counters are divided
79 * by 2.
80 */
81#define ACCOUNT_INTERVAL_SHIFT SHIFT_HZ
82
83/*
84 * Sleep this number of milliseconds.
85 *
86 * The value was decided experimentally.
87 * Smaller values seem to cause an increased copy rate above the limit.
88 * The reason for this is unknown but possibly due to jiffies rounding errors
89 * or read/write cache inside the disk.
90 */
91#define SLEEP_MSEC 100
92
93/*
94 * Maximum number of sleep events. There is a theoretical livelock if more
95 * kcopyd clients do work simultaneously which this limit avoids.
96 */
97#define MAX_SLEEPS 10
98
99static void io_job_start(struct dm_kcopyd_throttle *t)
100{
101 unsigned throttle, now, difference;
102 int slept = 0, skew;
103
104 if (unlikely(!t))
105 return;
106
107try_again:
108 spin_lock_irq(&throttle_spinlock);
109
6aa7de05 110 throttle = READ_ONCE(t->throttle);
df5d2e90
MP
111
112 if (likely(throttle >= 100))
113 goto skip_limit;
114
115 now = jiffies;
116 difference = now - t->last_jiffies;
117 t->last_jiffies = now;
118 if (t->num_io_jobs)
119 t->io_period += difference;
120 t->total_period += difference;
121
122 /*
123 * Maintain sane values if we got a temporary overflow.
124 */
125 if (unlikely(t->io_period > t->total_period))
126 t->io_period = t->total_period;
127
128 if (unlikely(t->total_period >= (1 << ACCOUNT_INTERVAL_SHIFT))) {
129 int shift = fls(t->total_period >> ACCOUNT_INTERVAL_SHIFT);
130 t->total_period >>= shift;
131 t->io_period >>= shift;
132 }
133
134 skew = t->io_period - throttle * t->total_period / 100;
135
136 if (unlikely(skew > 0) && slept < MAX_SLEEPS) {
137 slept++;
138 spin_unlock_irq(&throttle_spinlock);
139 msleep(SLEEP_MSEC);
140 goto try_again;
141 }
142
143skip_limit:
144 t->num_io_jobs++;
145
146 spin_unlock_irq(&throttle_spinlock);
147}
148
149static void io_job_finish(struct dm_kcopyd_throttle *t)
150{
151 unsigned long flags;
152
153 if (unlikely(!t))
154 return;
155
156 spin_lock_irqsave(&throttle_spinlock, flags);
157
158 t->num_io_jobs--;
159
6aa7de05 160 if (likely(READ_ONCE(t->throttle) >= 100))
df5d2e90
MP
161 goto skip_limit;
162
163 if (!t->num_io_jobs) {
164 unsigned now, difference;
165
166 now = jiffies;
167 difference = now - t->last_jiffies;
168 t->last_jiffies = now;
169
170 t->io_period += difference;
171 t->total_period += difference;
172
173 /*
174 * Maintain sane values if we got a temporary overflow.
175 */
176 if (unlikely(t->io_period > t->total_period))
177 t->io_period = t->total_period;
178 }
179
180skip_limit:
181 spin_unlock_irqrestore(&throttle_spinlock, flags);
182}
183
184
8c0cbc2f
MP
185static void wake(struct dm_kcopyd_client *kc)
186{
187 queue_work(kc->kcopyd_wq, &kc->kcopyd_work);
188}
189
d0471458
MP
190/*
191 * Obtain one page for the use of kcopyd.
192 */
f99b55ee 193static struct page_list *alloc_pl(gfp_t gfp)
1da177e4
LT
194{
195 struct page_list *pl;
196
f99b55ee 197 pl = kmalloc(sizeof(*pl), gfp);
1da177e4
LT
198 if (!pl)
199 return NULL;
200
f99b55ee 201 pl->page = alloc_page(gfp);
1da177e4
LT
202 if (!pl->page) {
203 kfree(pl);
204 return NULL;
205 }
206
207 return pl;
208}
209
210static void free_pl(struct page_list *pl)
211{
212 __free_page(pl->page);
213 kfree(pl);
214}
215
d0471458
MP
216/*
217 * Add the provided pages to a client's free page list, releasing
218 * back to the system any beyond the reserved_pages limit.
219 */
220static void kcopyd_put_pages(struct dm_kcopyd_client *kc, struct page_list *pl)
1da177e4 221{
d0471458 222 struct page_list *next;
1da177e4 223
d0471458
MP
224 do {
225 next = pl->next;
1da177e4 226
d0471458
MP
227 if (kc->nr_free_pages >= kc->nr_reserved_pages)
228 free_pl(pl);
229 else {
230 pl->next = kc->pages;
231 kc->pages = pl;
232 kc->nr_free_pages++;
233 }
1da177e4 234
d0471458
MP
235 pl = next;
236 } while (pl);
1da177e4
LT
237}
238
d0471458
MP
239static int kcopyd_get_pages(struct dm_kcopyd_client *kc,
240 unsigned int nr, struct page_list **pages)
1da177e4 241{
d0471458 242 struct page_list *pl;
1da177e4 243
d0471458
MP
244 *pages = NULL;
245
246 do {
d0164adc 247 pl = alloc_pl(__GFP_NOWARN | __GFP_NORETRY | __GFP_KSWAPD_RECLAIM);
d0471458
MP
248 if (unlikely(!pl)) {
249 /* Use reserved pages */
250 pl = kc->pages;
251 if (unlikely(!pl))
252 goto out_of_memory;
253 kc->pages = pl->next;
254 kc->nr_free_pages--;
255 }
256 pl->next = *pages;
257 *pages = pl;
258 } while (--nr);
259
260 return 0;
1da177e4 261
d0471458
MP
262out_of_memory:
263 if (*pages)
264 kcopyd_put_pages(kc, *pages);
265 return -ENOMEM;
1da177e4
LT
266}
267
268/*
269 * These three functions resize the page pool.
270 */
271static void drop_pages(struct page_list *pl)
272{
273 struct page_list *next;
274
275 while (pl) {
276 next = pl->next;
277 free_pl(pl);
278 pl = next;
279 }
280}
281
d0471458
MP
282/*
283 * Allocate and reserve nr_pages for the use of a specific client.
284 */
285static int client_reserve_pages(struct dm_kcopyd_client *kc, unsigned nr_pages)
1da177e4 286{
d0471458 287 unsigned i;
1da177e4
LT
288 struct page_list *pl = NULL, *next;
289
d0471458 290 for (i = 0; i < nr_pages; i++) {
f99b55ee 291 next = alloc_pl(GFP_KERNEL);
1da177e4
LT
292 if (!next) {
293 if (pl)
294 drop_pages(pl);
295 return -ENOMEM;
296 }
297 next->next = pl;
298 pl = next;
299 }
300
d0471458 301 kc->nr_reserved_pages += nr_pages;
1da177e4 302 kcopyd_put_pages(kc, pl);
d0471458 303
1da177e4
LT
304 return 0;
305}
306
eb69aca5 307static void client_free_pages(struct dm_kcopyd_client *kc)
1da177e4 308{
d0471458 309 BUG_ON(kc->nr_free_pages != kc->nr_reserved_pages);
1da177e4
LT
310 drop_pages(kc->pages);
311 kc->pages = NULL;
d0471458 312 kc->nr_free_pages = kc->nr_reserved_pages = 0;
1da177e4
LT
313}
314
315/*-----------------------------------------------------------------
316 * kcopyd_jobs need to be allocated by the *clients* of kcopyd,
317 * for this reason we use a mempool to prevent the client from
318 * ever having to do io (which could cause a deadlock).
319 *---------------------------------------------------------------*/
320struct kcopyd_job {
eb69aca5 321 struct dm_kcopyd_client *kc;
1da177e4
LT
322 struct list_head list;
323 unsigned long flags;
324
325 /*
326 * Error state of the job.
327 */
328 int read_err;
4cdc1d1f 329 unsigned long write_err;
1da177e4
LT
330
331 /*
332 * Either READ or WRITE
333 */
334 int rw;
22a1ceb1 335 struct dm_io_region source;
1da177e4
LT
336
337 /*
338 * The destinations for the transfer.
339 */
340 unsigned int num_dests;
eb69aca5 341 struct dm_io_region dests[DM_KCOPYD_MAX_REGIONS];
1da177e4 342
1da177e4
LT
343 struct page_list *pages;
344
345 /*
346 * Set this to ensure you are notified when the job has
347 * completed. 'context' is for callback to use.
348 */
eb69aca5 349 dm_kcopyd_notify_fn fn;
1da177e4
LT
350 void *context;
351
352 /*
353 * These fields are only used if the job has been split
354 * into more manageable parts.
355 */
def5b5b2 356 struct mutex lock;
1da177e4
LT
357 atomic_t sub_jobs;
358 sector_t progress;
b73c67c2 359 sector_t write_offset;
1da177e4 360
c6ea41fb
MP
361 struct kcopyd_job *master_job;
362};
1da177e4 363
e18b890b 364static struct kmem_cache *_job_cache;
1da177e4 365
945fa4d2 366int __init dm_kcopyd_init(void)
1da177e4 367{
c6ea41fb
MP
368 _job_cache = kmem_cache_create("kcopyd_job",
369 sizeof(struct kcopyd_job) * (SPLIT_COUNT + 1),
370 __alignof__(struct kcopyd_job), 0, NULL);
1da177e4
LT
371 if (!_job_cache)
372 return -ENOMEM;
373
7f069653
MP
374 zero_page_list.next = &zero_page_list;
375 zero_page_list.page = ZERO_PAGE(0);
376
1da177e4
LT
377 return 0;
378}
379
945fa4d2 380void dm_kcopyd_exit(void)
1da177e4 381{
1da177e4 382 kmem_cache_destroy(_job_cache);
1da177e4
LT
383 _job_cache = NULL;
384}
385
386/*
387 * Functions to push and pop a job onto the head of a given job
388 * list.
389 */
b73c67c2
DLM
390static struct kcopyd_job *pop_io_job(struct list_head *jobs,
391 struct dm_kcopyd_client *kc)
392{
393 struct kcopyd_job *job;
394
395 /*
396 * For I/O jobs, pop any read, any write without sequential write
397 * constraint and sequential writes that are at the right position.
398 */
399 list_for_each_entry(job, jobs, list) {
400 if (job->rw == READ || !test_bit(DM_KCOPYD_WRITE_SEQ, &job->flags)) {
401 list_del(&job->list);
402 return job;
403 }
404
405 if (job->write_offset == job->master_job->write_offset) {
406 job->master_job->write_offset += job->source.count;
407 list_del(&job->list);
408 return job;
409 }
410 }
411
412 return NULL;
413}
414
8c0cbc2f
MP
415static struct kcopyd_job *pop(struct list_head *jobs,
416 struct dm_kcopyd_client *kc)
1da177e4
LT
417{
418 struct kcopyd_job *job = NULL;
419 unsigned long flags;
420
8c0cbc2f 421 spin_lock_irqsave(&kc->job_lock, flags);
1da177e4
LT
422
423 if (!list_empty(jobs)) {
b73c67c2
DLM
424 if (jobs == &kc->io_jobs)
425 job = pop_io_job(jobs, kc);
426 else {
427 job = list_entry(jobs->next, struct kcopyd_job, list);
428 list_del(&job->list);
429 }
1da177e4 430 }
8c0cbc2f 431 spin_unlock_irqrestore(&kc->job_lock, flags);
1da177e4
LT
432
433 return job;
434}
435
028867ac 436static void push(struct list_head *jobs, struct kcopyd_job *job)
1da177e4
LT
437{
438 unsigned long flags;
8c0cbc2f 439 struct dm_kcopyd_client *kc = job->kc;
1da177e4 440
8c0cbc2f 441 spin_lock_irqsave(&kc->job_lock, flags);
1da177e4 442 list_add_tail(&job->list, jobs);
8c0cbc2f 443 spin_unlock_irqrestore(&kc->job_lock, flags);
1da177e4
LT
444}
445
b673c3a8
KI
446
447static void push_head(struct list_head *jobs, struct kcopyd_job *job)
448{
449 unsigned long flags;
450 struct dm_kcopyd_client *kc = job->kc;
451
452 spin_lock_irqsave(&kc->job_lock, flags);
453 list_add(&job->list, jobs);
454 spin_unlock_irqrestore(&kc->job_lock, flags);
455}
456
1da177e4
LT
457/*
458 * These three functions process 1 item from the corresponding
459 * job list.
460 *
461 * They return:
462 * < 0: error
463 * 0: success
464 * > 0: can't process yet.
465 */
466static int run_complete_job(struct kcopyd_job *job)
467{
468 void *context = job->context;
469 int read_err = job->read_err;
4cdc1d1f 470 unsigned long write_err = job->write_err;
eb69aca5
HM
471 dm_kcopyd_notify_fn fn = job->fn;
472 struct dm_kcopyd_client *kc = job->kc;
1da177e4 473
7f069653 474 if (job->pages && job->pages != &zero_page_list)
73830857 475 kcopyd_put_pages(kc, job->pages);
c6ea41fb
MP
476 /*
477 * If this is the master job, the sub jobs have already
478 * completed so we can free everything.
479 */
d5ffebdd
MS
480 if (job->master_job == job) {
481 mutex_destroy(&job->lock);
c6ea41fb 482 mempool_free(job, kc->job_pool);
d5ffebdd 483 }
1da177e4 484 fn(read_err, write_err, context);
138728dc
AK
485
486 if (atomic_dec_and_test(&kc->nr_jobs))
487 wake_up(&kc->destroyq);
488
1da177e4
LT
489 return 0;
490}
491
492static void complete_io(unsigned long error, void *context)
493{
494 struct kcopyd_job *job = (struct kcopyd_job *) context;
8c0cbc2f 495 struct dm_kcopyd_client *kc = job->kc;
1da177e4 496
df5d2e90
MP
497 io_job_finish(kc->throttle);
498
1da177e4 499 if (error) {
51111666 500 if (op_is_write(job->rw))
ce503f59 501 job->write_err |= error;
1da177e4
LT
502 else
503 job->read_err = 1;
504
eb69aca5 505 if (!test_bit(DM_KCOPYD_IGNORE_ERROR, &job->flags)) {
8c0cbc2f
MP
506 push(&kc->complete_jobs, job);
507 wake(kc);
1da177e4
LT
508 return;
509 }
510 }
511
51111666 512 if (op_is_write(job->rw))
8c0cbc2f 513 push(&kc->complete_jobs, job);
1da177e4
LT
514
515 else {
516 job->rw = WRITE;
8c0cbc2f 517 push(&kc->io_jobs, job);
1da177e4
LT
518 }
519
8c0cbc2f 520 wake(kc);
1da177e4
LT
521}
522
523/*
524 * Request io on as many buffer heads as we can currently get for
525 * a particular job.
526 */
527static int run_io_job(struct kcopyd_job *job)
528{
529 int r;
373a392b 530 struct dm_io_request io_req = {
e6047149
MC
531 .bi_op = job->rw,
532 .bi_op_flags = 0,
373a392b
MB
533 .mem.type = DM_IO_PAGE_LIST,
534 .mem.ptr.pl = job->pages,
4622afb3 535 .mem.offset = 0,
373a392b
MB
536 .notify.fn = complete_io,
537 .notify.context = job,
538 .client = job->kc->io_client,
539 };
1da177e4 540
b73c67c2
DLM
541 /*
542 * If we need to write sequentially and some reads or writes failed,
543 * no point in continuing.
544 */
545 if (test_bit(DM_KCOPYD_WRITE_SEQ, &job->flags) &&
546 job->master_job->write_err)
547 return -EIO;
548
df5d2e90
MP
549 io_job_start(job->kc->throttle);
550
7eaceacc 551 if (job->rw == READ)
373a392b 552 r = dm_io(&io_req, 1, &job->source, NULL);
721a9602 553 else
373a392b 554 r = dm_io(&io_req, job->num_dests, job->dests, NULL);
1da177e4
LT
555
556 return r;
557}
558
559static int run_pages_job(struct kcopyd_job *job)
560{
561 int r;
5bf45a3d 562 unsigned nr_pages = dm_div_up(job->dests[0].count, PAGE_SIZE >> 9);
1da177e4 563
5bf45a3d 564 r = kcopyd_get_pages(job->kc, nr_pages, &job->pages);
1da177e4
LT
565 if (!r) {
566 /* this job is ready for io */
8c0cbc2f 567 push(&job->kc->io_jobs, job);
1da177e4
LT
568 return 0;
569 }
570
571 if (r == -ENOMEM)
572 /* can't complete now */
573 return 1;
574
575 return r;
576}
577
578/*
579 * Run through a list for as long as possible. Returns the count
580 * of successful jobs.
581 */
8c0cbc2f
MP
582static int process_jobs(struct list_head *jobs, struct dm_kcopyd_client *kc,
583 int (*fn) (struct kcopyd_job *))
1da177e4
LT
584{
585 struct kcopyd_job *job;
586 int r, count = 0;
587
8c0cbc2f 588 while ((job = pop(jobs, kc))) {
1da177e4
LT
589
590 r = fn(job);
591
592 if (r < 0) {
593 /* error this rogue job */
51111666 594 if (op_is_write(job->rw))
4cdc1d1f 595 job->write_err = (unsigned long) -1L;
1da177e4
LT
596 else
597 job->read_err = 1;
8c0cbc2f 598 push(&kc->complete_jobs, job);
1da177e4
LT
599 break;
600 }
601
602 if (r > 0) {
603 /*
604 * We couldn't service this job ATM, so
605 * push this job back onto the list.
606 */
b673c3a8 607 push_head(jobs, job);
1da177e4
LT
608 break;
609 }
610
611 count++;
612 }
613
614 return count;
615}
616
617/*
618 * kcopyd does this every time it's woken up.
619 */
8c0cbc2f 620static void do_work(struct work_struct *work)
1da177e4 621{
8c0cbc2f
MP
622 struct dm_kcopyd_client *kc = container_of(work,
623 struct dm_kcopyd_client, kcopyd_work);
7eaceacc 624 struct blk_plug plug;
8c0cbc2f 625
1da177e4
LT
626 /*
627 * The order that these are called is *very* important.
628 * complete jobs can free some pages for pages jobs.
629 * Pages jobs when successful will jump onto the io jobs
630 * list. io jobs call wake when they complete and it all
631 * starts again.
632 */
7eaceacc 633 blk_start_plug(&plug);
8c0cbc2f
MP
634 process_jobs(&kc->complete_jobs, kc, run_complete_job);
635 process_jobs(&kc->pages_jobs, kc, run_pages_job);
636 process_jobs(&kc->io_jobs, kc, run_io_job);
7eaceacc 637 blk_finish_plug(&plug);
1da177e4
LT
638}
639
640/*
641 * If we are copying a small region we just dispatch a single job
642 * to do the copy, otherwise the io has to be split up into many
643 * jobs.
644 */
645static void dispatch_job(struct kcopyd_job *job)
646{
8c0cbc2f
MP
647 struct dm_kcopyd_client *kc = job->kc;
648 atomic_inc(&kc->nr_jobs);
9ca170a3
MP
649 if (unlikely(!job->source.count))
650 push(&kc->complete_jobs, job);
7f069653
MP
651 else if (job->pages == &zero_page_list)
652 push(&kc->io_jobs, job);
9ca170a3
MP
653 else
654 push(&kc->pages_jobs, job);
8c0cbc2f 655 wake(kc);
1da177e4
LT
656}
657
4cdc1d1f
AK
658static void segment_complete(int read_err, unsigned long write_err,
659 void *context)
1da177e4
LT
660{
661 /* FIXME: tidy this function */
662 sector_t progress = 0;
663 sector_t count = 0;
c6ea41fb
MP
664 struct kcopyd_job *sub_job = (struct kcopyd_job *) context;
665 struct kcopyd_job *job = sub_job->master_job;
73830857 666 struct dm_kcopyd_client *kc = job->kc;
1da177e4 667
def5b5b2 668 mutex_lock(&job->lock);
1da177e4
LT
669
670 /* update the error */
671 if (read_err)
672 job->read_err = 1;
673
674 if (write_err)
ce503f59 675 job->write_err |= write_err;
1da177e4
LT
676
677 /*
678 * Only dispatch more work if there hasn't been an error.
679 */
680 if ((!job->read_err && !job->write_err) ||
eb69aca5 681 test_bit(DM_KCOPYD_IGNORE_ERROR, &job->flags)) {
1da177e4
LT
682 /* get the next chunk of work */
683 progress = job->progress;
684 count = job->source.count - progress;
685 if (count) {
686 if (count > SUB_JOB_SIZE)
687 count = SUB_JOB_SIZE;
688
689 job->progress += count;
690 }
691 }
def5b5b2 692 mutex_unlock(&job->lock);
1da177e4
LT
693
694 if (count) {
695 int i;
1da177e4
LT
696
697 *sub_job = *job;
b73c67c2 698 sub_job->write_offset = progress;
1da177e4
LT
699 sub_job->source.sector += progress;
700 sub_job->source.count = count;
701
702 for (i = 0; i < job->num_dests; i++) {
703 sub_job->dests[i].sector += progress;
704 sub_job->dests[i].count = count;
705 }
706
707 sub_job->fn = segment_complete;
c6ea41fb 708 sub_job->context = sub_job;
1da177e4
LT
709 dispatch_job(sub_job);
710
711 } else if (atomic_dec_and_test(&job->sub_jobs)) {
712
713 /*
340cd444
MP
714 * Queue the completion callback to the kcopyd thread.
715 *
716 * Some callers assume that all the completions are called
717 * from a single thread and don't race with each other.
718 *
719 * We must not call the callback directly here because this
720 * code may not be executing in the thread.
1da177e4 721 */
340cd444
MP
722 push(&kc->complete_jobs, job);
723 wake(kc);
1da177e4
LT
724 }
725}
726
727/*
c6ea41fb 728 * Create some sub jobs to share the work between them.
1da177e4 729 */
c6ea41fb 730static void split_job(struct kcopyd_job *master_job)
1da177e4
LT
731{
732 int i;
733
c6ea41fb 734 atomic_inc(&master_job->kc->nr_jobs);
340cd444 735
c6ea41fb
MP
736 atomic_set(&master_job->sub_jobs, SPLIT_COUNT);
737 for (i = 0; i < SPLIT_COUNT; i++) {
738 master_job[i + 1].master_job = master_job;
739 segment_complete(0, 0u, &master_job[i + 1]);
740 }
1da177e4
LT
741}
742
eb69aca5
HM
743int dm_kcopyd_copy(struct dm_kcopyd_client *kc, struct dm_io_region *from,
744 unsigned int num_dests, struct dm_io_region *dests,
745 unsigned int flags, dm_kcopyd_notify_fn fn, void *context)
1da177e4
LT
746{
747 struct kcopyd_job *job;
70d6c400 748 int i;
1da177e4
LT
749
750 /*
c6ea41fb
MP
751 * Allocate an array of jobs consisting of one master job
752 * followed by SPLIT_COUNT sub jobs.
1da177e4 753 */
08d8757a 754 job = mempool_alloc(kc->job_pool, GFP_NOIO);
d5ffebdd 755 mutex_init(&job->lock);
1da177e4
LT
756
757 /*
758 * set up for the read.
759 */
760 job->kc = kc;
761 job->flags = flags;
762 job->read_err = 0;
763 job->write_err = 0;
1da177e4
LT
764
765 job->num_dests = num_dests;
766 memcpy(&job->dests, dests, sizeof(*dests) * num_dests);
767
b73c67c2
DLM
768 /*
769 * If one of the destination is a host-managed zoned block device,
770 * we need to write sequentially. If one of the destination is a
771 * host-aware device, then leave it to the caller to choose what to do.
772 */
773 if (!test_bit(DM_KCOPYD_WRITE_SEQ, &job->flags)) {
774 for (i = 0; i < job->num_dests; i++) {
775 if (bdev_zoned_model(dests[i].bdev) == BLK_ZONED_HM) {
776 set_bit(DM_KCOPYD_WRITE_SEQ, &job->flags);
777 break;
778 }
779 }
780 }
781
782 /*
783 * If we need to write sequentially, errors cannot be ignored.
784 */
785 if (test_bit(DM_KCOPYD_WRITE_SEQ, &job->flags) &&
786 test_bit(DM_KCOPYD_IGNORE_ERROR, &job->flags))
787 clear_bit(DM_KCOPYD_IGNORE_ERROR, &job->flags);
788
7f069653
MP
789 if (from) {
790 job->source = *from;
791 job->pages = NULL;
792 job->rw = READ;
793 } else {
794 memset(&job->source, 0, sizeof job->source);
795 job->source.count = job->dests[0].count;
796 job->pages = &zero_page_list;
70d6c400
MS
797
798 /*
615ec946 799 * Use WRITE ZEROES to optimize zeroing if all dests support it.
70d6c400 800 */
615ec946 801 job->rw = REQ_OP_WRITE_ZEROES;
70d6c400 802 for (i = 0; i < job->num_dests; i++)
615ec946 803 if (!bdev_write_zeroes_sectors(job->dests[i].bdev)) {
70d6c400
MS
804 job->rw = WRITE;
805 break;
806 }
7f069653 807 }
1da177e4
LT
808
809 job->fn = fn;
810 job->context = context;
c6ea41fb 811 job->master_job = job;
b73c67c2 812 job->write_offset = 0;
1da177e4 813
a705a34a 814 if (job->source.count <= SUB_JOB_SIZE)
1da177e4 815 dispatch_job(job);
1da177e4 816 else {
1da177e4
LT
817 job->progress = 0;
818 split_job(job);
819 }
820
821 return 0;
822}
eb69aca5 823EXPORT_SYMBOL(dm_kcopyd_copy);
1da177e4 824
7f069653
MP
825int dm_kcopyd_zero(struct dm_kcopyd_client *kc,
826 unsigned num_dests, struct dm_io_region *dests,
827 unsigned flags, dm_kcopyd_notify_fn fn, void *context)
828{
829 return dm_kcopyd_copy(kc, NULL, num_dests, dests, flags, fn, context);
830}
831EXPORT_SYMBOL(dm_kcopyd_zero);
832
a6e50b40
MP
833void *dm_kcopyd_prepare_callback(struct dm_kcopyd_client *kc,
834 dm_kcopyd_notify_fn fn, void *context)
835{
836 struct kcopyd_job *job;
837
838 job = mempool_alloc(kc->job_pool, GFP_NOIO);
839
840 memset(job, 0, sizeof(struct kcopyd_job));
841 job->kc = kc;
842 job->fn = fn;
843 job->context = context;
d136f2ef 844 job->master_job = job;
a6e50b40
MP
845
846 atomic_inc(&kc->nr_jobs);
847
848 return job;
849}
850EXPORT_SYMBOL(dm_kcopyd_prepare_callback);
851
852void dm_kcopyd_do_callback(void *j, int read_err, unsigned long write_err)
853{
854 struct kcopyd_job *job = j;
855 struct dm_kcopyd_client *kc = job->kc;
856
857 job->read_err = read_err;
858 job->write_err = write_err;
859
860 push(&kc->complete_jobs, job);
861 wake(kc);
862}
863EXPORT_SYMBOL(dm_kcopyd_do_callback);
864
1da177e4
LT
865/*
866 * Cancels a kcopyd job, eg. someone might be deactivating a
867 * mirror.
868 */
0b56306e 869#if 0
1da177e4
LT
870int kcopyd_cancel(struct kcopyd_job *job, int block)
871{
872 /* FIXME: finish */
873 return -1;
874}
0b56306e 875#endif /* 0 */
1da177e4
LT
876
877/*-----------------------------------------------------------------
945fa4d2 878 * Client setup
1da177e4 879 *---------------------------------------------------------------*/
df5d2e90 880struct dm_kcopyd_client *dm_kcopyd_client_create(struct dm_kcopyd_throttle *throttle)
1da177e4 881{
945fa4d2 882 int r = -ENOMEM;
eb69aca5 883 struct dm_kcopyd_client *kc;
1da177e4 884
1da177e4 885 kc = kmalloc(sizeof(*kc), GFP_KERNEL);
945fa4d2 886 if (!kc)
fa34ce73 887 return ERR_PTR(-ENOMEM);
1da177e4 888
8c0cbc2f
MP
889 spin_lock_init(&kc->job_lock);
890 INIT_LIST_HEAD(&kc->complete_jobs);
891 INIT_LIST_HEAD(&kc->io_jobs);
892 INIT_LIST_HEAD(&kc->pages_jobs);
df5d2e90 893 kc->throttle = throttle;
8c0cbc2f 894
08d8757a 895 kc->job_pool = mempool_create_slab_pool(MIN_JOBS, _job_cache);
945fa4d2
MP
896 if (!kc->job_pool)
897 goto bad_slab;
08d8757a 898
8c0cbc2f 899 INIT_WORK(&kc->kcopyd_work, do_work);
670368a8 900 kc->kcopyd_wq = alloc_workqueue("kcopyd", WQ_MEM_RECLAIM, 0);
945fa4d2
MP
901 if (!kc->kcopyd_wq)
902 goto bad_workqueue;
8c0cbc2f 903
1da177e4 904 kc->pages = NULL;
d0471458 905 kc->nr_reserved_pages = kc->nr_free_pages = 0;
5f43ba29 906 r = client_reserve_pages(kc, RESERVE_PAGES);
945fa4d2
MP
907 if (r)
908 goto bad_client_pages;
1da177e4 909
bda8efec 910 kc->io_client = dm_io_client_create();
373a392b
MB
911 if (IS_ERR(kc->io_client)) {
912 r = PTR_ERR(kc->io_client);
945fa4d2 913 goto bad_io_client;
1da177e4
LT
914 }
915
138728dc
AK
916 init_waitqueue_head(&kc->destroyq);
917 atomic_set(&kc->nr_jobs, 0);
918
fa34ce73 919 return kc;
945fa4d2
MP
920
921bad_io_client:
922 client_free_pages(kc);
923bad_client_pages:
924 destroy_workqueue(kc->kcopyd_wq);
925bad_workqueue:
926 mempool_destroy(kc->job_pool);
927bad_slab:
928 kfree(kc);
929
fa34ce73 930 return ERR_PTR(r);
1da177e4 931}
eb69aca5 932EXPORT_SYMBOL(dm_kcopyd_client_create);
1da177e4 933
eb69aca5 934void dm_kcopyd_client_destroy(struct dm_kcopyd_client *kc)
1da177e4 935{
138728dc
AK
936 /* Wait for completion of all jobs submitted by this client. */
937 wait_event(kc->destroyq, !atomic_read(&kc->nr_jobs));
938
8c0cbc2f
MP
939 BUG_ON(!list_empty(&kc->complete_jobs));
940 BUG_ON(!list_empty(&kc->io_jobs));
941 BUG_ON(!list_empty(&kc->pages_jobs));
942 destroy_workqueue(kc->kcopyd_wq);
373a392b 943 dm_io_client_destroy(kc->io_client);
1da177e4 944 client_free_pages(kc);
08d8757a 945 mempool_destroy(kc->job_pool);
1da177e4 946 kfree(kc);
1da177e4 947}
eb69aca5 948EXPORT_SYMBOL(dm_kcopyd_client_destroy);