~brightbox/ubuntu/raring/lvm2/fix-for-1076304

« back to all changes in this revision

Viewing changes to doc/kernel/kcopyd.txt

  • Committer: Package Import Robot
  • Author(s): Dmitrijs Ledkovs
  • Date: 2012-08-14 14:35:57 UTC
  • mfrom: (3.1.25 sid)
  • Revision ID: package-import@ubuntu.com-20120814143557-93aill2tp3kf3o30
Tags: 2.02.95-4ubuntu1
* Merge from Debian unstable, remaining changes:
  - debian/patches/avoid-dev-block.patch: Prefer any other device name over
    names in /dev/block/ since lvm.conf won't handle this.
  - debian/rules:
    - copy .po file to .pot file for Rosetta (Ubuntu specific).
  - debian/{dmsetup,lvm2}-udeb.install:
    - install initramfs and udev hooks in udebs (Debian bug 504341).
  - auto-start VGs as their PVs are discovered (Ubuntu specific):
    - add debian/tree/lvm2/lib/udev/rules.d/85-lvm2.rules: use watershed plus
      the sledgehammer of vgscan/vgchange to turn on VGs as they come online.
    - debian/tree/lvm2/usr/share/initramfs-tools/scripts/hooks/lvm2:
      - add 85-lvm2.rules to the list of udev rules to copy.
      - depend on udev.
    - debian/control:
      - add versioned Depend on watershed in lvm2 for udev rules.
      - add Depends on watershed-udeb in lvm2-udeb for udev rules.
      - add versioned Depend/Breaks on udev in dmsetup for udev rules.
      - add Depend on initramfs-tools in dmsetup so system is not potentially
        rendered unbootable by out-of-order dpkg configuration.
    - debian/rules:
      - do not install local-top scripts since Ubuntu mounts root using udev.
      - do not install init scripts for lvm2, since udev starts LVM.
    - debian/lvm2.postinst: handle missing lvm2 init script.
    - debian/tree/dmsetup/lib/udev/rules.d/60-persistent-storage-dm.rules:
      watch dm devices for changes with inotify
  - add mountroot failure hooks to help fix bad boots (Debian bug 468115):
    - debian/tree/lvm2/usr/share/initramfs-tools/scripts/init-premount/lvm2
  - remaining changes to upstream event manager packages (Debian bug 514706):
    - debian/rules:
      - enable dmeventd during configure.
    - debian/dmeventd.{8,manpages}: install dmeventd files.
  - rename debian/clvm.defaults to debian/clvm.default so it is installed
    correctly.
  - debian/control: add dmsetup-udeb to libdevmapper1.02.1-udeb recommends.
  - debian/rules: make sure dmsetup and lvm2 initramfs-tools scripts are
    executable.  When the Ubuntu-specific ones are added with a patch,
    they may lose their executable bit.
  - Add and install clvmd resource agent
  - Add dependency on libudev-dev to libdevmapper-dev so that the .pc file
    works.
  - debian/{clvmd.ra,clvm.init}:
    - create /run/lvm if it doesn't exist.
  - debian/clvm.init:
    - exit 3 if not running on status action.
  - Call dh_installman so that our dmeventd manpage actually gets installed
  - Install the missing fsadm manpage.

 * libdevmapper-dev:
  - move .so symlinks and pkgconfig files to multiarched locations.
  - mark libdevmapper-dev M-A: same

 * libdevmapper-event1.02.1:
  - Add Breaks: dmeventd (<< 2.02.95-4ubuntu1) due to debian symbol rename

 * debian/lvm2.{preinst,postinst,postrm}:
  - Implement removal of obsolete /etc/init.d/lvm2 conffile, which
    should not have been re-introduced in Quantal.

 * Dropped Changes, included in Debian:
  - Mostly included packages for upstream event manager (Debian bug 514706).
  - debian/patches/rules-subdir.patch: removed as reordering will cause
    build failure with dmeventd.
  - debian/patches/libdm-event-static.patch: removed as other static libs
    aren't being built anymore either.
  - Update symbols for libdevmapper-event.
  - Update libdevmapper-event, dmeventd descriptions to match Debian
    boilerplate.

 * Disappeared Changes:
  - Don't install documentation in udebs. No diff found, but no docs are
    installed into udebs either.

 * Resurected Changes:
  - corrected dropping the wrong init script. Now clvm.init is shipped
    and lvm2.init is dropped in favor of udev rules as per original
    intention (LP: #1037033).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
kcopyd
 
2
======
 
3
 
 
4
Kcopyd provides the ability to copy a range of sectors from one block-device
 
5
to one or more other block-devices, with an asynchronous completion
 
6
notification. It is used by dm-snapshot and dm-mirror.
 
7
 
 
8
Users of kcopyd must first create a client and indicate how many memory pages
 
9
to set aside for their copy jobs. This is done with a call to
 
10
kcopyd_client_create().
 
11
 
 
12
   int kcopyd_client_create(unsigned int num_pages,
 
13
                            struct kcopyd_client **result);
 
14
 
 
15
To start a copy job, the user must set up io_region structures to describe
 
16
the source and destinations of the copy. Each io_region indicates a
 
17
block-device along with the starting sector and size of the region. The source
 
18
of the copy is given as one io_region structure, and the destinations of the
 
19
copy are given as an array of io_region structures.
 
20
 
 
21
   struct io_region {
 
22
      struct block_device *bdev;
 
23
      sector_t sector;
 
24
      sector_t count;
 
25
   };
 
26
 
 
27
To start the copy, the user calls kcopyd_copy(), passing in the client
 
28
pointer, pointers to the source and destination io_regions, the name of a
 
29
completion callback routine, and a pointer to some context data for the copy.
 
30
 
 
31
   int kcopyd_copy(struct kcopyd_client *kc, struct io_region *from,
 
32
                   unsigned int num_dests, struct io_region *dests,
 
33
                   unsigned int flags, kcopyd_notify_fn fn, void *context);
 
34
 
 
35
   typedef void (*kcopyd_notify_fn)(int read_err, unsigned int write_err,
 
36
                                    void *context);
 
37
 
 
38
When the copy completes, kcopyd will call the user's completion routine,
 
39
passing back the user's context pointer. It will also indicate if a read or
 
40
write error occurred during the copy.
 
41
 
 
42
When a user is done with all their copy jobs, they should call
 
43
kcopyd_client_destroy() to delete the kcopyd client, which will release the
 
44
associated memory pages.
 
45
 
 
46
   void kcopyd_client_destroy(struct kcopyd_client *kc);
 
47