kernel-fxtec-pro1x/Documentation/device-mapper
Paul Lawrence 45bc7d86e7 ANDROID: dm-bow: Add dm-bow feature
Based on https://www.redhat.com/archives/dm-devel/2019-March/msg00025.html

Third version of dm-bow. Key changes:

Free list added
Support for block sizes other than 4k
Handles writes during trim phase, and overlapping trims
Integer overflow error
Support trims even if underlying device doesn't
Numerous small bug fixes

bow == backup on write

USE CASE:

dm-bow takes a snapshot of an existing file system before mounting.
The user may, before removing the device, commit the snapshot.
Alternatively the user may remove the device and then run a command
line utility to restore the device to its original state.

dm-bow does not require an external device

dm-bow efficiently uses all the available free space on the file system.

IMPLEMENTATION:

dm-bow can be in one of three states.

In state one, the free blocks on the device are identified by issuing
an FSTRIM to the filesystem.

In state two, any writes cause the overwritten data to be backup up
to the available free space. While in this state, the device can be
restored by unmounting the filesystem, removing the dm-bow device
and running a usermode tool over the underlying device.

In state three, the changes are committed, dm-bow is in pass-through
mode and the drive can no longer be restored.

It is planned to use this driver to enable restoration of a failed
update attempt on Android devices using ext4.

Test: Can boot Android with userdata mounted on this device. Can commit
userdata after SUW has run. Can then reboot, make changes and roll back.

Known issues:

Mutex is held around entire flush operation, including lengthy I/O. Plan
is to convert to state machine with pending queues.

Interaction with block encryption is unknown, especially with respect
to sector 0.

Bug: 119769411
Bug: 129280212
Test: Dogfooded on Wahoo.
      Ran under Cuttlefish, running VtsKernelBowTest &
      VtsKernelCheckpointTest tests against 4.19, 4.14 & 4.9 kernels
Change-Id: Id70988bbd797ebe3e76fc175094388b423c8da8c
Signed-off-by: Paul Lawrence <paullawrence@google.com>
2019-03-25 19:56:09 +00:00
..
cache-policies.txt dm cache: fix grammar in cache-policies.txt 2018-01-17 09:16:07 -05:00
cache.txt dm cache: Documentation: update default migration_throttling value 2018-01-30 16:55:47 -05:00
delay.txt dm delay: add flush as a third class of IO 2018-07-27 15:24:19 -04:00
dm-bow.txt ANDROID: dm-bow: Add dm-bow feature 2019-03-25 19:56:09 +00:00
dm-crypt.txt dm crypt: optionally support larger encryption sector size 2017-03-24 15:54:21 -04:00
dm-flakey.txt block: rename bio bi_rw to bi_opf 2016-08-07 14:41:02 -06:00
dm-integrity.txt dm integrity: recalculate checksums on creation 2018-07-27 15:24:27 -04:00
dm-io.txt
dm-log.txt
dm-queue-length.txt
dm-raid.txt dm raid: bump target version, update comments and documentation 2018-09-06 17:07:58 -04:00
dm-service-time.txt
dm-uevent.txt
dm-zoned.txt dm zoned: drive-managed zoned block device target 2017-06-19 11:05:20 -04:00
era.txt
kcopyd.txt
linear.txt Documentation/device-mapper: s/getsize/getsz/ 2016-12-14 10:54:27 +01:00
log-writes.txt block, drivers, fs: rename REQ_FLUSH to REQ_PREFLUSH 2016-06-07 13:41:38 -06:00
persistent-data.txt
snapshot.txt dm snapshot: improve documentation relative to origin suspend requirements 2018-01-17 09:16:06 -05:00
statistics.txt
striped.txt Documentation/device-mapper: s/getsize/getsz/ 2016-12-14 10:54:27 +01:00
switch.txt Documentation/device-mapper: s/getsize/getsz/ 2016-12-14 10:54:27 +01:00
thin-provisioning.txt dm thin: include metadata_low_watermark threshold in pool status 2018-07-30 11:49:08 -04:00
unstriped.txt dm: add unstriped target 2018-01-17 09:16:00 -05:00
verity.txt dm verity: add 'check_at_most_once' option to only validate hashes once 2018-04-03 15:04:29 -04:00
writecache.txt dm writecache: support optional offset for start of device 2018-07-02 16:14:02 -04:00
zero.txt