blob: 5e54458e920f36466a29d83ccbe913a03f347a01 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +01002 * Copyright (C) 2001 - 2003 Sistina Software
3 * Copyright (C) 2004 - 2008 Red Hat, Inc. All rights reserved.
4 *
5 * kcopyd provides a simple interface for copying an area of one
6 * block-device to one or more other block-devices, either synchronous
7 * or with an asynchronous completion notification.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPL.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010012#ifndef _LINUX_DM_KCOPYD_H
13#define _LINUX_DM_KCOPYD_H
14
15#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Alasdair G Kergona765e202008-04-24 22:02:01 +010017#include <linux/dm-io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19/* FIXME: make this configurable */
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010020#define DM_KCOPYD_MAX_REGIONS 8
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010022#define DM_KCOPYD_IGNORE_ERROR 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24/*
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010025 * To use kcopyd you must first create a dm_kcopyd_client object.
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 */
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010027struct dm_kcopyd_client;
Mikulas Patockafa34ce72011-05-29 13:03:13 +010028struct dm_kcopyd_client *dm_kcopyd_client_create(void);
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010029void dm_kcopyd_client_destroy(struct dm_kcopyd_client *kc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31/*
32 * Submit a copy job to kcopyd. This is built on top of the
33 * previous three fns.
34 *
35 * read_err is a boolean,
36 * write_err is a bitset, with 1 bit for each destination region
37 */
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010038typedef void (*dm_kcopyd_notify_fn)(int read_err, unsigned long write_err,
39 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010041int dm_kcopyd_copy(struct dm_kcopyd_client *kc, struct dm_io_region *from,
42 unsigned num_dests, struct dm_io_region *dests,
43 unsigned flags, dm_kcopyd_notify_fn fn, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Mikulas Patockaa6e50b42011-08-02 12:32:04 +010045/*
46 * Prepare a callback and submit it via the kcopyd thread.
47 *
48 * dm_kcopyd_prepare_callback allocates a callback structure and returns it.
49 * It must not be called from interrupt context.
50 * The returned value should be passed into dm_kcopyd_do_callback.
51 *
52 * dm_kcopyd_do_callback submits the callback.
53 * It may be called from interrupt context.
54 * The callback is issued from the kcopyd thread.
55 */
56void *dm_kcopyd_prepare_callback(struct dm_kcopyd_client *kc,
57 dm_kcopyd_notify_fn fn, void *context);
58void dm_kcopyd_do_callback(void *job, int read_err, unsigned long write_err);
59
Heinz Mauelshageneb69aca2008-04-24 21:43:19 +010060#endif /* __KERNEL__ */
61#endif /* _LINUX_DM_KCOPYD_H */