ceph/doc/dev/rbd-diff.rst
Jason Dillaman f9ba711c30 dev/rbd-diff: clarify encoding of image size
Fixes: #11562
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2015-05-22 11:18:09 -04:00

70 lines
964 B
ReStructuredText

RBD Incremental Backup
======================
This is a simple streaming file format for representing a diff between
two snapshots (or a snapshot and the head) of an RBD image.
Header
~~~~~~
"rbd diff v1\\n"
Metadata records
~~~~~~~~~~~~~~~~
Every record has a one byte "tag" that identifies the record type,
followed by some other data.
Metadata records come in the first part of the image. Order is not
important, as long as all the metadata records come before the data
records.
From snap
---------
- u8: 'f'
- le32: snap name length
- snap name
To snap
-------
- u8: 't'
- le32: snap name length
- snap name
Size
----
- u8: 's'
- le64: (ending) image size
Data Records
~~~~~~~~~~~~
These records come in the second part of the sequence.
Updated data
------------
- u8: 'w'
- le64: offset
- le64: length
- length bytes of actual data
Zero data
---------
- u8: 'z'
- le64: offset
- le64: length
Final Record
~~~~~~~~~~~~
End
---
- u8: 'e'