3 # Jailhouse, a Linux-based partitioning hypervisor
5 # Copyright (c) Siemens AG, 2014
7 # This work is licensed under the terms of the GNU GPL, version 2. See
8 # the COPYING file in the top-level directory.
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.
15 from __future__ import print_function
21 from mako.template import Template
23 abspath = os.path.abspath(os.path.dirname(sys.argv[0]))
25 # pretend to be part of the jailhouse tool
26 sys.argv[0] = sys.argv[0].replace('-', ' ')
28 parser = argparse.ArgumentParser()
29 parser.add_argument('-g', '--generate-collector',
30 help='generate a script to collect input files on '
33 parser.add_argument('-r', '--root',
34 help='gather information in ROOT/, the default is "/" '
35 'which means creating a config for localhost',
39 parser.add_argument('-t', '--template-dir',
40 help='the directory where the templates are located,'
41 'the default is "' + abspath + '"',
46 memargs = [['--mem-inmates', '2M', 'inmate'],
47 ['--mem-hv', '64M', 'hypervisor']]
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]"',
58 parser.add_argument('file', metavar='FILE',
59 help='name of file to write out',
62 options = parser.parse_args()
64 inputs = {'files': set(), 'files_opt': set(), 'dirs': set()}
67 def kmg_multiply(value, kmg):
68 if (kmg == 'K' or kmg == 'k'):
70 if (kmg == 'M' or kmg == 'm'):
71 return 1024**2 * value
72 if (kmg == 'G' or kmg == 'g'):
73 return 1024**3 * value
77 def kmg_multiply_str(str):
78 m = re.match(r'([0-9a-fA-FxX]+)([KMG]?)', str)
80 return kmg_multiply(int(m.group(1)), m.group(2))
81 raise RuntimeError('kmg_multiply_str can not parse input "' + str + '"')
85 def input_open(name, mode='r', optional=False):
86 inputs['files_opt' if optional else 'files'].add(name)
88 f = open(options.root + name, mode)
89 except Exception as e:
90 if optional or options.generate_collector:
91 return open("/dev/null", mode)
96 def input_readline(name, optional=False):
97 f = input_open(name, optional=optional)
103 def input_listdir(dir, wildcards):
105 inputs['dirs'].add(os.path.join(dir, w))
106 if options.generate_collector:
108 dirs = os.listdir(options.root + dir)
114 def __init__(self, id, start, len, flags):
121 def __eq__(self, other):
122 return self.id == other.id and self.start == other.start and \
123 self.len == other.len and self.flags == other.flags
126 RW = 'JAILHOUSE_PCICAPS_WRITE'
129 def parse_pcicaps(dir):
131 f = input_open(os.path.join(dir, 'config'), 'rb')
133 (status,) = struct.unpack('<H', f.read(2))
134 # capability list supported?
135 if (status & (1 << 4)) == 0:
138 # walk capability list
140 (next,) = struct.unpack('B', f.read(1))
144 (id, next) = struct.unpack('<BB', f.read(2))
145 if id == 0x01: # Power Management
146 # this cap can be handed out completely
148 flags = PCICapability.RW
149 elif id == 0x05: # MSI
150 # access will be moderated by hypervisor
152 (msgctl,) = struct.unpack('<H', f.read(2))
153 if (msgctl & (1 << 7)) != 0: # 64-bit support
155 if (msgctl & (1 << 8)) != 0: # per-vector masking support
157 flags = PCICapability.RW
158 elif id == 0x11: # MSI-X
159 # access will be moderated by hypervisor
161 flags = PCICapability.RW
163 # unknown/unhandled cap, mark its existence
165 flags = PCICapability.RD
166 caps.append(PCICapability(id, cap, len, flags))
171 def __init__(self, type, domain, bus, dev, fn, caps):
179 self.num_caps = len(caps)
182 return 'PCIDevice: %02x:%02x.%x' % (self.bus, self.dev, self.fn)
185 return self.bus << 8 | self.dev << 3 | self.fn
188 def parse_pcidevice_sysfsdir(basedir, dir):
189 dpath = os.path.join(basedir, dir)
190 dclass = input_readline(os.path.join(dpath, 'class'))
191 if re.match(r'0x0604..', dclass):
192 type = 'JAILHOUSE_PCI_TYPE_BRIDGE'
194 type = 'JAILHOUSE_PCI_TYPE_DEVICE'
196 domain = int(a[0], 16)
199 caps = PCICapability.parse_pcicaps(dpath)
200 return PCIDevice(type, domain, bus, int(df[0], 16), int(df[1], 16),
205 def __init__(self, start, stop, typestr, comments=None):
208 self.typestr = typestr
212 self.comments = comments
215 return 'MemRegion: %08x-%08x : %s' % \
216 (self.start, self.stop, self.typestr)
219 # round up to full PAGE_SIZE
220 return int((self.stop - self.start + 0xfff) / 0x1000) * 0x1000
222 def flagstr(self, p=''):
224 self.typestr == 'ACPI Tables' or
225 self.typestr == 'ACPI Non-volatile Storage'
227 return 'JAILHOUSE_MEM_READ'
229 self.typestr == 'System RAM' or
230 self.typestr == 'RAM buffer' or
231 self.typestr == 'ACPI DMAR RMRR'
233 s = 'JAILHOUSE_MEM_READ | JAILHOUSE_MEM_WRITE |\n'
234 s += p + '\t\tJAILHOUSE_MEM_EXECUTE | JAILHOUSE_MEM_DMA'
236 return 'JAILHOUSE_MEM_READ | JAILHOUSE_MEM_WRITE'
239 class IOMemRegionTree:
240 def __init__(self, region, level, linenum):
242 self.linenum = linenum
245 self.children = set()
250 s = (' ' * (self.level - 1)) + str(self.region) + ' line %d' \
252 if self.parent and self.parent.region:
253 s += '--> ' + self.parent.region.typestr + ' line %d' \
254 % (self.parent.linenum)
256 for c in self.children:
261 def parse_iomem_line(line):
262 a = line.split(':', 1)
263 level = int(a[0].count(' ') / 2) + 1
264 region = a[0].split('-', 1)
266 return level, MemRegion(int(region[0], 16), int(region[1], 16), a[1])
269 def parse_iomem_file():
270 root = IOMemRegionTree(None, 0, -1)
271 f = input_open('/proc/iomem')
276 (level, r) = IOMemRegionTree.parse_iomem_line(line)
277 t = IOMemRegionTree(r, level, linenum)
278 if (t.level > lastlevel):
280 if (t.level == lastlevel):
281 t.parent = lastnode.parent
282 if (t.level < lastlevel):
284 while(t.level < p.level):
288 t.parent.children.add(t)
296 # recurse down the tree
298 def parse_iomem_tree(tree):
302 for tree in tree.children:
306 # System RAM on first level will be added without digging deeper
307 if (tree.level == 1 and s == 'System RAM'):
309 linenumbers.append(tree.linenum)
312 # blacklisted on all levels
314 (s.find('PCI MMCONFIG') >= 0) or
315 (s.find('APIC') >= 0) or # covers both APIC and IOAPIC
316 (s.find('dmar') >= 0)
320 # generally blacklisted, unless we find an HPET right behind it
322 if (s == 'reserved'):
323 for subtree in tree.children:
325 if (r2.typestr.find('HPET') >= 0):
327 linenumbers.append(subtree.linenum)
330 # if the tree continues recurse further down ...
331 if (len(tree.children) > 0):
332 ln2, r2 = IOMemRegionTree.parse_iomem_tree(tree)
333 linenumbers.extend(ln2)
337 # add all remaining leaves
339 linenumbers.append(tree.linenum)
341 return linenumbers, regions
345 (maxsz, tree) = IOMemRegionTree.parse_iomem_file()
347 # create a spare array so we can easiely keep the order from the file
348 regions = [None for x in range(maxsz)]
350 lines, regs = IOMemRegionTree.parse_iomem_tree(tree)
356 # now prepare a non-sparse array for a return value
362 # newer Linux kernels will report the first page as reserved
363 # it is needed for CPU init so include it anyways
364 if (ret[0].typestr == 'System RAM' and ret[0].start == 0x1000):
370 def parse_pcidevices():
373 basedir = '/sys/bus/pci/devices'
374 list = input_listdir(basedir, ['*/class', '*/config'])
376 d = PCIDevice.parse_pcidevice_sysfsdir(basedir, dir)
380 # look for duplicate capability patterns
382 if d2.caps == d.caps:
383 # reused existing capability list, but record all users
384 d2.caps[0].comments.append(str(d))
385 d.caps_start = d2.caps_start
389 d.caps[0].comments.append(str(d))
390 d.caps_start = len(caps)
393 return (devices, caps)
397 line = input_readline('/proc/cmdline')
398 m = re.match(r'.*memmap=([0-9a-fA-FxX]+)([KMG]?)\$'
399 '([0-9a-fA-FxX]+)([KMG]?).*',
402 size = kmg_multiply(int(m.group(1), 0), m.group(2))
403 start = kmg_multiply(int(m.group(3), 0), m.group(4))
408 def alloc_mem(regions, size):
410 for r in reversed(regions):
411 if (r.typestr == 'System RAM' and r.size() >= mem[1]):
415 raise RuntimeError('failed to allocate memory')
419 list = input_listdir('/sys/devices/system/cpu', ['cpu*/uevent'])
422 if re.match(r'cpu[0-9]+', f):
427 def parse_dmar_devscope(f):
428 (scope_type, scope_len, bus, dev, fn) = \
429 struct.unpack('<BBxxxBBB', f.read(8))
431 raise RuntimeError('Unsupported DMAR Device Scope Structure')
432 return (scope_type, scope_len, bus, dev, fn)
435 # parsing of DMAR ACPI Table
436 # see Intel VT-d Spec chapter 8
438 f = input_open('/sys/firmware/acpi/tables/DMAR', 'rb', True)
439 if get_cpu_vendor() == 'AuthenticAMD':
440 print('WARNING: AMD IOMMU support is not implemented yet')
442 signature = f.read(4)
443 if signature != b'DMAR':
444 if options.generate_collector:
446 raise RuntimeError('incorrect input file format %s' % signature)
447 (length,) = struct.unpack('<I', f.read(4))
456 (struct_type, struct_len) = struct.unpack('<HH', f.read(4))
460 # DMA Remapping Hardware Unit Definition
462 (segment, base) = struct.unpack('<xxHQ', f.read(12))
464 raise RuntimeError('We do not support multiple PCI segments')
466 raise RuntimeError('Too many DMAR units. '
467 'Raise JAILHOUSE_MAX_DMAR_UNITS.')
469 offset += 16 - offset
470 while offset < struct_len:
471 (scope_type, scope_len, bus, dev, fn) =\
472 parse_dmar_devscope(f)
475 raise RuntimeError('We do not support more '
477 ioapic_id = (bus << 8) | (dev << 3) | fn
480 # Reserved Memory Region Reporting Structure
482 f.seek(8 - offset, os.SEEK_CUR)
484 (base, limit) = struct.unpack('<QQ', f.read(16))
488 while offset < struct_len:
489 (scope_type, scope_len, bus, dev, fn) =\
490 parse_dmar_devscope(f)
492 comments.append('PCI device: %02x:%02x.%x' %
495 comments.append('DMAR parser could not decode device path')
498 reg = MemRegion(base, limit, 'ACPI DMAR RMRR', comments)
501 f.seek(struct_len - offset, os.SEEK_CUR)
503 return units, ioapic_id, regions
508 f = input_open('/proc/ioports')
510 if line.endswith('ACPI PM_TMR\n'):
511 pm_timer_base = int(line.split('-')[0], 16)
518 def __init__(self, base, end_bus):
520 self.end_bus = end_bus
524 f = input_open('/sys/firmware/acpi/tables/MCFG', 'rb')
525 signature = f.read(4)
526 if signature != b'MCFG':
527 if options.generate_collector:
528 return MMConfig(0, 0)
529 raise RuntimeError('incorrect input file format %s' % signature)
530 (length,) = struct.unpack('<I', f.read(4))
532 raise RuntimeError('Multiple MMCONFIG regions found! '
533 'This is not supported')
535 (base, segment, start_bus, end_bus) = \
536 struct.unpack('<QHBB', f.read(12))
537 if segment != 0 or start_bus != 0:
538 raise RuntimeError('Invalid MCFG structure found')
539 return MMConfig(base, end_bus)
543 (options.generate_collector is False) and (options.root is '/')
544 and (os.geteuid() is not 0)
546 print('ERROR: You have to be root to work on "/"!', file=sys.stderr)
549 def get_cpu_vendor():
550 with input_open('/proc/cpuinfo', 'r') as f:
554 key, value = line.split(':')
555 if key.strip() == 'vendor_id':
559 (pcidevices, pcicaps) = parse_pcidevices()
561 product = [input_readline('/sys/class/dmi/id/sys_vendor',
563 input_readline('/sys/class/dmi/id/product_name',
567 inmatemem = kmg_multiply_str(options.mem_inmates)
568 hvmem = [0, kmg_multiply_str(options.mem_hv)]
570 regions = parse_iomem()
571 ourmem = parse_cmdline()
572 total = hvmem[1] + inmatemem
574 mmconfig = MMConfig.parse()
576 (dmar_units, ioapic_id, rmrr_regs) = parse_dmar()
579 # kernel does not have memmap region, pick one
581 ourmem = alloc_mem(regions, total)
582 elif (total > ourmem[1]):
583 raise RuntimeError('Your memmap reservation is too small you need >="' +
588 inmatereg = MemRegion(ourmem[0] + hvmem[1],
589 ourmem[0] + hvmem[1] + inmatemem - 1,
590 'JAILHOUSE Inmate Memory')
591 regions.append(inmatereg)
593 cpucount = count_cpus()
595 pm_timer_base = parse_ioports()
597 jh_enabled = input_readline('/sys/devices/jailhouse/enabled',
599 if options.generate_collector is False and jh_enabled == '1':
600 print('ERROR: Jailhouse was enabled when collecting input files! '
601 'Disable jailhouse and try again.',
605 f = open(options.file, 'w')
607 if options.generate_collector:
608 filelist = ' '.join(inputs['files'].union(inputs['dirs']))
609 filelist_opt = ' '.join(inputs['files_opt'])
611 tmpl = Template(filename=os.path.join(options.template_dir,
612 'jailhouse-config-collect.tmpl'))
613 f.write(tmpl.render(filelist=filelist, filelist_opt=filelist_opt))
615 tmpl = Template(filename=os.path.join(options.template_dir,
616 'root-cell-config.c.tmpl'))
617 f.write(tmpl.render(regions=regions,
619 argstr=' '.join(sys.argv),
622 pcidevices=pcidevices,
626 pm_timer_base=pm_timer_base,
628 dmar_units=dmar_units))