Module: LdmScanner

Defined in:
lib/VolumeManager/MiqLdm.rb

Constant Summary collapse

LDM_SECTOR_SIZE = 
512
LDM_PARTITION_TYPE = 
66
PRIVHEAD_OFFSET = 
6 * LDM_SECTOR_SIZE
PRIVHEAD =

On disk, all numbers are in big-endian format.

[
  'a8',     'signature',      # 8
  'N',      'unknown_1',      # 4
  'n',      'ver_major',      # 2
  'n',      'ver_minor',      # 2
  'Q',      'timestamp',      # 8
  'Q',      'unknown_2',      # 8 number ?
  'Q',      'unknown_3',      # 8 size ?
  'Q',      'unknown_4',      # 8 size ?
  'a64',      'disk_id',        # 64 zero padded
  'a64',      'host_id',        # 64 zero padded
  'a64',      'diskgroup_id',     # 64 zero padded
  'a32',      'diskgroup_name',   # 32 zero padded
  'a2',     'unknown_5',      # 2
  'a9',     'unknown_6',      # 9 zeros
  'N',      'logical_disk_start_H', # 8
  'N',      'logical_disk_start_L', # "
  'N',      'logical_disk_size_H',  # 8
  'N',      'logical_disk_size_L',  # "
  'N',      'db_start_H',     # 8
  'N',      'db_start_L',     # "
  'N',      'db_size_H',      # 8
  'N',      'db_size_L',      # "
  'N',      'num_tocs_H',     # 8
  'N',      'num_tocs_L',     # "
  'N',      'toc_size_H',     # 8
  'N',      'toc_size_L',     # "
  'N',      'num_configs',      # 4
  'N',      'num_logs',       # 4
  'N',      'config_size_H',    # 8
  'N',      'config_size_L',    # "
  'N',      'log_size_H',     # 8
  'N',      'log_size_L',     # "
  'N',      'disk_signature',   # 4
  'C16',      'disk_set_guid',    # 16
  'C16',      'disk_set_guid2',   # 16
  "C#{512 - 391}",  'padding'       # Pad to 512 bytes (sector size)
]
TBLOCK_BLOCK = 
[1, 2, 2045, 2046]
TOCBLOCK = 
[
  'a8',     'signature',
  'N',      'sequence1',
  'a4',     'unknown1',
  'N',      'sequence2',
  'a16',      'unknown2',
  'a10',      'bitmap1_name',
  'N',      'bitmap1_start_H',
  'N',      'bitmap1_start_L',
  'N',      'bitmap1_size_H',
  'N',      'bitmap1_size_L',
  'N',      'bitmap1_flags_H',
  'N',      'bitmap1_flags_L',
  'a10',      'bitmap2_name',
  'N',      'bitmap2_start_H',
  'N',      'bitmap2_start_L',
  'N',      'bitmap2_size_H',
  'N',      'bitmap2_size_L',
  'N',      'bitmap2_flags_H',
  'N',      'bitmap2_flags_L',
  "C#{512 - 104}",  'padding'
]
VMDB = 
[
  'a4',     'signature',
  'N',      'sequence',
  'N',      'vblk_size',
  'N',      'vblk_offset',
  'n',      'unknown1',
  'n',      'ver_major',
  'n',      'ver_minor',
  'a31',      'dg_name',
  'a64',      'dg_guid',
  'N',      'committed_seq_H',
  'N',      'committed_seq_L',
  'N',      'pending_seq_H',
  'N',      'pending_seq_L',
  'a56',      'unknown2',
  'N',      'timestamp',
  "C#{512 - 193}",  'padding'
]
VBLK = 
[
  'a4',     'signature',
  'N',      'vmdb_seq',
  'N',      'grpnum',
  'n',      'record',
  'n',      'nrecords',
  'n',      'update_status',
  'C',      'flags',
  'C',      'rec_type',
  'N',      'data_length',
  "a#{128 - 24}", 'padding'
]
VBT_NONE =

VBLOCK types.

0x00
VBT_COMPONENT = 
0x32
VBT_PARTITION = 
0x33
VBT_DISKV1 = 
0x34
VBT_DISKGROUPV1 = 
0x35
VBT_DISKV2 = 
0x44
VBT_DISKGROUPV2 = 
0x45
VBT_VOLUME = 
0x51
VBLK_TYPES = 
{
  VBT_NONE        => "NONE",
  VBT_COMPONENT   => "Component",
  VBT_PARTITION   => "Partition",
  VBT_DISKV1      => "Disk v1",
  VBT_DISKGROUPV1 => "Disk Group v1",
  VBT_DISKV2      => "Disk v2",
  VBT_DISKGROUPV2 => "Disk Group v2",
  VBT_VOLUME      => "Volume"
}

Class Method Summary collapse

Class Method Details

.dumpPrivhead(ph) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/VolumeManager/MiqLdm.rb', line 311

def self.dumpPrivhead(ph)
  puts
  puts "PRIVHEAD:"
  puts "\tsignature:          #{ph.signature}"
  puts "\tver_major:          #{ph.ver_major}"
  puts "\tver_minor:          #{ph.ver_minor}"
  puts "\tdisk_id:            #{ph.disk_id}"
  puts "\thost_id:            #{ph.host_id}"
  puts "\tdiskgroup_id:       #{ph.diskgroup_id}"
  puts "\tdiskgroup_name:     #{ph.diskgroup_name}"
  puts "\tlogical_disk_start: #{ph.logical_disk_start}"
  puts "\tlogical_disk_size:  #{ph.logical_disk_size}"
  puts "\tdb_start:           #{ph.db_start}"
  puts "\tdb_size:            #{ph.db_size}"
  puts "\tnum_tocs:           #{ph.num_tocs}"
  puts "\ttoc_size:           #{ph.toc_size}"
  puts "\tnum_configs:        #{ph.num_configs}"
  puts "\tconfig_size:        #{ph.config_size}"
  puts "\tnum_logs:           #{ph.num_logs}"
  puts "\tlog_size:           #{ph.log_size}"
  puts "\tdisk_signature:     #{ph.disk_signature}"
  puts "\tdisk_set_guid:      #{ph.disk_set_guid}"
  puts "\tdisk_set_guid2:     #{ph.disk_set_guid2}"
end

.dumpTocblock(tb) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/VolumeManager/MiqLdm.rb', line 336

def self.dumpTocblock(tb)
  puts
  puts "TOCBLOCK:"
  puts "\tsignature:          #{tb.signature}"
  puts "\tsequence1:          #{tb.sequence1}"
  puts "\tsequence2:          #{tb.sequence2}"
  puts "\tbitmap1_name:       #{tb.bitmap1_name}"
  puts "\tbitmap1_start:      #{tb.bitmap1_start}"
  puts "\tbitmap2_name:       #{tb.bitmap2_name}"
  puts "\tbitmap2_start:      #{tb.bitmap2_start}"
end

.dumpVblk(vb, indent = "") ⇒ Object 



378
379
380
381
382
383
 
# File 'lib/VolumeManager/MiqLdm.rb', line 378

def self.dumpVblk(vb, indent = "")
  return if vb.data_length == 0
  puts
  puts "#{indent}VBLK: #{VBLK_TYPES[vb.rec_type]}"
  vb.marshal_dump.each { |k, v| printf("#{indent}\t%-15s: #{v}\n", k) unless v.kind_of?(Array) || v.kind_of?(OpenStruct) }
end

.dumpVblk_old(vb) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/VolumeManager/MiqLdm.rb', line 363

def self.dumpVblk_old(vb)
  return if vb.data_length == 0
  puts
  puts "VBLK:"
  puts   "\tsignature:          #{vb.signature}"
  puts   "\tvmdb_seq:           #{vb.vmdb_seq}"
  puts   "\tgrpnum:             #{vb.grpnum}"
  puts   "\trecord:             #{vb.record}"
  puts   "\tnrecords:           #{vb.nrecords}"
  puts   "\tupdate_status:      #{vb.update_status}"
  printf("\trec_type:           0x%x\t%s\n", vb.rec_type & 0xff, VBLK_TYPES[vb.rec_type & 0xff])
  puts   "\tdata_length:        #{vb.data_length}"
  puts  "\tpadding.length:    #{vb.padding.length}"
end

.dumpVmdb(vmdb) ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/VolumeManager/MiqLdm.rb', line 348

def self.dumpVmdb(vmdb)
  puts
  puts "VMDB:"
  puts "\tsignature:          #{vmdb.signature}"
  puts "\tsequence:           #{vmdb.sequence}"
  puts "\tvblk_size:          #{vmdb.vblk_size}"
  puts "\tvblk_offset:        #{vmdb.vblk_offset}"
  puts "\tver_major:          #{vmdb.ver_major}"
  puts "\tver_minor:          #{vmdb.ver_minor}"
  puts "\tdg_name:            #{vmdb.dg_name}"
  puts "\tdg_guid:            #{vmdb.dg_guid}"
  puts "\tcommitted_seq:      #{vmdb.committed_seq}"
  puts "\tpending_seq:        #{vmdb.pending_seq}"
end

.getChunk(data) ⇒ Object

def self.readStruct



209
210
211
212
 
# File 'lib/VolumeManager/MiqLdm.rb', line 209

def self.getChunk(data)
  len = data.slice!(0, 1).unpack("C")[0]
  data.slice!(0, len)
end

.getNBO8(data) ⇒ Object 



220
221
222
223
 
# File 'lib/VolumeManager/MiqLdm.rb', line 220

def self.getNBO8(data)
  h, l = data.slice!(0, 8).unpack("N2")
  ((h << 32) | l)
end

.getNum(data) ⇒ Object 



214
215
216
217
218
 
# File 'lib/VolumeManager/MiqLdm.rb', line 214

def self.getNum(data)
  n = 0
  getChunk(data).each_byte { |b| n = (n << 8) | b }
  (n)
end

.readStruct(d, struct) ⇒ Object 



199
200
201
202
203
204
205
206
207
 
# File 'lib/VolumeManager/MiqLdm.rb', line 199

def self.readStruct(d, struct)
  h = BinaryStruct.decode(d.read(BinaryStruct.sizeof(struct)), struct)
  h.keys.delete_if { |k| !(/.*_H/ =~ k) }.each do |k|
    (nk = k.dup)[/_H$/] = ""
    lk = nk + "_L"
    h[nk] = (h[k] << 32) | h[lk]
  end
  OpenStruct.new(h)
end

.readVBLK(disk, ph) ⇒ Object 



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
 
# File 'lib/VolumeManager/MiqLdm.rb', line 225

def self.readVBLK(disk, ph)
  vblk = LdmScanner.readStruct(disk, LdmScanner::VBLK)
  return if vblk.data_length == 0
  buf = vblk.padding

  vblk.vobject_id   = getNum(buf)
  vblk.name     = getChunk(buf)

  case vblk.rec_type
  when VBT_NONE     # NONE
  when VBT_COMPONENT    # Component
    vblk.children   = []
    vblk.volume_state = getChunk(buf)
    vblk.component_type = BinaryStruct.stepDecode(buf, "C")
    BinaryStruct.stepDecode(buf, "C4")
    vblk.num_children = getNum(buf)
    BinaryStruct.stepDecode(buf, "C16")
    vblk.parent_id    = getNum(buf)
    BinaryStruct.stepDecode(buf, "C")
    if vblk.flags != 0
      vblk.stripe_size  = getNum(buf)
      vblk.num_col    = getNum(buf)
    end

  when VBT_PARTITION    # Partition
    BinaryStruct.stepDecode(buf, "C12")
    vblk.start      = getNBO8(buf)
    vblk.volume_offset  = getNBO8(buf)
    vblk.size     = getNum(buf)
    vblk.parent_id    = getNum(buf)
    vblk.disk_id    = getNum(buf)
    vblk.comp_part_idx  = getNum(buf) if vblk.flags == 0x08

  when VBT_DISKV1     # Disk v1
    vblk.disk_guid    = getChunk(buf)
    vblk.alt_name   = getChunk(buf)
    ph.diskVb     = vblk if ph.disk_id == vblk.disk_guid

  when VBT_DISKGROUPV1  # Disk Group v1
    vblk.dg_guid    = getChunk(buf)

  when VBT_DISKV2     # Disk v2
    vblk.disk_guid1   = UUIDTools::UUID.parse_raw(BinaryStruct.stepDecode(buf, "a16")).to_s
    vblk.disk_guid2   = UUIDTools::UUID.parse_raw(BinaryStruct.stepDecode(buf, "a16")).to_s
    ph.diskVb     = vblk if ph.disk_id == vblk.disk_guid1

  when VBT_DISKGROUPV2  # Disk Group v2
    vblk.dg_guid    = UUIDTools::UUID.parse_raw(BinaryStruct.stepDecode(buf, "a16")).to_s
    vblk.ds_guid    = UUIDTools::UUID.parse_raw(BinaryStruct.stepDecode(buf, "a16")).to_s

  when VBT_VOLUME     # Volume
    vblk.children   = []
    vblk.volume_type  = getChunk(buf)
    BinaryStruct.stepDecode(buf, "C")
    vblk.volume_state = BinaryStruct.stepDecode(buf, "a14").delete("\000")
    vblk.volume_typeN = BinaryStruct.stepDecode(buf, "C")
    BinaryStruct.stepDecode(buf, "C")
    vblk.volume_number  = BinaryStruct.stepDecode(buf, "C")
    BinaryStruct.stepDecode(buf, "C3")
    vblk.vol_flags    = BinaryStruct.stepDecode(buf, "C")
    vblk.num_children = getNum(buf)
    BinaryStruct.stepDecode(buf, "C16")
    vblk.size     = getNum(buf)
    BinaryStruct.stepDecode(buf, "C4")
    vblk.partition_type = BinaryStruct.stepDecode(buf, "C")
    vblk.volume_id    = UUIDTools::UUID.parse_raw(BinaryStruct.stepDecode(buf, "a16")).to_s

    vblk.id1      = getChunk(buf) if (vblk.flags & 0x08) != 0x0
    vblk.id2      = getChunk(buf) if (vblk.flags & 0x20) != 0x0
    vblk.csize      = getNum(buf) if (vblk.flags & 0x80) != 0x0
    vblk.drive_hint   = getChunk(buf) if (vblk.flags & 0x02) != 0x0

    if vblk.volume_state == "ACTIVE"
      if vblk.volume_type == "gen"
        ph.volumes << vblk
      else
        $log.warn "LdmScanner: unsupported volume type - #{vblk.volume_type}" if $log
      end
    end
  end

  vblk.delete_field("padding") if vblk.padding
  ph.vblkHash[vblk.vobject_id] = vblk
  (vblk)
end

.scan(d) ⇒ Object 



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
 
# File 'lib/VolumeManager/MiqLdm.rb', line 152

def self.scan(d)
  return nil if d.partType != LDM_PARTITION_TYPE

  d.seek(PRIVHEAD_OFFSET)
  ph = readStruct(d, PRIVHEAD)
  # LdmScanner.dumpPrivhead(ph)
  return nil if ph.signature != "PRIVHEAD"

  ph.disk_id.delete!("\000")
  ph.diskgroup_id.delete!("\000")
  ph.diskgroup_name.delete!("\000")
  ph.host_id.delete!("\000")

  ph.lvm_type = "LDM"
  ph.pv_uuid = ph.disk_id
  ph.diskObj = d

  tb = nil
  TBLOCK_BLOCK.each do |tbo|
    tblock_offset = (ph.db_start + tbo) * LDM_SECTOR_SIZE
    d.seek(tblock_offset)
    tb = readStruct(d, TOCBLOCK)
    # LdmScanner.dumpTocblock(tb)
    break if tb.signature == "TOCBLOCK"
  end

  unless tb
    $log.warn "LdmScanner: could not find valid TOCBLOCK on LDM disk" if $log
    return nil
  end

  vmdb_offset = (ph.db_start + tb.bitmap1_start) * LDM_SECTOR_SIZE
  d.seek(vmdb_offset)
  vmdb = readStruct(d, VMDB)

  ph.vblkHash = {}
  ph.volumes  = []
  ph.diskVb = nil
  (0...vmdb.sequence).each { |_i| readVBLK(d, ph) }

  ph.vblkHash.each_value do |v|
    ph.vblkHash[v.parent_id].children << v if v.parent_id
    v.disk = ph.vblkHash[v.disk_id] if v.disk_id
  end
  (ph)
end