tools/jailhouse-config-create

   1 #!/usr/bin/env python
   2 #
   3 # Jailhouse, a Linux-based partitioning hypervisor
   4 #
   5 # Copyright (c) Siemens AG, 2014
   6 #
   7 # This work is licensed under the terms of the GNU GPL, version 2.  See
   8 # the COPYING file in the top-level directory.
   9 #
  10 # This script should help to create a basic jailhouse configuration file.
  11 # It needs to be executed on the target machine, where it will gather
  12 # information about the system. For more advanced scenarios you will have
  13 # to change the generated C-code.
  14
  15 from __future__ import print_function
  16 import sys
  17 import os
  18 import re
  19 import argparse
  20 import struct
  21 from mako.template import Template
  22
  23 abspath = os.path.abspath(os.path.dirname(sys.argv[0]))
  24
  25 # pretend to be part of the jailhouse tool
  26 sys.argv[0] = sys.argv[0].replace('-', ' ')
  27
  28 parser = argparse.ArgumentParser()
  29 parser.add_argument('-g', '--generate-collector',
  30                     help='generate a script to collect input files on '
  31                          'a remote machine',
  32                     action='store_true')
  33 parser.add_argument('-r', '--root',
  34                     help='gather information in ROOT/, the default is "/" '
  35                          'which means creating a config for localhost',
  36                     default='/',
  37                     action='store',
  38                     type=str)
  39 parser.add_argument('-t', '--template-dir',
  40                     help='the directory where the templates are located,'
  41                          'the default is "' + abspath + '"',
  42                     default=abspath,
  43                     action='store',
  44                     type=str)
  45
  46 memargs = [['--mem-inmates', '2M', 'inmate'],
  47            ['--mem-hv', '64M', 'hypervisor']]
  48
  49 for entry in memargs:
  50     parser.add_argument(entry[0],
  51                         help='the amount of ' + entry[2] +
  52                              ' memory, default is "' + entry[1] +
  53                              '", format "xxx[K|M|G]"',
  54                         default=entry[1],
  55                         action='store',
  56                         type=str)
  57
  58 parser.add_argument('file', metavar='FILE',
  59                     help='name of file to write out',
  60                     type=str)
  61
  62 options = parser.parse_args()
  63
  64 inputs = {'files': set(), 'files_opt': set(), 'dirs': set()}
  65
  66
  67 class PCICapability:
  68     def __init__(self, id, start, len, flags):
  69         self.id = id
  70         self.start = start
  71         self.len = len
  72         self.flags = flags
  73         self.comments = []
  74
  75     def __eq__(self, other):
  76         return self.id == other.id and self.start == other.start and \
  77             self.len == other.len and self.flags == other.flags
  78
  79     RD = '0'
  80     RW = 'JAILHOUSE_PCICAPS_WRITE'
  81
  82     @staticmethod
  83     def parse_pcicaps(dir):
  84         caps = []
  85         f = input_open(os.path.join(dir, 'config'), 'rb')
  86         f.seek(0x06)
  87         (status,) = struct.unpack('<H', f.read(2))
  88         # capability list supported?
  89         if (status & (1 << 4)) == 0:
  90             f.close()
  91             return caps
  92         # walk capability list
  93         f.seek(0x34)
  94         (next,) = struct.unpack('B', f.read(1))
  95         while next != 0:
  96             cap = next
  97             f.seek(cap)
  98             (id, next) = struct.unpack('<BB', f.read(2))
  99             if id == 0x01:  # Power Management
 100                 # this cap can be handed out completely
 101                 len = 8
 102                 flags = PCICapability.RW
 103             elif id == 0x05:  # MSI
 104                 # access will be moderated by hypervisor
 105                 len = 10
 106                 (msgctl,) = struct.unpack('<H', f.read(2))
 107                 if (msgctl & (1 << 7)) != 0:  # 64-bit support
 108                     len += 4
 109                 if (msgctl & (1 << 8)) != 0:  # per-vector masking support
 110                     len += 10
 111                 flags = PCICapability.RW
 112             elif id == 0x11:  # MSI-X
 113                 # access will be moderated by hypervisor
 114                 len = 12
 115                 flags = PCICapability.RW
 116             else:
 117                 # unknown/unhandled cap, mark its existence
 118                 len = 2
 119                 flags = PCICapability.RD
 120             caps.append(PCICapability(id, cap, len, flags))
 121         return caps
 122
 123
 124 class PCIDevice:
 125     def __init__(self, type, domain, bus, dev, fn, caps):
 126         self.type = type
 127         self.domain = domain
 128         self.bus = bus
 129         self.dev = dev
 130         self.fn = fn
 131         self.caps = caps
 132         self.caps_start = 0
 133         self.num_caps = len(caps)
 134
 135     def __str__(self):
 136         return 'PCIDevice: %02x:%02x.%x' % (self.bus, self.dev, self.fn)
 137
 138     def bdf(self):
 139         return self.bus << 8 | self.dev << 3 | self.fn
 140
 141     @staticmethod
 142     def parse_pcidevice_sysfsdir(basedir, dir):
 143         dpath = os.path.join(basedir, dir)
 144         dclass = input_readline(os.path.join(dpath, 'class'))
 145         if re.match(r'0x0604..', dclass):
 146             type = 'JAILHOUSE_PCI_TYPE_BRIDGE'
 147         else:
 148             type = 'JAILHOUSE_PCI_TYPE_DEVICE'
 149         a = dir.split(':')
 150         domain = int(a[0], 16)
 151         bus = int(a[1], 16)
 152         df = a[2].split('.')
 153         caps = PCICapability.parse_pcicaps(dpath)
 154         return PCIDevice(type, domain, bus, int(df[0], 16), int(df[1], 16),
 155                          caps)
 156
 157
 158 class MemRegion:
 159     def __init__(self, start, stop, typestr, comments=None):
 160         self.start = start
 161         self.stop = stop
 162         self.typestr = typestr
 163         if comments is None:
 164             self.comments = []
 165         else:
 166             self.comments = comments
 167
 168     def __str__(self):
 169         return 'MemRegion: %08x-%08x : %s' % \
 170             (self.start, self.stop, self.typestr)
 171
 172     def size(self):
 173         # round up to full PAGE_SIZE
 174         return int((self.stop - self.start + 0xfff) / 0x1000) * 0x1000
 175
 176     def flagstr(self, p=''):
 177         if (
 178             self.typestr == 'ACPI Tables' or
 179             self.typestr == 'ACPI Non-volatile Storage'
 180         ):
 181             return 'JAILHOUSE_MEM_READ'
 182         if (
 183             self.typestr == 'System RAM' or
 184             self.typestr == 'RAM buffer' or
 185             self.typestr == 'ACPI DMAR RMRR'
 186         ):
 187             s = 'JAILHOUSE_MEM_READ | JAILHOUSE_MEM_WRITE |\n'
 188             s += p + '\t\tJAILHOUSE_MEM_EXECUTE | JAILHOUSE_MEM_DMA'
 189             return s
 190         return 'JAILHOUSE_MEM_READ | JAILHOUSE_MEM_WRITE'
 191
 192
 193 class IOMemRegionTree:
 194     def __init__(self, region, level, linenum):
 195         self.region = region
 196         self.linenum = linenum
 197         self.level = level
 198         self.parent = None
 199         self.children = set()
 200
 201     def __str__(self):
 202         s = ''
 203         if (self.region):
 204             s = (' ' * (self.level - 1)) + str(self.region) + ' line %d' \
 205                 % (self.linenum)
 206             if self.parent and self.parent.region:
 207                 s += '--> ' + self.parent.region.typestr + ' line %d' \
 208                     % (self.parent.linenum)
 209             s += '\n'
 210         for c in self.children:
 211             s += str(c)
 212         return s
 213
 214     @staticmethod
 215     def parse_iomem_line(line):
 216         a = line.split(':', 1)
 217         level = int(a[0].count(' ') / 2) + 1
 218         region = a[0].split('-', 1)
 219         a[1] = a[1].strip()
 220         return level, MemRegion(int(region[0], 16), int(region[1], 16), a[1])
 221
 222     @staticmethod
 223     def parse_iomem_file():
 224         root = IOMemRegionTree(None, 0, -1)
 225         f = input_open('/proc/iomem')
 226         lastlevel = 0
 227         lastnode = root
 228         linenum = 0
 229         for line in f:
 230             (level, r) = IOMemRegionTree.parse_iomem_line(line)
 231             t = IOMemRegionTree(r, level, linenum)
 232             if (t.level > lastlevel):
 233                 t.parent = lastnode
 234             if (t.level == lastlevel):
 235                 t.parent = lastnode.parent
 236             if (t.level < lastlevel):
 237                 p = lastnode.parent
 238                 while(t.level < p.level):
 239                     p = p.parent
 240                 t.parent = p.parent
 241
 242             t.parent.children.add(t)
 243             lastnode = t
 244             lastlevel = t.level
 245             linenum += 1
 246         f.close()
 247
 248         return linenum, root
 249
 250     # recurse down the tree
 251     @staticmethod
 252     def parse_iomem_tree(tree):
 253         regions = []
 254         linenumbers = []
 255
 256         for tree in tree.children:
 257             r = tree.region
 258             s = r.typestr
 259
 260             # System RAM on first level will be added without digging deeper
 261             if (tree.level == 1 and s == 'System RAM'):
 262                 regions.append(r)
 263                 linenumbers.append(tree.linenum)
 264                 continue
 265
 266             # blacklisted on all levels
 267             if (
 268                 (s.find('PCI MMCONFIG') >= 0) or
 269                 (s.find('APIC') >= 0)
 270             ):
 271                 continue
 272
 273             # generally blacklisted, unless we find an HPET right behind it
 274             # on the next level
 275             if (s == 'reserved'):
 276                 for subtree in tree.children:
 277                     r2 = subtree.region
 278                     if (r2.typestr.find('HPET') >= 0):
 279                         regions.append(r2)
 280                         linenumbers.append(subtree.linenum)
 281                 continue
 282
 283             # if the tree continues recurse further down ...
 284             if (len(tree.children) > 0):
 285                 ln2, r2 = IOMemRegionTree.parse_iomem_tree(tree)
 286                 linenumbers.extend(ln2)
 287                 regions.extend(r2)
 288                 continue
 289
 290             # add all remaining leaves
 291             regions.append(r)
 292             linenumbers.append(tree.linenum)
 293
 294         return linenumbers, regions
 295
 296
 297 def parse_iomem():
 298     (maxsz, tree) = IOMemRegionTree.parse_iomem_file()
 299
 300     # create a spare array so we can easiely keep the order from the file
 301     regions = [None for x in range(maxsz)]
 302
 303     lines, regs = IOMemRegionTree.parse_iomem_tree(tree)
 304     i = 0
 305     for l in lines:
 306         regions[l] = regs[i]
 307         i += 1
 308
 309     # now prepare a non-sparse array for a return value
 310     ret = []
 311     for r in regions:
 312         if r:
 313             ret.append(r)
 314
 315     # newer Linux kernels will report the first page as reserved
 316     # it is needed for CPU init so include it anyways
 317     if (ret[0].typestr == 'System RAM' and ret[0].start == 0x1000):
 318         ret[0].start = 0
 319
 320     return ret
 321
 322
 323 def parse_pcidevices():
 324     devices = []
 325     caps = []
 326     basedir = '/sys/bus/pci/devices'
 327     list = input_listdir(basedir, ['*/class', '*/config'])
 328     for dir in list:
 329         d = PCIDevice.parse_pcidevice_sysfsdir(basedir, dir)
 330         if d is not None:
 331             if len(d.caps) > 0:
 332                 duplicate = False
 333                 # look for duplicate capability patterns
 334                 for d2 in devices:
 335                     if d2.caps == d.caps:
 336                         # reused existing capability list, but record all users
 337                         d2.caps[0].comments.append(str(d))
 338                         d.caps_start = d2.caps_start
 339                         duplicate = True
 340                         break
 341                 if not duplicate:
 342                     d.caps[0].comments.append(str(d))
 343                     d.caps_start = len(caps)
 344                     caps.extend(d.caps)
 345             devices.append(d)
 346     return (devices, caps)
 347
 348
 349 def kmg_multiply(value, kmg):
 350     if (kmg == 'K' or kmg == 'k'):
 351         return 1024 * value
 352     if (kmg == 'M' or kmg == 'm'):
 353         return 1024**2 * value
 354     if (kmg == 'G' or kmg == 'g'):
 355         return 1024**3 * value
 356     return value
 357
 358
 359 def kmg_multiply_str(str):
 360     m = re.match(r'([0-9a-fA-FxX]+)([KMG]?)', str)
 361     if m is not None:
 362         return kmg_multiply(int(m.group(1)), m.group(2))
 363     raise RuntimeError('kmg_multiply_str can not parse input "' + str + '"')
 364     return 0
 365
 366
 367 def input_open(name, mode='r', optional=False):
 368     inputs['files_opt' if optional else 'files'].add(name)
 369     try:
 370         f = open(options.root + name, mode)
 371     except Exception as e:
 372         if optional or options.generate_collector:
 373             return open("/dev/null", mode)
 374         raise e
 375     return f
 376
 377
 378 def input_readline(name, optional=False):
 379     f = input_open(name, optional=optional)
 380     line = f.readline()
 381     f.close()
 382     return line
 383
 384
 385 def input_listdir(dir, wildcards):
 386     for w in wildcards:
 387         inputs['dirs'].add(os.path.join(dir, w))
 388     if options.generate_collector:
 389         return []
 390     dirs = os.listdir(options.root + dir)
 391     dirs.sort()
 392     return dirs
 393
 394
 395 def parse_cmdline():
 396     line = input_readline('/proc/cmdline')
 397     m = re.match(r'.*memmap=([0-9a-fA-FxX]+)([KMG]?)\$'
 398                  '([0-9a-fA-FxX]+)([KMG]?).*',
 399                  line)
 400     if m is not None:
 401         size = kmg_multiply(int(m.group(1), 0), m.group(2))
 402         start = kmg_multiply(int(m.group(3), 0), m.group(4))
 403         return [start, size]
 404     return None
 405
 406
 407 def alloc_mem(regions, size):
 408     mem = [0, size]
 409     for r in reversed(regions):
 410         if (r.typestr == 'System RAM' and r.size() >= mem[1]):
 411             mem[0] = r.start
 412             r.start += mem[1]
 413             return mem
 414     raise RuntimeError('failed to allocate memory')
 415
 416
 417 def count_cpus():
 418     list = input_listdir('/sys/devices/system/cpu', ['cpu*/uevent'])
 419     count = 0
 420     for f in list:
 421         if re.match(r'cpu[0-9]+', f):
 422             count += 1
 423     return count
 424
 425
 426 def parse_dmar_devscope(f):
 427     offset = 0
 428     (scope_type, scope_len, bus, dev, fn) = \
 429         struct.unpack('<BBxxxBBB', f.read(8))
 430     offset += 8
 431     return (offset, scope_type, scope_len, bus, dev, fn)
 432
 433
 434 # parsing of DMAR ACPI Table
 435 # see Intel VT-d Spec chapter 8
 436 def parse_dmar():
 437     f = input_open('/sys/firmware/acpi/tables/DMAR', 'rb')
 438     signature = f.read(4)
 439     if signature != b'DMAR':
 440         if options.generate_collector:
 441             return [], 0, []
 442         raise RuntimeError('incorrect input file format %s' % signature)
 443     (length,) = struct.unpack('<I', f.read(4))
 444     f.seek(48)
 445     length -= 48
 446     units = []
 447     regions = []
 448     ioapic_id = 0
 449
 450     while length > 0:
 451         offset = 0
 452         (struct_type, struct_len) = struct.unpack('<HH', f.read(4))
 453         offset += 4
 454         length -= struct_len
 455
 456         # DMA Remapping Hardware Unit Definition
 457         if struct_type == 0:
 458             (segment, base) = struct.unpack('<xxHQ', f.read(12))
 459             if segment != 0:
 460                 raise RuntimeError('We do not support multiple PCI segments')
 461             if len(units) >= 8:
 462                 raise RuntimeError('Too many DMAR units. '
 463                                    'Raise JAILHOUSE_MAX_DMAR_UNITS.')
 464             units.append(base)
 465             offset += 16 - offset
 466             while offset < struct_len:
 467                 (off, scope_type, scope_len, bus, dev, fn) =\
 468                     parse_dmar_devscope(f)
 469                 offset += off
 470                 if scope_type == 3:
 471                     if ioapic_id != 0:
 472                         raise RuntimeError('We do not support more '
 473                                            'than 1 IOAPIC')
 474                     ioapic_id = (bus << 8) | (dev << 3) | fn
 475                 f.seek(scope_len - 8, os.SEEK_CUR)
 476                 offset += scope_len - 8
 477
 478         # Reserved Memory Region Reporting Structure
 479         if struct_type == 1:
 480             f.seek(8 - offset, os.SEEK_CUR)
 481             offset += 8 - offset
 482             (base, limit) = struct.unpack('<QQ', f.read(16))
 483             offset += 16
 484
 485             comments = []
 486             while offset < struct_len:
 487                 (off, scope_type, scope_len, bus, dev, fn) =\
 488                     parse_dmar_devscope(f)
 489                 offset += off
 490                 npath = (scope_len - 6)/2
 491                 if scope_type == 1 and npath == 1:
 492                     comments.append('PCI device: %02x:%02x.%x' %
 493                                     (bus, dev, fn))
 494                 else:
 495                     comments.append('DMAR parser could not decode device path')
 496                 f.seek(scope_len - off, os.SEEK_CUR)
 497                 offset += scope_len - off
 498
 499             reg = MemRegion(base, limit, 'ACPI DMAR RMRR', comments)
 500             regions.append(reg)
 501
 502         f.seek(struct_len - offset, os.SEEK_CUR)
 503
 504     return units, ioapic_id, regions
 505
 506
 507 def parse_ioports():
 508     pm_timer_base = None
 509     f = input_open('/proc/ioports')
 510     for line in f:
 511         if line.endswith('ACPI PM_TMR\n'):
 512             pm_timer_base = int(line.split('-')[0], 16)
 513             break
 514     f.close()
 515     return pm_timer_base
 516
 517
 518 class MMConfig:
 519     def __init__(self, base, end_bus):
 520         self.base = base
 521         self.end_bus = end_bus
 522
 523     @staticmethod
 524     def parse():
 525         f = input_open('/sys/firmware/acpi/tables/MCFG', 'rb')
 526         signature = f.read(4)
 527         if signature != b'MCFG':
 528             if options.generate_collector:
 529                 return MMConfig(0, 0)
 530             raise RuntimeError('incorrect input file format %s' % signature)
 531         (length,) = struct.unpack('<I', f.read(4))
 532         if length > 60:
 533             raise RuntimeError('Multiple MMCONFIG regions found! '
 534                                'This is not supported')
 535         f.seek(44)
 536         (base, segment, start_bus, end_bus) = \
 537             struct.unpack('<QHBB', f.read(12))
 538         if segment != 0 or start_bus != 0:
 539             raise RuntimeError('Invalid MCFG structure found')
 540         return MMConfig(base, end_bus)
 541
 542
 543 if (
 544     (options.generate_collector is False) and (options.root is '/')
 545     and (os.geteuid() is not 0)
 546 ):
 547     print('ERROR: You have to be root to work on "/"!', file=sys.stderr)
 548     sys.exit(1)
 549
 550 (pcidevices, pcicaps) = parse_pcidevices()
 551
 552 product = [input_readline('/sys/class/dmi/id/sys_vendor',
 553                           True).rstrip(),
 554            input_readline('/sys/class/dmi/id/product_name',
 555                           True).rstrip()
 556            ]
 557
 558 inmatemem = kmg_multiply_str(options.mem_inmates)
 559 hvmem = [0, kmg_multiply_str(options.mem_hv)]
 560
 561 regions = parse_iomem()
 562 ourmem = parse_cmdline()
 563 total = hvmem[1] + inmatemem
 564
 565 mmconfig = MMConfig.parse()
 566
 567 (dmar_units, ioapic_id, rmrr_regs) = parse_dmar()
 568 regions += rmrr_regs
 569
 570 # kernel does not have memmap region, pick one
 571 if ourmem is None:
 572     ourmem = alloc_mem(regions, total)
 573 elif (total > ourmem[1]):
 574     raise RuntimeError('Your memmap reservation is too small you need >="' +
 575                        hex(total) + '"')
 576
 577 hvmem[0] = ourmem[0]
 578
 579 inmatereg = MemRegion(ourmem[0] + hvmem[1],
 580                       ourmem[0] + hvmem[1] + inmatemem - 1,
 581                       'JAILHOUSE Inmate Memory')
 582 regions.append(inmatereg)
 583
 584 cpucount = count_cpus()
 585
 586 pm_timer_base = parse_ioports()
 587
 588 jh_enabled = input_readline('/sys/devices/jailhouse/enabled',
 589                             True).rstrip()
 590 if options.generate_collector is False and jh_enabled == '1':
 591     print('ERROR: Jailhouse was enabled when collecting input files! '
 592           'Disable jailhouse and try again.',
 593           file=sys.stderr)
 594     sys.exit(1)
 595
 596 f = open(options.file, 'w')
 597
 598 if options.generate_collector:
 599     filelist = ' '.join(inputs['files'].union(inputs['dirs']))
 600     filelist_opt = ' '.join(inputs['files_opt'])
 601
 602     tmpl = Template(filename=os.path.join(options.template_dir,
 603                                           'jailhouse-config-collect.tmpl'))
 604     f.write(tmpl.render(filelist=filelist, filelist_opt=filelist_opt))
 605 else:
 606     tmpl = Template(filename=os.path.join(options.template_dir,
 607                                           'root-cell-config.c.tmpl'))
 608     f.write(tmpl.render(regions=regions,
 609                         ourmem=ourmem,
 610                         argstr=' '.join(sys.argv),
 611                         hvmem=hvmem,
 612                         product=product,
 613                         pcidevices=pcidevices,
 614                         pcicaps=pcicaps,
 615                         cpucount=cpucount,
 616                         ioapic_id=ioapic_id,
 617                         pm_timer_base=pm_timer_base,
 618                         mmconfig=mmconfig,
 619                         dmar_units=dmar_units))
 620
 621 f.close()