183de0ea4SMarc-André Lureau#!/usr/bin/env python3 2b1742570SAlexander Graf# 3b1742570SAlexander Graf# Migration Stream Analyzer 4b1742570SAlexander Graf# 5b1742570SAlexander Graf# Copyright (c) 2015 Alexander Graf <agraf@suse.de> 6b1742570SAlexander Graf# 7b1742570SAlexander Graf# This library is free software; you can redistribute it and/or 8b1742570SAlexander Graf# modify it under the terms of the GNU Lesser General Public 9b1742570SAlexander Graf# License as published by the Free Software Foundation; either 1061f3c91aSChetan Pant# version 2.1 of the License, or (at your option) any later version. 11b1742570SAlexander Graf# 12b1742570SAlexander Graf# This library is distributed in the hope that it will be useful, 13b1742570SAlexander Graf# but WITHOUT ANY WARRANTY; without even the implied warranty of 14b1742570SAlexander Graf# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15b1742570SAlexander Graf# Lesser General Public License for more details. 16b1742570SAlexander Graf# 17b1742570SAlexander Graf# You should have received a copy of the GNU Lesser General Public 18b1742570SAlexander Graf# License along with this library; if not, see <http://www.gnu.org/licenses/>. 19b1742570SAlexander Graf 20b1742570SAlexander Grafimport json 21b1742570SAlexander Grafimport os 22b1742570SAlexander Grafimport argparse 23b1742570SAlexander Grafimport collections 2483de0ea4SMarc-André Lureauimport struct 2583de0ea4SMarc-André Lureauimport sys 2683de0ea4SMarc-André Lureau 2783de0ea4SMarc-André Lureau 28b1742570SAlexander Grafdef mkdir_p(path): 29b1742570SAlexander Graf try: 30b1742570SAlexander Graf os.makedirs(path) 31b1742570SAlexander Graf except OSError: 32b1742570SAlexander Graf pass 33b1742570SAlexander Graf 3483de0ea4SMarc-André Lureau 35b1742570SAlexander Grafclass MigrationFile(object): 36b1742570SAlexander Graf def __init__(self, filename): 37b1742570SAlexander Graf self.filename = filename 38b1742570SAlexander Graf self.file = open(self.filename, "rb") 39b1742570SAlexander Graf 40b1742570SAlexander Graf def read64(self): 41*caea0327SFabiano Rosas return int.from_bytes(self.file.read(8), byteorder='big', signed=False) 42b1742570SAlexander Graf 43b1742570SAlexander Graf def read32(self): 44*caea0327SFabiano Rosas return int.from_bytes(self.file.read(4), byteorder='big', signed=False) 45b1742570SAlexander Graf 46b1742570SAlexander Graf def read16(self): 47*caea0327SFabiano Rosas return int.from_bytes(self.file.read(2), byteorder='big', signed=False) 48b1742570SAlexander Graf 49b1742570SAlexander Graf def read8(self): 5083de0ea4SMarc-André Lureau return int.from_bytes(self.file.read(1), byteorder='big', signed=True) 51b1742570SAlexander Graf 52b1742570SAlexander Graf def readstr(self, len = None): 5383de0ea4SMarc-André Lureau return self.readvar(len).decode('utf-8') 54b1742570SAlexander Graf 55b1742570SAlexander Graf def readvar(self, size = None): 56b1742570SAlexander Graf if size is None: 57b1742570SAlexander Graf size = self.read8() 58b1742570SAlexander Graf if size == 0: 59b1742570SAlexander Graf return "" 60b1742570SAlexander Graf value = self.file.read(size) 61b1742570SAlexander Graf if len(value) != size: 62b1742570SAlexander Graf raise Exception("Unexpected end of %s at 0x%x" % (self.filename, self.file.tell())) 63b1742570SAlexander Graf return value 64b1742570SAlexander Graf 65b1742570SAlexander Graf def tell(self): 66b1742570SAlexander Graf return self.file.tell() 67b1742570SAlexander Graf 68b1742570SAlexander Graf # The VMSD description is at the end of the file, after EOF. Look for 69b1742570SAlexander Graf # the last NULL byte, then for the beginning brace of JSON. 70b1742570SAlexander Graf def read_migration_debug_json(self): 71b1742570SAlexander Graf QEMU_VM_VMDESCRIPTION = 0x06 72b1742570SAlexander Graf 73b1742570SAlexander Graf # Remember the offset in the file when we started 74b1742570SAlexander Graf entrypos = self.file.tell() 75b1742570SAlexander Graf 76b1742570SAlexander Graf # Read the last 10MB 77b1742570SAlexander Graf self.file.seek(0, os.SEEK_END) 78b1742570SAlexander Graf endpos = self.file.tell() 79b1742570SAlexander Graf self.file.seek(max(-endpos, -10 * 1024 * 1024), os.SEEK_END) 80b1742570SAlexander Graf datapos = self.file.tell() 81b1742570SAlexander Graf data = self.file.read() 82b1742570SAlexander Graf # The full file read closed the file as well, reopen it 83b1742570SAlexander Graf self.file = open(self.filename, "rb") 84b1742570SAlexander Graf 85b1742570SAlexander Graf # Find the last NULL byte, then the first brace after that. This should 86b1742570SAlexander Graf # be the beginning of our JSON data. 8713ae8cdbSMarc-André Lureau nulpos = data.rfind(b'\0') 8813ae8cdbSMarc-André Lureau jsonpos = data.find(b'{', nulpos) 89b1742570SAlexander Graf 90b1742570SAlexander Graf # Check backwards from there and see whether we guessed right 91b1742570SAlexander Graf self.file.seek(datapos + jsonpos - 5, 0) 92b1742570SAlexander Graf if self.read8() != QEMU_VM_VMDESCRIPTION: 93b1742570SAlexander Graf raise Exception("No Debug Migration device found") 94b1742570SAlexander Graf 95b1742570SAlexander Graf jsonlen = self.read32() 96b1742570SAlexander Graf 97b1742570SAlexander Graf # Seek back to where we were at the beginning 98b1742570SAlexander Graf self.file.seek(entrypos, 0) 99b1742570SAlexander Graf 10014f9cec7SAlexey Kirillov # explicit decode() needed for Python 3.5 compatibility 10114f9cec7SAlexey Kirillov return data[jsonpos:jsonpos + jsonlen].decode("utf-8") 102b1742570SAlexander Graf 103b1742570SAlexander Graf def close(self): 104b1742570SAlexander Graf self.file.close() 105b1742570SAlexander Graf 106b1742570SAlexander Grafclass RamSection(object): 107b1742570SAlexander Graf RAM_SAVE_FLAG_COMPRESS = 0x02 108b1742570SAlexander Graf RAM_SAVE_FLAG_MEM_SIZE = 0x04 109b1742570SAlexander Graf RAM_SAVE_FLAG_PAGE = 0x08 110b1742570SAlexander Graf RAM_SAVE_FLAG_EOS = 0x10 111b1742570SAlexander Graf RAM_SAVE_FLAG_CONTINUE = 0x20 112b1742570SAlexander Graf RAM_SAVE_FLAG_XBZRLE = 0x40 113b1742570SAlexander Graf RAM_SAVE_FLAG_HOOK = 0x80 114f1de3097SMarc-André Lureau RAM_SAVE_FLAG_COMPRESS_PAGE = 0x100 115f1de3097SMarc-André Lureau RAM_SAVE_FLAG_MULTIFD_FLUSH = 0x200 116b1742570SAlexander Graf 117b1742570SAlexander Graf def __init__(self, file, version_id, ramargs, section_key): 118b1742570SAlexander Graf if version_id != 4: 119b1742570SAlexander Graf raise Exception("Unknown RAM version %d" % version_id) 120b1742570SAlexander Graf 121b1742570SAlexander Graf self.file = file 122b1742570SAlexander Graf self.section_key = section_key 123b1742570SAlexander Graf self.TARGET_PAGE_SIZE = ramargs['page_size'] 124b1742570SAlexander Graf self.dump_memory = ramargs['dump_memory'] 125b1742570SAlexander Graf self.write_memory = ramargs['write_memory'] 126ff40c7f0SFabiano Rosas self.ignore_shared = ramargs['ignore_shared'] 127b1742570SAlexander Graf self.sizeinfo = collections.OrderedDict() 128b1742570SAlexander Graf self.data = collections.OrderedDict() 129b1742570SAlexander Graf self.data['section sizes'] = self.sizeinfo 130b1742570SAlexander Graf self.name = '' 131b1742570SAlexander Graf if self.write_memory: 132b1742570SAlexander Graf self.files = { } 133b1742570SAlexander Graf if self.dump_memory: 134b1742570SAlexander Graf self.memory = collections.OrderedDict() 135b1742570SAlexander Graf self.data['memory'] = self.memory 136b1742570SAlexander Graf 137b1742570SAlexander Graf def __repr__(self): 138b1742570SAlexander Graf return self.data.__repr__() 139b1742570SAlexander Graf 140b1742570SAlexander Graf def __str__(self): 141b1742570SAlexander Graf return self.data.__str__() 142b1742570SAlexander Graf 143b1742570SAlexander Graf def getDict(self): 144b1742570SAlexander Graf return self.data 145b1742570SAlexander Graf 146b1742570SAlexander Graf def read(self): 147b1742570SAlexander Graf # Read all RAM sections 148b1742570SAlexander Graf while True: 149b1742570SAlexander Graf addr = self.file.read64() 150b1742570SAlexander Graf flags = addr & (self.TARGET_PAGE_SIZE - 1) 151b1742570SAlexander Graf addr &= ~(self.TARGET_PAGE_SIZE - 1) 152b1742570SAlexander Graf 153b1742570SAlexander Graf if flags & self.RAM_SAVE_FLAG_MEM_SIZE: 154b1742570SAlexander Graf while True: 155b1742570SAlexander Graf namelen = self.file.read8() 156b1742570SAlexander Graf # We assume that no RAM chunk is big enough to ever 157b1742570SAlexander Graf # hit the first byte of the address, so when we see 158b1742570SAlexander Graf # a zero here we know it has to be an address, not the 159b1742570SAlexander Graf # length of the next block. 160b1742570SAlexander Graf if namelen == 0: 161b1742570SAlexander Graf self.file.file.seek(-1, 1) 162b1742570SAlexander Graf break 163b1742570SAlexander Graf self.name = self.file.readstr(len = namelen) 164b1742570SAlexander Graf len = self.file.read64() 165b1742570SAlexander Graf self.sizeinfo[self.name] = '0x%016x' % len 166b1742570SAlexander Graf if self.write_memory: 167f03868bdSEduardo Habkost print(self.name) 168b1742570SAlexander Graf mkdir_p('./' + os.path.dirname(self.name)) 169b1742570SAlexander Graf f = open('./' + self.name, "wb") 170b1742570SAlexander Graf f.truncate(0) 171b1742570SAlexander Graf f.truncate(len) 172b1742570SAlexander Graf self.files[self.name] = f 173ff40c7f0SFabiano Rosas if self.ignore_shared: 174ff40c7f0SFabiano Rosas mr_addr = self.file.read64() 175b1742570SAlexander Graf flags &= ~self.RAM_SAVE_FLAG_MEM_SIZE 176b1742570SAlexander Graf 177b1742570SAlexander Graf if flags & self.RAM_SAVE_FLAG_COMPRESS: 178b1742570SAlexander Graf if flags & self.RAM_SAVE_FLAG_CONTINUE: 179b1742570SAlexander Graf flags &= ~self.RAM_SAVE_FLAG_CONTINUE 180b1742570SAlexander Graf else: 181b1742570SAlexander Graf self.name = self.file.readstr() 182b1742570SAlexander Graf fill_char = self.file.read8() 183b1742570SAlexander Graf # The page in question is filled with fill_char now 184b1742570SAlexander Graf if self.write_memory and fill_char != 0: 185b1742570SAlexander Graf self.files[self.name].seek(addr, os.SEEK_SET) 186b1742570SAlexander Graf self.files[self.name].write(chr(fill_char) * self.TARGET_PAGE_SIZE) 187b1742570SAlexander Graf if self.dump_memory: 188b1742570SAlexander Graf self.memory['%s (0x%016x)' % (self.name, addr)] = 'Filled with 0x%02x' % fill_char 189b1742570SAlexander Graf flags &= ~self.RAM_SAVE_FLAG_COMPRESS 190b1742570SAlexander Graf elif flags & self.RAM_SAVE_FLAG_PAGE: 191b1742570SAlexander Graf if flags & self.RAM_SAVE_FLAG_CONTINUE: 192b1742570SAlexander Graf flags &= ~self.RAM_SAVE_FLAG_CONTINUE 193b1742570SAlexander Graf else: 194b1742570SAlexander Graf self.name = self.file.readstr() 195b1742570SAlexander Graf 196b1742570SAlexander Graf if self.write_memory or self.dump_memory: 197b1742570SAlexander Graf data = self.file.readvar(size = self.TARGET_PAGE_SIZE) 198b1742570SAlexander Graf else: # Just skip RAM data 199b1742570SAlexander Graf self.file.file.seek(self.TARGET_PAGE_SIZE, 1) 200b1742570SAlexander Graf 201b1742570SAlexander Graf if self.write_memory: 202b1742570SAlexander Graf self.files[self.name].seek(addr, os.SEEK_SET) 203b1742570SAlexander Graf self.files[self.name].write(data) 204b1742570SAlexander Graf if self.dump_memory: 205b1742570SAlexander Graf hexdata = " ".join("{0:02x}".format(ord(c)) for c in data) 206b1742570SAlexander Graf self.memory['%s (0x%016x)' % (self.name, addr)] = hexdata 207b1742570SAlexander Graf 208b1742570SAlexander Graf flags &= ~self.RAM_SAVE_FLAG_PAGE 209b1742570SAlexander Graf elif flags & self.RAM_SAVE_FLAG_XBZRLE: 210b1742570SAlexander Graf raise Exception("XBZRLE RAM compression is not supported yet") 211b1742570SAlexander Graf elif flags & self.RAM_SAVE_FLAG_HOOK: 212b1742570SAlexander Graf raise Exception("RAM hooks don't make sense with files") 213f1de3097SMarc-André Lureau if flags & self.RAM_SAVE_FLAG_MULTIFD_FLUSH: 214f1de3097SMarc-André Lureau continue 215b1742570SAlexander Graf 216b1742570SAlexander Graf # End of RAM section 217b1742570SAlexander Graf if flags & self.RAM_SAVE_FLAG_EOS: 218b1742570SAlexander Graf break 219b1742570SAlexander Graf 220b1742570SAlexander Graf if flags != 0: 221b1742570SAlexander Graf raise Exception("Unknown RAM flags: %x" % flags) 222b1742570SAlexander Graf 223b1742570SAlexander Graf def __del__(self): 224b1742570SAlexander Graf if self.write_memory: 225b1742570SAlexander Graf for key in self.files: 226b1742570SAlexander Graf self.files[key].close() 227b1742570SAlexander Graf 228b1742570SAlexander Graf 229b1742570SAlexander Grafclass HTABSection(object): 230b1742570SAlexander Graf HASH_PTE_SIZE_64 = 16 231b1742570SAlexander Graf 232b1742570SAlexander Graf def __init__(self, file, version_id, device, section_key): 233b1742570SAlexander Graf if version_id != 1: 234b1742570SAlexander Graf raise Exception("Unknown HTAB version %d" % version_id) 235b1742570SAlexander Graf 236b1742570SAlexander Graf self.file = file 237b1742570SAlexander Graf self.section_key = section_key 238b1742570SAlexander Graf 239b1742570SAlexander Graf def read(self): 240b1742570SAlexander Graf 241b1742570SAlexander Graf header = self.file.read32() 242b1742570SAlexander Graf 243029ff892SLaurent Vivier if (header == -1): 244029ff892SLaurent Vivier # "no HPT" encoding 245029ff892SLaurent Vivier return 246029ff892SLaurent Vivier 247b1742570SAlexander Graf if (header > 0): 248b1742570SAlexander Graf # First section, just the hash shift 249b1742570SAlexander Graf return 250b1742570SAlexander Graf 251b1742570SAlexander Graf # Read until end marker 252b1742570SAlexander Graf while True: 253b1742570SAlexander Graf index = self.file.read32() 254b1742570SAlexander Graf n_valid = self.file.read16() 255b1742570SAlexander Graf n_invalid = self.file.read16() 256b1742570SAlexander Graf 257b1742570SAlexander Graf if index == 0 and n_valid == 0 and n_invalid == 0: 258b1742570SAlexander Graf break 259b1742570SAlexander Graf 260be7433efSGreg Kurz self.file.readvar(n_valid * self.HASH_PTE_SIZE_64) 261b1742570SAlexander Graf 262b1742570SAlexander Graf def getDict(self): 263b1742570SAlexander Graf return "" 264b1742570SAlexander Graf 26596e5c9bcSMark Cave-Ayland 26696e5c9bcSMark Cave-Aylandclass ConfigurationSection(object): 267c36c31c8SFabiano Rosas def __init__(self, file, desc): 26896e5c9bcSMark Cave-Ayland self.file = file 269c36c31c8SFabiano Rosas self.desc = desc 27031499a9dSFabiano Rosas self.caps = [] 27131499a9dSFabiano Rosas 27231499a9dSFabiano Rosas def parse_capabilities(self, vmsd_caps): 27331499a9dSFabiano Rosas if not vmsd_caps: 27431499a9dSFabiano Rosas return 27531499a9dSFabiano Rosas 27631499a9dSFabiano Rosas ncaps = vmsd_caps.data['caps_count'].data 27731499a9dSFabiano Rosas self.caps = vmsd_caps.data['capabilities'] 27831499a9dSFabiano Rosas 27931499a9dSFabiano Rosas if type(self.caps) != list: 28031499a9dSFabiano Rosas self.caps = [self.caps] 28131499a9dSFabiano Rosas 28231499a9dSFabiano Rosas if len(self.caps) != ncaps: 28331499a9dSFabiano Rosas raise Exception("Number of capabilities doesn't match " 28431499a9dSFabiano Rosas "caps_count field") 28531499a9dSFabiano Rosas 28631499a9dSFabiano Rosas def has_capability(self, cap): 28731499a9dSFabiano Rosas return any([str(c) == cap for c in self.caps]) 28896e5c9bcSMark Cave-Ayland 28996e5c9bcSMark Cave-Ayland def read(self): 290c36c31c8SFabiano Rosas if self.desc: 291c36c31c8SFabiano Rosas version_id = self.desc['version'] 292c36c31c8SFabiano Rosas section = VMSDSection(self.file, version_id, self.desc, 293c36c31c8SFabiano Rosas 'configuration') 294c36c31c8SFabiano Rosas section.read() 29531499a9dSFabiano Rosas self.parse_capabilities( 29631499a9dSFabiano Rosas section.data.get("configuration/capabilities")) 297c36c31c8SFabiano Rosas else: 298c36c31c8SFabiano Rosas # backward compatibility for older streams that don't have 299c36c31c8SFabiano Rosas # the configuration section in the json 30096e5c9bcSMark Cave-Ayland name_len = self.file.read32() 30196e5c9bcSMark Cave-Ayland name = self.file.readstr(len = name_len) 30296e5c9bcSMark Cave-Ayland 303b1742570SAlexander Grafclass VMSDFieldGeneric(object): 304b1742570SAlexander Graf def __init__(self, desc, file): 305b1742570SAlexander Graf self.file = file 306b1742570SAlexander Graf self.desc = desc 307b1742570SAlexander Graf self.data = "" 308b1742570SAlexander Graf 309b1742570SAlexander Graf def __repr__(self): 310b1742570SAlexander Graf return str(self.__str__()) 311b1742570SAlexander Graf 312b1742570SAlexander Graf def __str__(self): 31383de0ea4SMarc-André Lureau return " ".join("{0:02x}".format(c) for c in self.data) 314b1742570SAlexander Graf 315b1742570SAlexander Graf def getDict(self): 316b1742570SAlexander Graf return self.__str__() 317b1742570SAlexander Graf 318b1742570SAlexander Graf def read(self): 319b1742570SAlexander Graf size = int(self.desc['size']) 320b1742570SAlexander Graf self.data = self.file.readvar(size) 321b1742570SAlexander Graf return self.data 322b1742570SAlexander Graf 32331499a9dSFabiano Rosasclass VMSDFieldCap(object): 32431499a9dSFabiano Rosas def __init__(self, desc, file): 32531499a9dSFabiano Rosas self.file = file 32631499a9dSFabiano Rosas self.desc = desc 32731499a9dSFabiano Rosas self.data = "" 32831499a9dSFabiano Rosas 32931499a9dSFabiano Rosas def __repr__(self): 33031499a9dSFabiano Rosas return self.data 33131499a9dSFabiano Rosas 33231499a9dSFabiano Rosas def __str__(self): 33331499a9dSFabiano Rosas return self.data 33431499a9dSFabiano Rosas 33531499a9dSFabiano Rosas def read(self): 33631499a9dSFabiano Rosas len = self.file.read8() 33731499a9dSFabiano Rosas self.data = self.file.readstr(len) 33831499a9dSFabiano Rosas 33931499a9dSFabiano Rosas 340b1742570SAlexander Grafclass VMSDFieldInt(VMSDFieldGeneric): 341b1742570SAlexander Graf def __init__(self, desc, file): 342b1742570SAlexander Graf super(VMSDFieldInt, self).__init__(desc, file) 343b1742570SAlexander Graf self.size = int(desc['size']) 344b1742570SAlexander Graf self.format = '0x%%0%dx' % (self.size * 2) 345b1742570SAlexander Graf self.sdtype = '>i%d' % self.size 346b1742570SAlexander Graf self.udtype = '>u%d' % self.size 347b1742570SAlexander Graf 348b1742570SAlexander Graf def __repr__(self): 349b1742570SAlexander Graf if self.data < 0: 350b1742570SAlexander Graf return ('%s (%d)' % ((self.format % self.udata), self.data)) 351b1742570SAlexander Graf else: 352b1742570SAlexander Graf return self.format % self.data 353b1742570SAlexander Graf 354b1742570SAlexander Graf def __str__(self): 355b1742570SAlexander Graf return self.__repr__() 356b1742570SAlexander Graf 357b1742570SAlexander Graf def getDict(self): 358b1742570SAlexander Graf return self.__str__() 359b1742570SAlexander Graf 360b1742570SAlexander Graf def read(self): 361b1742570SAlexander Graf super(VMSDFieldInt, self).read() 36283de0ea4SMarc-André Lureau self.sdata = int.from_bytes(self.data, byteorder='big', signed=True) 36383de0ea4SMarc-André Lureau self.udata = int.from_bytes(self.data, byteorder='big', signed=False) 364b1742570SAlexander Graf self.data = self.sdata 365b1742570SAlexander Graf return self.data 366b1742570SAlexander Graf 367b1742570SAlexander Grafclass VMSDFieldUInt(VMSDFieldInt): 368b1742570SAlexander Graf def __init__(self, desc, file): 369b1742570SAlexander Graf super(VMSDFieldUInt, self).__init__(desc, file) 370b1742570SAlexander Graf 371b1742570SAlexander Graf def read(self): 372b1742570SAlexander Graf super(VMSDFieldUInt, self).read() 373b1742570SAlexander Graf self.data = self.udata 374b1742570SAlexander Graf return self.data 375b1742570SAlexander Graf 376b1742570SAlexander Grafclass VMSDFieldIntLE(VMSDFieldInt): 377b1742570SAlexander Graf def __init__(self, desc, file): 378b1742570SAlexander Graf super(VMSDFieldIntLE, self).__init__(desc, file) 379b1742570SAlexander Graf self.dtype = '<i%d' % self.size 380b1742570SAlexander Graf 381b1742570SAlexander Grafclass VMSDFieldBool(VMSDFieldGeneric): 382b1742570SAlexander Graf def __init__(self, desc, file): 383b1742570SAlexander Graf super(VMSDFieldBool, self).__init__(desc, file) 384b1742570SAlexander Graf 385b1742570SAlexander Graf def __repr__(self): 386b1742570SAlexander Graf return self.data.__repr__() 387b1742570SAlexander Graf 388b1742570SAlexander Graf def __str__(self): 389b1742570SAlexander Graf return self.data.__str__() 390b1742570SAlexander Graf 391b1742570SAlexander Graf def getDict(self): 392b1742570SAlexander Graf return self.data 393b1742570SAlexander Graf 394b1742570SAlexander Graf def read(self): 395b1742570SAlexander Graf super(VMSDFieldBool, self).read() 396b1742570SAlexander Graf if self.data[0] == 0: 397b1742570SAlexander Graf self.data = False 398b1742570SAlexander Graf else: 399b1742570SAlexander Graf self.data = True 400b1742570SAlexander Graf return self.data 401b1742570SAlexander Graf 402b1742570SAlexander Grafclass VMSDFieldStruct(VMSDFieldGeneric): 403b1742570SAlexander Graf QEMU_VM_SUBSECTION = 0x05 404b1742570SAlexander Graf 405b1742570SAlexander Graf def __init__(self, desc, file): 406b1742570SAlexander Graf super(VMSDFieldStruct, self).__init__(desc, file) 407b1742570SAlexander Graf self.data = collections.OrderedDict() 408b1742570SAlexander Graf 409b1742570SAlexander Graf # When we see compressed array elements, unfold them here 410b1742570SAlexander Graf new_fields = [] 411b1742570SAlexander Graf for field in self.desc['struct']['fields']: 412b1742570SAlexander Graf if not 'array_len' in field: 413b1742570SAlexander Graf new_fields.append(field) 414b1742570SAlexander Graf continue 415b1742570SAlexander Graf array_len = field.pop('array_len') 416b1742570SAlexander Graf field['index'] = 0 417b1742570SAlexander Graf new_fields.append(field) 41883de0ea4SMarc-André Lureau for i in range(1, array_len): 419b1742570SAlexander Graf c = field.copy() 420b1742570SAlexander Graf c['index'] = i 421b1742570SAlexander Graf new_fields.append(c) 422b1742570SAlexander Graf 423b1742570SAlexander Graf self.desc['struct']['fields'] = new_fields 424b1742570SAlexander Graf 425b1742570SAlexander Graf def __repr__(self): 426b1742570SAlexander Graf return self.data.__repr__() 427b1742570SAlexander Graf 428b1742570SAlexander Graf def __str__(self): 429b1742570SAlexander Graf return self.data.__str__() 430b1742570SAlexander Graf 431b1742570SAlexander Graf def read(self): 432b1742570SAlexander Graf for field in self.desc['struct']['fields']: 433b1742570SAlexander Graf try: 434b1742570SAlexander Graf reader = vmsd_field_readers[field['type']] 435b1742570SAlexander Graf except: 436b1742570SAlexander Graf reader = VMSDFieldGeneric 437b1742570SAlexander Graf 438b1742570SAlexander Graf field['data'] = reader(field, self.file) 439b1742570SAlexander Graf field['data'].read() 440b1742570SAlexander Graf 441b1742570SAlexander Graf if 'index' in field: 442b1742570SAlexander Graf if field['name'] not in self.data: 443b1742570SAlexander Graf self.data[field['name']] = [] 444b1742570SAlexander Graf a = self.data[field['name']] 445b1742570SAlexander Graf if len(a) != int(field['index']): 446b1742570SAlexander Graf raise Exception("internal index of data field unmatched (%d/%d)" % (len(a), int(field['index']))) 447b1742570SAlexander Graf a.append(field['data']) 448b1742570SAlexander Graf else: 449b1742570SAlexander Graf self.data[field['name']] = field['data'] 450b1742570SAlexander Graf 451b1742570SAlexander Graf if 'subsections' in self.desc['struct']: 452b1742570SAlexander Graf for subsection in self.desc['struct']['subsections']: 453b1742570SAlexander Graf if self.file.read8() != self.QEMU_VM_SUBSECTION: 454b1742570SAlexander Graf raise Exception("Subsection %s not found at offset %x" % ( subsection['vmsd_name'], self.file.tell())) 455b1742570SAlexander Graf name = self.file.readstr() 456b1742570SAlexander Graf version_id = self.file.read32() 457b1742570SAlexander Graf self.data[name] = VMSDSection(self.file, version_id, subsection, (name, 0)) 458b1742570SAlexander Graf self.data[name].read() 459b1742570SAlexander Graf 460b1742570SAlexander Graf def getDictItem(self, value): 461b1742570SAlexander Graf # Strings would fall into the array category, treat 462b1742570SAlexander Graf # them specially 463b1742570SAlexander Graf if value.__class__ is ''.__class__: 464b1742570SAlexander Graf return value 465b1742570SAlexander Graf 466b1742570SAlexander Graf try: 467b1742570SAlexander Graf return self.getDictOrderedDict(value) 468b1742570SAlexander Graf except: 469b1742570SAlexander Graf try: 470b1742570SAlexander Graf return self.getDictArray(value) 471b1742570SAlexander Graf except: 472b1742570SAlexander Graf try: 473b1742570SAlexander Graf return value.getDict() 474b1742570SAlexander Graf except: 475b1742570SAlexander Graf return value 476b1742570SAlexander Graf 477b1742570SAlexander Graf def getDictArray(self, array): 478b1742570SAlexander Graf r = [] 479b1742570SAlexander Graf for value in array: 480b1742570SAlexander Graf r.append(self.getDictItem(value)) 481b1742570SAlexander Graf return r 482b1742570SAlexander Graf 483b1742570SAlexander Graf def getDictOrderedDict(self, dict): 484b1742570SAlexander Graf r = collections.OrderedDict() 485b1742570SAlexander Graf for (key, value) in dict.items(): 486b1742570SAlexander Graf r[key] = self.getDictItem(value) 487b1742570SAlexander Graf return r 488b1742570SAlexander Graf 489b1742570SAlexander Graf def getDict(self): 490b1742570SAlexander Graf return self.getDictOrderedDict(self.data) 491b1742570SAlexander Graf 492b1742570SAlexander Grafvmsd_field_readers = { 493b1742570SAlexander Graf "bool" : VMSDFieldBool, 494b1742570SAlexander Graf "int8" : VMSDFieldInt, 495b1742570SAlexander Graf "int16" : VMSDFieldInt, 496b1742570SAlexander Graf "int32" : VMSDFieldInt, 497b1742570SAlexander Graf "int32 equal" : VMSDFieldInt, 498b1742570SAlexander Graf "int32 le" : VMSDFieldIntLE, 499b1742570SAlexander Graf "int64" : VMSDFieldInt, 500b1742570SAlexander Graf "uint8" : VMSDFieldUInt, 501b1742570SAlexander Graf "uint16" : VMSDFieldUInt, 502b1742570SAlexander Graf "uint32" : VMSDFieldUInt, 503b1742570SAlexander Graf "uint32 equal" : VMSDFieldUInt, 504b1742570SAlexander Graf "uint64" : VMSDFieldUInt, 505b1742570SAlexander Graf "int64 equal" : VMSDFieldInt, 506b1742570SAlexander Graf "uint8 equal" : VMSDFieldInt, 507b1742570SAlexander Graf "uint16 equal" : VMSDFieldInt, 508b1742570SAlexander Graf "float64" : VMSDFieldGeneric, 509b1742570SAlexander Graf "timer" : VMSDFieldGeneric, 510b1742570SAlexander Graf "buffer" : VMSDFieldGeneric, 511b1742570SAlexander Graf "unused_buffer" : VMSDFieldGeneric, 512b1742570SAlexander Graf "bitmap" : VMSDFieldGeneric, 513b1742570SAlexander Graf "struct" : VMSDFieldStruct, 51431499a9dSFabiano Rosas "capability": VMSDFieldCap, 515b1742570SAlexander Graf "unknown" : VMSDFieldGeneric, 516b1742570SAlexander Graf} 517b1742570SAlexander Graf 518b1742570SAlexander Grafclass VMSDSection(VMSDFieldStruct): 519b1742570SAlexander Graf def __init__(self, file, version_id, device, section_key): 520b1742570SAlexander Graf self.file = file 521b1742570SAlexander Graf self.data = "" 522b1742570SAlexander Graf self.vmsd_name = "" 523b1742570SAlexander Graf self.section_key = section_key 524b1742570SAlexander Graf desc = device 525b1742570SAlexander Graf if 'vmsd_name' in device: 526b1742570SAlexander Graf self.vmsd_name = device['vmsd_name'] 527b1742570SAlexander Graf 528b1742570SAlexander Graf # A section really is nothing but a FieldStruct :) 529b1742570SAlexander Graf super(VMSDSection, self).__init__({ 'struct' : desc }, file) 530b1742570SAlexander Graf 531b1742570SAlexander Graf############################################################################### 532b1742570SAlexander Graf 533b1742570SAlexander Grafclass MigrationDump(object): 534b1742570SAlexander Graf QEMU_VM_FILE_MAGIC = 0x5145564d 535b1742570SAlexander Graf QEMU_VM_FILE_VERSION = 0x00000003 536b1742570SAlexander Graf QEMU_VM_EOF = 0x00 537b1742570SAlexander Graf QEMU_VM_SECTION_START = 0x01 538b1742570SAlexander Graf QEMU_VM_SECTION_PART = 0x02 539b1742570SAlexander Graf QEMU_VM_SECTION_END = 0x03 540b1742570SAlexander Graf QEMU_VM_SECTION_FULL = 0x04 541b1742570SAlexander Graf QEMU_VM_SUBSECTION = 0x05 542b1742570SAlexander Graf QEMU_VM_VMDESCRIPTION = 0x06 54396e5c9bcSMark Cave-Ayland QEMU_VM_CONFIGURATION = 0x07 54473d9a796SDr. David Alan Gilbert QEMU_VM_SECTION_FOOTER= 0x7e 545b1742570SAlexander Graf 546b1742570SAlexander Graf def __init__(self, filename): 547b1742570SAlexander Graf self.section_classes = { ( 'ram', 0 ) : [ RamSection, None ], 548b1742570SAlexander Graf ( 'spapr/htab', 0) : ( HTABSection, None ) } 549b1742570SAlexander Graf self.filename = filename 550b1742570SAlexander Graf self.vmsd_desc = None 551b1742570SAlexander Graf 552b1742570SAlexander Graf def read(self, desc_only = False, dump_memory = False, write_memory = False): 553b1742570SAlexander Graf # Read in the whole file 554b1742570SAlexander Graf file = MigrationFile(self.filename) 555b1742570SAlexander Graf 556b1742570SAlexander Graf # File magic 557b1742570SAlexander Graf data = file.read32() 558b1742570SAlexander Graf if data != self.QEMU_VM_FILE_MAGIC: 559b1742570SAlexander Graf raise Exception("Invalid file magic %x" % data) 560b1742570SAlexander Graf 561b1742570SAlexander Graf # Version (has to be v3) 562b1742570SAlexander Graf data = file.read32() 563b1742570SAlexander Graf if data != self.QEMU_VM_FILE_VERSION: 564b1742570SAlexander Graf raise Exception("Invalid version number %d" % data) 565b1742570SAlexander Graf 566b1742570SAlexander Graf self.load_vmsd_json(file) 567b1742570SAlexander Graf 568b1742570SAlexander Graf # Read sections 569b1742570SAlexander Graf self.sections = collections.OrderedDict() 570b1742570SAlexander Graf 571b1742570SAlexander Graf if desc_only: 572b1742570SAlexander Graf return 573b1742570SAlexander Graf 574b1742570SAlexander Graf ramargs = {} 575b1742570SAlexander Graf ramargs['page_size'] = self.vmsd_desc['page_size'] 576b1742570SAlexander Graf ramargs['dump_memory'] = dump_memory 577b1742570SAlexander Graf ramargs['write_memory'] = write_memory 578ff40c7f0SFabiano Rosas ramargs['ignore_shared'] = False 579b1742570SAlexander Graf self.section_classes[('ram',0)][1] = ramargs 580b1742570SAlexander Graf 581b1742570SAlexander Graf while True: 582b1742570SAlexander Graf section_type = file.read8() 583b1742570SAlexander Graf if section_type == self.QEMU_VM_EOF: 584b1742570SAlexander Graf break 58596e5c9bcSMark Cave-Ayland elif section_type == self.QEMU_VM_CONFIGURATION: 586c36c31c8SFabiano Rosas config_desc = self.vmsd_desc.get('configuration') 587c36c31c8SFabiano Rosas section = ConfigurationSection(file, config_desc) 58896e5c9bcSMark Cave-Ayland section.read() 589ff40c7f0SFabiano Rosas ramargs['ignore_shared'] = section.has_capability('x-ignore-shared') 590b1742570SAlexander Graf elif section_type == self.QEMU_VM_SECTION_START or section_type == self.QEMU_VM_SECTION_FULL: 591b1742570SAlexander Graf section_id = file.read32() 592b1742570SAlexander Graf name = file.readstr() 593b1742570SAlexander Graf instance_id = file.read32() 594b1742570SAlexander Graf version_id = file.read32() 595b1742570SAlexander Graf section_key = (name, instance_id) 596b1742570SAlexander Graf classdesc = self.section_classes[section_key] 597b1742570SAlexander Graf section = classdesc[0](file, version_id, classdesc[1], section_key) 598b1742570SAlexander Graf self.sections[section_id] = section 599b1742570SAlexander Graf section.read() 600b1742570SAlexander Graf elif section_type == self.QEMU_VM_SECTION_PART or section_type == self.QEMU_VM_SECTION_END: 601b1742570SAlexander Graf section_id = file.read32() 602b1742570SAlexander Graf self.sections[section_id].read() 60373d9a796SDr. David Alan Gilbert elif section_type == self.QEMU_VM_SECTION_FOOTER: 60473d9a796SDr. David Alan Gilbert read_section_id = file.read32() 60573d9a796SDr. David Alan Gilbert if read_section_id != section_id: 60673d9a796SDr. David Alan Gilbert raise Exception("Mismatched section footer: %x vs %x" % (read_section_id, section_id)) 607b1742570SAlexander Graf else: 608b1742570SAlexander Graf raise Exception("Unknown section type: %d" % section_type) 609b1742570SAlexander Graf file.close() 610b1742570SAlexander Graf 611b1742570SAlexander Graf def load_vmsd_json(self, file): 612b1742570SAlexander Graf vmsd_json = file.read_migration_debug_json() 613b1742570SAlexander Graf self.vmsd_desc = json.loads(vmsd_json, object_pairs_hook=collections.OrderedDict) 614b1742570SAlexander Graf for device in self.vmsd_desc['devices']: 615b1742570SAlexander Graf key = (device['name'], device['instance_id']) 616b1742570SAlexander Graf value = ( VMSDSection, device ) 617b1742570SAlexander Graf self.section_classes[key] = value 618b1742570SAlexander Graf 619b1742570SAlexander Graf def getDict(self): 620b1742570SAlexander Graf r = collections.OrderedDict() 621b1742570SAlexander Graf for (key, value) in self.sections.items(): 622b1742570SAlexander Graf key = "%s (%d)" % ( value.section_key[0], key ) 623b1742570SAlexander Graf r[key] = value.getDict() 624b1742570SAlexander Graf return r 625b1742570SAlexander Graf 626b1742570SAlexander Graf############################################################################### 627b1742570SAlexander Graf 628b1742570SAlexander Grafclass JSONEncoder(json.JSONEncoder): 629b1742570SAlexander Graf def default(self, o): 630b1742570SAlexander Graf if isinstance(o, VMSDFieldGeneric): 631b1742570SAlexander Graf return str(o) 632b1742570SAlexander Graf return json.JSONEncoder.default(self, o) 633b1742570SAlexander Graf 634b1742570SAlexander Grafparser = argparse.ArgumentParser() 635b1742570SAlexander Grafparser.add_argument("-f", "--file", help='migration dump to read from', required=True) 636b1742570SAlexander Grafparser.add_argument("-m", "--memory", help='dump RAM contents as well', action='store_true') 637b1742570SAlexander Grafparser.add_argument("-d", "--dump", help='what to dump ("state" or "desc")', default='state') 638b1742570SAlexander Grafparser.add_argument("-x", "--extract", help='extract contents into individual files', action='store_true') 639b1742570SAlexander Grafargs = parser.parse_args() 640b1742570SAlexander Graf 641b1742570SAlexander Grafjsonenc = JSONEncoder(indent=4, separators=(',', ': ')) 642b1742570SAlexander Graf 643b1742570SAlexander Grafif args.extract: 644b1742570SAlexander Graf dump = MigrationDump(args.file) 645b1742570SAlexander Graf 646b1742570SAlexander Graf dump.read(desc_only = True) 647f03868bdSEduardo Habkost print("desc.json") 6482c92be50SLaurent Vivier f = open("desc.json", "w") 649b1742570SAlexander Graf f.truncate() 650b1742570SAlexander Graf f.write(jsonenc.encode(dump.vmsd_desc)) 651b1742570SAlexander Graf f.close() 652b1742570SAlexander Graf 653b1742570SAlexander Graf dump.read(write_memory = True) 654b1742570SAlexander Graf dict = dump.getDict() 655f03868bdSEduardo Habkost print("state.json") 6562c92be50SLaurent Vivier f = open("state.json", "w") 657b1742570SAlexander Graf f.truncate() 658b1742570SAlexander Graf f.write(jsonenc.encode(dict)) 659b1742570SAlexander Graf f.close() 660b1742570SAlexander Grafelif args.dump == "state": 661b1742570SAlexander Graf dump = MigrationDump(args.file) 662b1742570SAlexander Graf dump.read(dump_memory = args.memory) 663b1742570SAlexander Graf dict = dump.getDict() 664f03868bdSEduardo Habkost print(jsonenc.encode(dict)) 665b1742570SAlexander Grafelif args.dump == "desc": 666b1742570SAlexander Graf dump = MigrationDump(args.file) 667b1742570SAlexander Graf dump.read(desc_only = True) 668f03868bdSEduardo Habkost print(jsonenc.encode(dump.vmsd_desc)) 669b1742570SAlexander Grafelse: 670f98d372aSLaurent Vivier raise Exception("Please specify either -x, -d state or -d desc") 671