summaryrefslogtreecommitdiff
path: root/python/examples/kaitai/lvm2.py
blob: adb0ed7d23392447baf6ecc50f205bfbf245f1ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild

from pkg_resources import parse_version
from .kaitaistruct import __version__ as ks_version, KaitaiStruct, KaitaiStream, BytesIO
import collections
from enum import Enum


if parse_version(ks_version) < parse_version('0.7'):
    raise Exception("Incompatible Kaitai Struct Python API: 0.7 or later is required, but you have %s" % (ks_version))

class Lvm2(KaitaiStruct):
    """### Building a test file
    
    ```
    dd if=/dev/zero of=image.img bs=512 count=$(( 4 * 1024 * 2 ))
    sudo losetup /dev/loop1 image.img
    sudo pvcreate /dev/loop1
    sudo vgcreate vg_test /dev/loop1
    sudo lvcreate --name lv_test1 vg_test
    sudo losetup -d /dev/loop1
    ```
    
    .. seealso::
       Source - https://github.com/libyal/libvslvm/blob/master/documentation/Logical%20Volume%20Manager%20(LVM)%20format.asciidoc
    """
    SEQ_FIELDS = ["pv"]
    def __init__(self, _io, _parent=None, _root=None):
        self._io = _io
        self._parent = _parent
        self._root = _root if _root else self
        self._debug = collections.defaultdict(dict)

    def _read(self):
        self._debug['pv']['start'] = self._io.pos()
        self.pv = self._root.PhysicalVolume(self._io, self, self._root)
        self.pv._read()
        self._debug['pv']['end'] = self._io.pos()

    class PhysicalVolume(KaitaiStruct):
        SEQ_FIELDS = ["empty_sector", "label"]
        def __init__(self, _io, _parent=None, _root=None):
            self._io = _io
            self._parent = _parent
            self._root = _root if _root else self
            self._debug = collections.defaultdict(dict)

        def _read(self):
            self._debug['empty_sector']['start'] = self._io.pos()
            self.empty_sector = self._io.read_bytes(self._root.sector_size)
            self._debug['empty_sector']['end'] = self._io.pos()
            self._debug['label']['start'] = self._io.pos()
            self.label = self._root.PhysicalVolume.Label(self._io, self, self._root)
            self.label._read()
            self._debug['label']['end'] = self._io.pos()

        class Label(KaitaiStruct):
            SEQ_FIELDS = ["label_header", "volume_header"]
            def __init__(self, _io, _parent=None, _root=None):
                self._io = _io
                self._parent = _parent
                self._root = _root if _root else self
                self._debug = collections.defaultdict(dict)

            def _read(self):
                self._debug['label_header']['start'] = self._io.pos()
                self.label_header = self._root.PhysicalVolume.Label.LabelHeader(self._io, self, self._root)
                self.label_header._read()
                self._debug['label_header']['end'] = self._io.pos()
                self._debug['volume_header']['start'] = self._io.pos()
                self.volume_header = self._root.PhysicalVolume.Label.VolumeHeader(self._io, self, self._root)
                self.volume_header._read()
                self._debug['volume_header']['end'] = self._io.pos()

            class LabelHeader(KaitaiStruct):
                SEQ_FIELDS = ["signature", "sector_number", "checksum", "label_header_"]
                def __init__(self, _io, _parent=None, _root=None):
                    self._io = _io
                    self._parent = _parent
                    self._root = _root if _root else self
                    self._debug = collections.defaultdict(dict)

                def _read(self):
                    self._debug['signature']['start'] = self._io.pos()
                    self.signature = self._io.ensure_fixed_contents(b"\x4C\x41\x42\x45\x4C\x4F\x4E\x45")
                    self._debug['signature']['end'] = self._io.pos()
                    self._debug['sector_number']['start'] = self._io.pos()
                    self.sector_number = self._io.read_u8le()
                    self._debug['sector_number']['end'] = self._io.pos()
                    self._debug['checksum']['start'] = self._io.pos()
                    self.checksum = self._io.read_u4le()
                    self._debug['checksum']['end'] = self._io.pos()
                    self._debug['label_header_']['start'] = self._io.pos()
                    self.label_header_ = self._root.PhysicalVolume.Label.LabelHeader.LabelHeader(self._io, self, self._root)
                    self.label_header_._read()
                    self._debug['label_header_']['end'] = self._io.pos()

                class LabelHeader(KaitaiStruct):
                    SEQ_FIELDS = ["data_offset", "type_indicator"]
                    def __init__(self, _io, _parent=None, _root=None):
                        self._io = _io
                        self._parent = _parent
                        self._root = _root if _root else self
                        self._debug = collections.defaultdict(dict)

                    def _read(self):
                        self._debug['data_offset']['start'] = self._io.pos()
                        self.data_offset = self._io.read_u4le()
                        self._debug['data_offset']['end'] = self._io.pos()
                        self._debug['type_indicator']['start'] = self._io.pos()
                        self.type_indicator = self._io.ensure_fixed_contents(b"\x4C\x56\x4D\x32\x20\x30\x30\x31")
                        self._debug['type_indicator']['end'] = self._io.pos()



            class VolumeHeader(KaitaiStruct):
                SEQ_FIELDS = ["id", "size", "data_area_descriptors", "metadata_area_descriptors"]
                def __init__(self, _io, _parent=None, _root=None):
                    self._io = _io
                    self._parent = _parent
                    self._root = _root if _root else self
                    self._debug = collections.defaultdict(dict)

                def _read(self):
                    self._debug['id']['start'] = self._io.pos()
                    self.id = (self._io.read_bytes(32)).decode(u"ascii")
                    self._debug['id']['end'] = self._io.pos()
                    self._debug['size']['start'] = self._io.pos()
                    self.size = self._io.read_u8le()
                    self._debug['size']['end'] = self._io.pos()
                    self._debug['data_area_descriptors']['start'] = self._io.pos()
                    self.data_area_descriptors = []
                    i = 0
                    while True:
                        if not 'arr' in self._debug['data_area_descriptors']:
                            self._debug['data_area_descriptors']['arr'] = []
                        self._debug['data_area_descriptors']['arr'].append({'start': self._io.pos()})
                        _t_data_area_descriptors = self._root.PhysicalVolume.Label.VolumeHeader.DataAreaDescriptor(self._io, self, self._root)
                        _t_data_area_descriptors._read()
                        _ = _t_data_area_descriptors
                        self.data_area_descriptors.append(_)
                        self._debug['data_area_descriptors']['arr'][len(self.data_area_descriptors) - 1]['end'] = self._io.pos()
                        if  ((_.size != 0) and (_.offset != 0)) :
                            break
                        i += 1
                    self._debug['data_area_descriptors']['end'] = self._io.pos()
                    self._debug['metadata_area_descriptors']['start'] = self._io.pos()
                    self.metadata_area_descriptors = []
                    i = 0
                    while True:
                        if not 'arr' in self._debug['metadata_area_descriptors']:
                            self._debug['metadata_area_descriptors']['arr'] = []
                        self._debug['metadata_area_descriptors']['arr'].append({'start': self._io.pos()})
                        _t_metadata_area_descriptors = self._root.PhysicalVolume.Label.VolumeHeader.MetadataAreaDescriptor(self._io, self, self._root)
                        _t_metadata_area_descriptors._read()
                        _ = _t_metadata_area_descriptors
                        self.metadata_area_descriptors.append(_)
                        self._debug['metadata_area_descriptors']['arr'][len(self.metadata_area_descriptors) - 1]['end'] = self._io.pos()
                        if  ((_.size != 0) and (_.offset != 0)) :
                            break
                        i += 1
                    self._debug['metadata_area_descriptors']['end'] = self._io.pos()

                class DataAreaDescriptor(KaitaiStruct):
                    SEQ_FIELDS = ["offset", "size"]
                    def __init__(self, _io, _parent=None, _root=None):
                        self._io = _io
                        self._parent = _parent
                        self._root = _root if _root else self
                        self._debug = collections.defaultdict(dict)

                    def _read(self):
                        self._debug['offset']['start'] = self._io.pos()
                        self.offset = self._io.read_u8le()
                        self._debug['offset']['end'] = self._io.pos()
                        self._debug['size']['start'] = self._io.pos()
                        self.size = self._io.read_u8le()
                        self._debug['size']['end'] = self._io.pos()

                    @property
                    def data(self):
                        if hasattr(self, '_m_data'):
                            return self._m_data if hasattr(self, '_m_data') else None

                        if self.size != 0:
                            _pos = self._io.pos()
                            self._io.seek(self.offset)
                            self._debug['_m_data']['start'] = self._io.pos()
                            self._m_data = (self._io.read_bytes(self.size)).decode(u"ascii")
                            self._debug['_m_data']['end'] = self._io.pos()
                            self._io.seek(_pos)

                        return self._m_data if hasattr(self, '_m_data') else None


                class MetadataAreaDescriptor(KaitaiStruct):
                    SEQ_FIELDS = ["offset", "size"]
                    def __init__(self, _io, _parent=None, _root=None):
                        self._io = _io
                        self._parent = _parent
                        self._root = _root if _root else self
                        self._debug = collections.defaultdict(dict)

                    def _read(self):
                        self._debug['offset']['start'] = self._io.pos()
                        self.offset = self._io.read_u8le()
                        self._debug['offset']['end'] = self._io.pos()
                        self._debug['size']['start'] = self._io.pos()
                        self.size = self._io.read_u8le()
                        self._debug['size']['end'] = self._io.pos()

                    @property
                    def data(self):
                        if hasattr(self, '_m_data'):
                            return self._m_data if hasattr(self, '_m_data') else None

                        if self.size != 0:
                            _pos = self._io.pos()
                            self._io.seek(self.offset)
                            self._debug['_m_data']['start'] = self._io.pos()
                            self._raw__m_data = self._io.read_bytes(self.size)
                            io = KaitaiStream(BytesIO(self._raw__m_data))
                            self._m_data = self._root.PhysicalVolume.Label.VolumeHeader.MetadataArea(io, self, self._root)
                            self._m_data._read()
                            self._debug['_m_data']['end'] = self._io.pos()
                            self._io.seek(_pos)

                        return self._m_data if hasattr(self, '_m_data') else None


                class MetadataArea(KaitaiStruct):
                    """According to `[REDHAT]` the metadata area is a circular buffer. New metadata is appended to the old metadata and then the pointer to the start of it is updated. The metadata area, therefore, can contain copies of older versions of the metadata."""
                    SEQ_FIELDS = ["header"]
                    def __init__(self, _io, _parent=None, _root=None):
                        self._io = _io
                        self._parent = _parent
                        self._root = _root if _root else self
                        self._debug = collections.defaultdict(dict)

                    def _read(self):
                        self._debug['header']['start'] = self._io.pos()
                        self.header = self._root.PhysicalVolume.Label.VolumeHeader.MetadataArea.MetadataAreaHeader(self._io, self, self._root)
                        self.header._read()
                        self._debug['header']['end'] = self._io.pos()

                    class MetadataAreaHeader(KaitaiStruct):
                        SEQ_FIELDS = ["checksum", "signature", "version", "metadata_area_offset", "metadata_area_size", "raw_location_descriptors"]
                        def __init__(self, _io, _parent=None, _root=None):
                            self._io = _io
                            self._parent = _parent
                            self._root = _root if _root else self
                            self._debug = collections.defaultdict(dict)

                        def _read(self):
                            self._debug['checksum']['start'] = self._io.pos()
                            self.checksum = self._root.PhysicalVolume.Label.VolumeHeader.MetadataArea.MetadataAreaHeader(self._io, self, self._root)
                            self.checksum._read()
                            self._debug['checksum']['end'] = self._io.pos()
                            self._debug['signature']['start'] = self._io.pos()
                            self.signature = self._io.ensure_fixed_contents(b"\x20\x4C\x56\x4D\x32\x20\x78\x5B\x35\x41\x25\x72\x30\x4E\x2A\x3E")
                            self._debug['signature']['end'] = self._io.pos()
                            self._debug['version']['start'] = self._io.pos()
                            self.version = self._io.read_u4le()
                            self._debug['version']['end'] = self._io.pos()
                            self._debug['metadata_area_offset']['start'] = self._io.pos()
                            self.metadata_area_offset = self._io.read_u8le()
                            self._debug['metadata_area_offset']['end'] = self._io.pos()
                            self._debug['metadata_area_size']['start'] = self._io.pos()
                            self.metadata_area_size = self._io.read_u8le()
                            self._debug['metadata_area_size']['end'] = self._io.pos()
                            self._debug['raw_location_descriptors']['start'] = self._io.pos()
                            self.raw_location_descriptors = []
                            i = 0
                            while True:
                                if not 'arr' in self._debug['raw_location_descriptors']:
                                    self._debug['raw_location_descriptors']['arr'] = []
                                self._debug['raw_location_descriptors']['arr'].append({'start': self._io.pos()})
                                _t_raw_location_descriptors = self._root.PhysicalVolume.Label.VolumeHeader.MetadataArea.MetadataAreaHeader.RawLocationDescriptor(self._io, self, self._root)
                                _t_raw_location_descriptors._read()
                                _ = _t_raw_location_descriptors
                                self.raw_location_descriptors.append(_)
                                self._debug['raw_location_descriptors']['arr'][len(self.raw_location_descriptors) - 1]['end'] = self._io.pos()
                                if  ((_.offset != 0) and (_.size != 0) and (_.checksum != 0)) :
                                    break
                                i += 1
                            self._debug['raw_location_descriptors']['end'] = self._io.pos()

                        class RawLocationDescriptor(KaitaiStruct):
                            """The data area size can be 0. It is assumed it represents the remaining  available data."""

                            class RawLocationDescriptorFlags(Enum):
                                raw_location_ignored = 1
                            SEQ_FIELDS = ["offset", "size", "checksum", "flags"]
                            def __init__(self, _io, _parent=None, _root=None):
                                self._io = _io
                                self._parent = _parent
                                self._root = _root if _root else self
                                self._debug = collections.defaultdict(dict)

                            def _read(self):
                                self._debug['offset']['start'] = self._io.pos()
                                self.offset = self._io.read_u8le()
                                self._debug['offset']['end'] = self._io.pos()
                                self._debug['size']['start'] = self._io.pos()
                                self.size = self._io.read_u8le()
                                self._debug['size']['end'] = self._io.pos()
                                self._debug['checksum']['start'] = self._io.pos()
                                self.checksum = self._io.read_u4le()
                                self._debug['checksum']['end'] = self._io.pos()
                                self._debug['flags']['start'] = self._io.pos()
                                self.flags = KaitaiStream.resolve_enum(self._root.PhysicalVolume.Label.VolumeHeader.MetadataArea.MetadataAreaHeader.RawLocationDescriptor.RawLocationDescriptorFlags, self._io.read_u4le())
                                self._debug['flags']['end'] = self._io.pos()


                        @property
                        def metadata(self):
                            if hasattr(self, '_m_metadata'):
                                return self._m_metadata if hasattr(self, '_m_metadata') else None

                            _pos = self._io.pos()
                            self._io.seek(self.metadata_area_offset)
                            self._debug['_m_metadata']['start'] = self._io.pos()
                            self._m_metadata = self._io.read_bytes(self.metadata_area_size)
                            self._debug['_m_metadata']['end'] = self._io.pos()
                            self._io.seek(_pos)
                            return self._m_metadata if hasattr(self, '_m_metadata') else None






    @property
    def sector_size(self):
        if hasattr(self, '_m_sector_size'):
            return self._m_sector_size if hasattr(self, '_m_sector_size') else None

        self._m_sector_size = 512
        return self._m_sector_size if hasattr(self, '_m_sector_size') else None