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
22 from mako.template import Template
27 template_default_dir = datadir + "/jailhouse"
29 template_default_dir = os.path.abspath(os.path.dirname(sys.argv[0]))
33 # pretend to be part of the jailhouse tool
34 sys.argv[0] = sys.argv[0].replace('-', ' ')
36 parser = argparse.ArgumentParser()
37 parser.add_argument('-g', '--generate-collector',
38 help='generate a script to collect input files on '
41 parser.add_argument('-r', '--root',
42 help='gather information in ROOT/, the default is "/" '
43 'which means creating a config for localhost',
47 parser.add_argument('-t', '--template-dir',
48 help='the directory where the templates are located,'
49 'the default is "' + template_default_dir + '"',
50 default=template_default_dir,
54 memargs = [['--mem-inmates', '2M', 'inmate'],
55 ['--mem-hv', '64M', 'hypervisor']]
58 parser.add_argument(entry[0],
59 help='the amount of ' + entry[2] +
60 ' memory, default is "' + entry[1] +
61 '", format "xxx[K|M|G]"',
66 parser.add_argument('file', metavar='FILE',
67 help='name of file to write out',
70 options = parser.parse_args()
72 inputs = {'files': set(), 'files_opt': set(), 'files_intel': set()}
75 inputs['files'].add('/proc/iomem')
76 inputs['files'].add('/proc/cpuinfo')
77 inputs['files'].add('/proc/cmdline')
78 inputs['files'].add('/proc/ioports')
79 inputs['files'].add('/sys/bus/pci/devices/*/config')
80 inputs['files'].add('/sys/bus/pci/devices/*/class')
81 inputs['files'].add('/sys/devices/system/cpu/cpu*/uevent')
82 inputs['files'].add('/sys/firmware/acpi/tables/MCFG')
84 inputs['files_opt'].add('/sys/class/dmi/id/product_name')
85 inputs['files_opt'].add('/sys/class/dmi/id/sys_vendor')
86 inputs['files_opt'].add('/sys/devices/jailhouse/enabled')
87 ## platform specific files
88 inputs['files_intel'].add('/sys/firmware/acpi/tables/DMAR')
91 def kmg_multiply(value, kmg):
92 if (kmg == 'K' or kmg == 'k'):
94 if (kmg == 'M' or kmg == 'm'):
95 return 1024**2 * value
96 if (kmg == 'G' or kmg == 'g'):
97 return 1024**3 * value
101 def kmg_multiply_str(str):
102 m = re.match(r'([0-9a-fA-FxX]+)([KMG]?)', str)
104 return kmg_multiply(int(m.group(1)), m.group(2))
105 raise RuntimeError('kmg_multiply_str can not parse input "' + str + '"')
108 def check_input_listed(name, optional=False):
109 set = inputs['files_opt']
110 if optional is False:
111 set = inputs['files']
113 if cpuvendor == 'GenuineIntel':
114 set = set.union(inputs['files_intel'])
117 if fnmatch.fnmatch(name, file):
119 raise RuntimeError('"' + name + '" is not a listed input file')
122 def input_open(name, mode='r', optional=False):
123 check_input_listed(name, optional)
125 f = open(options.root + name, mode)
126 except Exception as e:
128 return open("/dev/null", mode)
133 def input_readline(name, optional=False):
134 f = input_open(name, optional=optional)
140 def input_listdir(dir, wildcards):
142 check_input_listed(os.path.join(dir, w))
143 dirs = os.listdir(options.root + dir)
149 def __init__(self, id, start, len, flags, content, msix_address):
154 self.content = content
155 self.msix_address = msix_address
158 def __eq__(self, other):
159 return self.id == other.id and self.start == other.start and \
160 self.len == other.len and self.flags == other.flags
163 RW = 'JAILHOUSE_PCICAPS_WRITE'
166 def parse_pcicaps(dir):
168 f = input_open(os.path.join(dir, 'config'), 'rb')
170 (status,) = struct.unpack('<H', f.read(2))
171 # capability list supported?
172 if (status & (1 << 4)) == 0:
175 # walk capability list
177 (next,) = struct.unpack('B', f.read(1))
182 (id, next) = struct.unpack('<BB', f.read(2))
183 if id == 0x01: # Power Management
184 # this cap can be handed out completely
186 flags = PCICapability.RW
187 elif id == 0x05: # MSI
188 # access will be moderated by hypervisor
190 (msgctl,) = struct.unpack('<H', f.read(2))
191 if (msgctl & (1 << 7)) != 0: # 64-bit support
193 if (msgctl & (1 << 8)) != 0: # per-vector masking support
195 flags = PCICapability.RW
196 elif id == 0x11: # MSI-X
197 # access will be moderated by hypervisor
199 (table,) = struct.unpack('<xxI', f.read(6))
200 f.seek(0x10 + (table & 7) * 4)
201 (bar,) = struct.unpack('<I', f.read(4))
203 raise RuntimeError('Invalid MSI-X BAR found')
205 bar |= struct.unpack('<I', f.read(4))[0] << 32
206 msix_address = (bar & 0xfffffffffffffff0) + table & 0xfffffff8
207 flags = PCICapability.RW
209 # unknown/unhandled cap, mark its existence
211 flags = PCICapability.RD
213 content = f.read(len - 2)
214 caps.append(PCICapability(id, cap, len, flags, content,
220 def __init__(self, type, domain, bus, dev, fn, caps):
229 self.num_caps = len(caps)
230 self.num_msi_vectors = 0
232 self.num_msix_vectors = 0
233 self.msix_region_size = 0
234 self.msix_address = 0
236 if c.id in (0x05, 0x11):
237 msg_ctrl = struct.unpack('<H', c.content[:2])[0]
238 if c.id == 0x05: # MSI
239 self.num_msi_vectors = 1 << ((msg_ctrl >> 1) & 0x7)
240 self.msi_64bits = (msg_ctrl >> 7) & 1
242 vectors = (msg_ctrl & 0x7ff) + 1
243 self.num_msix_vectors = vectors
244 self.msix_region_size = (vectors * 16 + 0xfff) & 0xf000
245 self.msix_address = c.msix_address
248 return 'PCIDevice: %02x:%02x.%x' % (self.bus, self.dev, self.fn)
251 return self.bus << 8 | self.dev << 3 | self.fn
254 def parse_pcidevice_sysfsdir(basedir, dir):
255 dpath = os.path.join(basedir, dir)
256 dclass = input_readline(os.path.join(dpath, 'class'))
257 if re.match(r'0x0604..', dclass):
258 type = 'JAILHOUSE_PCI_TYPE_BRIDGE'
260 type = 'JAILHOUSE_PCI_TYPE_DEVICE'
262 domain = int(a[0], 16)
265 caps = PCICapability.parse_pcicaps(dpath)
266 return PCIDevice(type, domain, bus, int(df[0], 16), int(df[1], 16),
271 def __init__(self, start, stop, typestr, comments=None):
274 self.typestr = typestr
278 self.comments = comments
281 return 'MemRegion: %08x-%08x : %s' % \
282 (self.start, self.stop, self.typestr)
285 # round up to full PAGE_SIZE
286 return int((self.stop - self.start + 0xfff) / 0x1000) * 0x1000
288 def flagstr(self, p=''):
290 self.typestr == 'System RAM' or
291 self.typestr == 'RAM buffer' or
292 self.typestr == 'ACPI DMAR RMRR'
294 s = 'JAILHOUSE_MEM_READ | JAILHOUSE_MEM_WRITE |\n'
295 s += p + '\t\tJAILHOUSE_MEM_EXECUTE | JAILHOUSE_MEM_DMA'
297 return 'JAILHOUSE_MEM_READ | JAILHOUSE_MEM_WRITE'
300 class IOMemRegionTree:
301 def __init__(self, region, level, linenum):
303 self.linenum = linenum
306 self.children = set()
311 s = (' ' * (self.level - 1)) + str(self.region) + ' line %d' \
313 if self.parent and self.parent.region:
314 s += '--> ' + self.parent.region.typestr + ' line %d' \
315 % (self.parent.linenum)
317 for c in self.children:
322 def parse_iomem_line(line):
323 a = line.split(':', 1)
324 level = int(a[0].count(' ') / 2) + 1
325 region = a[0].split('-', 1)
327 return level, MemRegion(int(region[0], 16), int(region[1], 16), a[1])
330 def parse_iomem_file():
331 root = IOMemRegionTree(None, 0, -1)
332 f = input_open('/proc/iomem')
337 (level, r) = IOMemRegionTree.parse_iomem_line(line)
338 t = IOMemRegionTree(r, level, linenum)
339 if (t.level > lastlevel):
341 if (t.level == lastlevel):
342 t.parent = lastnode.parent
343 if (t.level < lastlevel):
345 while(t.level < p.level):
349 t.parent.children.add(t)
357 # recurse down the tree
359 def parse_iomem_tree(tree):
363 for tree in tree.children:
367 # System RAM on first level will be added without digging deeper
368 if (tree.level == 1 and s == 'System RAM'):
370 linenumbers.append(tree.linenum)
373 # blacklisted on all levels
375 (s.find('PCI MMCONFIG') >= 0) or
376 (s.find('APIC') >= 0) or # covers both APIC and IOAPIC
377 (s.find('dmar') >= 0)
381 # generally blacklisted, unless we find an HPET right behind it
383 if (s == 'reserved'):
384 for subtree in tree.children:
386 if (r2.typestr.find('HPET') >= 0):
388 linenumbers.append(subtree.linenum)
391 # if the tree continues recurse further down ...
392 if (len(tree.children) > 0):
393 ln2, r2 = IOMemRegionTree.parse_iomem_tree(tree)
394 linenumbers.extend(ln2)
398 # add all remaining leaves
400 linenumbers.append(tree.linenum)
402 return linenumbers, regions
405 def parse_iomem(pcidevices):
406 (maxsz, tree) = IOMemRegionTree.parse_iomem_file()
408 # create a spare array so we can easiely keep the order from the file
409 regions = [None for x in range(maxsz)]
411 lines, regs = IOMemRegionTree.parse_iomem_tree(tree)
417 # now prepare a non-sparse array for a return value,
418 # also filtering out MSI-X pages
423 if d.msix_address >= r.start and d.msix_address <= r.stop:
424 if d.msix_address > r.start:
425 head_r = MemRegion(r.start, d.msix_address - 1,
426 r.typestr, r.comments)
428 if d.msix_address + d.msix_region_size < r.stop:
429 tail_r = MemRegion(d.msix_address + d.msix_region_size,
430 r.stop, r.typestr, r.comments)
437 # newer Linux kernels will report the first page as reserved
438 # it is needed for CPU init so include it anyways
439 if (ret[0].typestr == 'System RAM' and ret[0].start == 0x1000):
445 def parse_pcidevices():
448 basedir = '/sys/bus/pci/devices'
449 list = input_listdir(basedir, ['*/class', '*/config'])
451 d = PCIDevice.parse_pcidevice_sysfsdir(basedir, dir)
455 # look for duplicate capability patterns
457 if d2.caps == d.caps:
458 # reused existing capability list, but record all users
459 d2.caps[0].comments.append(str(d))
460 d.caps_start = d2.caps_start
464 d.caps[0].comments.append(str(d))
465 d.caps_start = len(caps)
468 return (devices, caps)
472 line = input_readline('/proc/cmdline')
473 m = re.match(r'.*memmap=([0-9a-fA-FxX]+)([KMG]?)\$'
474 '([0-9a-fA-FxX]+)([KMG]?).*',
477 size = kmg_multiply(int(m.group(1), 0), m.group(2))
478 start = kmg_multiply(int(m.group(3), 0), m.group(4))
483 def alloc_mem(regions, size):
484 mem = [0x3b000000, size]
487 r.typestr == 'System RAM' and
488 r.start <= mem[0] and
489 r.stop + 1 >= mem[0] + mem[1]
492 head_r = MemRegion(r.start, mem[0] - 1, r.typestr, r.comments)
493 regions.insert(regions.index(r), head_r)
494 if r.stop + 1 > mem[0] + mem[1]:
495 tail_r = MemRegion(mem[0] + mem[1], r.stop, r.typestr,
497 regions.insert(regions.index(r), tail_r)
500 for r in reversed(regions):
501 if (r.typestr == 'System RAM' and r.size() >= mem[1]):
505 raise RuntimeError('failed to allocate memory')
509 list = input_listdir('/sys/devices/system/cpu', ['cpu*/uevent'])
512 if re.match(r'cpu[0-9]+', f):
517 def parse_dmar_devscope(f):
518 (scope_type, scope_len, bus, dev, fn) = \
519 struct.unpack('<BBxxxBBB', f.read(8))
521 raise RuntimeError('Unsupported DMAR Device Scope Structure')
522 return (scope_type, scope_len, bus, dev, fn)
525 # parsing of DMAR ACPI Table
526 # see Intel VT-d Spec chapter 8
527 def parse_dmar(pcidevices):
528 f = input_open('/sys/firmware/acpi/tables/DMAR', 'rb')
529 signature = f.read(4)
530 if signature != b'DMAR':
531 raise RuntimeError('DMAR: incorrect input file format %s' % signature)
532 (length,) = struct.unpack('<I', f.read(4))
541 (struct_type, struct_len) = struct.unpack('<HH', f.read(4))
545 # DMA Remapping Hardware Unit Definition
547 (flags, segment, base) = struct.unpack('<BxHQ', f.read(12))
549 raise RuntimeError('We do not support multiple PCI segments')
551 raise RuntimeError('Too many DMAR units. '
552 'Raise JAILHOUSE_MAX_DMAR_UNITS.')
557 d.iommu = len(units) - 1
558 offset += 16 - offset
559 while offset < struct_len:
560 (scope_type, scope_len, bus, dev, fn) =\
561 parse_dmar_devscope(f)
564 if d.bus == bus and d.dev == dev and d.fn == fn:
565 d.iommu = len(units) - 1
566 elif scope_type == 2:
567 raise RuntimeError('Unsupported DMAR Device Scope type')
568 elif scope_type == 3:
570 raise RuntimeError('We do not support more '
572 # encode the DMAR unit number into the device ID
573 ioapic_id = ((len(units) - 1) << 16) | \
574 (bus << 8) | (dev << 3) | fn
577 # Reserved Memory Region Reporting Structure
579 f.seek(8 - offset, os.SEEK_CUR)
581 (base, limit) = struct.unpack('<QQ', f.read(16))
585 while offset < struct_len:
586 (scope_type, scope_len, bus, dev, fn) =\
587 parse_dmar_devscope(f)
589 comments.append('PCI device: %02x:%02x.%x' %
592 comments.append('DMAR parser could not decode device path')
595 reg = MemRegion(base, limit, 'ACPI DMAR RMRR', comments)
598 f.seek(struct_len - offset, os.SEEK_CUR)
600 return units, ioapic_id, regions
605 f = input_open('/proc/ioports')
607 if line.endswith('ACPI PM_TMR\n'):
608 pm_timer_base = int(line.split('-')[0], 16)
615 def __init__(self, base, end_bus):
617 self.end_bus = end_bus
621 f = input_open('/sys/firmware/acpi/tables/MCFG', 'rb')
622 signature = f.read(4)
623 if signature != b'MCFG':
624 raise RuntimeError('MCFG: incorrect input file format %s' %
626 (length,) = struct.unpack('<I', f.read(4))
628 raise RuntimeError('Multiple MMCONFIG regions found! '
629 'This is not supported')
631 (base, segment, start_bus, end_bus) = \
632 struct.unpack('<QHBB', f.read(12))
633 if segment != 0 or start_bus != 0:
634 raise RuntimeError('Invalid MCFG structure found')
635 return MMConfig(base, end_bus)
638 def get_cpu_vendor():
640 if cpuvendor is not None:
642 with input_open('/proc/cpuinfo', 'r') as f:
646 key, value = line.split(':')
647 if key.strip() == 'vendor_id':
648 cpuvendor = value.strip()
652 if options.generate_collector:
653 f = open(options.file, 'w')
654 filelist = ' '.join(inputs['files'])
655 filelist_opt = ' '.join(inputs['files_opt'])
656 filelist_intel = ' '.join(inputs['files_intel'])
658 tmpl = Template(filename=os.path.join(options.template_dir,
659 'jailhouse-config-collect.tmpl'))
660 f.write(tmpl.render(filelist=filelist, filelist_opt=filelist_opt,
661 filelist_intel=filelist_intel))
665 if ((options.root is '/') and (os.geteuid() is not 0)):
666 print('ERROR: You have to be root to work on "/"!', file=sys.stderr)
669 jh_enabled = input_readline('/sys/devices/jailhouse/enabled', True).rstrip()
670 if jh_enabled == '1':
671 print('ERROR: Jailhouse was enabled when collecting input files! '
672 'Disable jailhouse and try again.',
676 (pcidevices, pcicaps) = parse_pcidevices()
678 product = [input_readline('/sys/class/dmi/id/sys_vendor',
680 input_readline('/sys/class/dmi/id/product_name',
684 inmatemem = kmg_multiply_str(options.mem_inmates)
685 hvmem = [0, kmg_multiply_str(options.mem_hv)]
687 regions = parse_iomem(pcidevices)
688 ourmem = parse_cmdline()
689 total = hvmem[1] + inmatemem
691 mmconfig = MMConfig.parse()
693 if get_cpu_vendor() == 'GenuineIntel':
694 (dmar_units, ioapic_id, rmrr_regs) = parse_dmar(pcidevices)
696 (dmar_units, ioapic_id, rmrr_regs) = [], 0, []
700 if get_cpu_vendor() == 'AuthenticAMD':
701 d.iommu = 0 # temporary workaround
703 raise RuntimeError('PCI device %02x:%02x.%x outside the scope of an '
704 'IOMMU' % (d.bus, d.dev, d.fn))
706 # kernel does not have memmap region, pick one
708 ourmem = alloc_mem(regions, total)
709 elif (total > ourmem[1]):
710 raise RuntimeError('Your memmap reservation is too small you need >="' +
715 inmatereg = MemRegion(ourmem[0] + hvmem[1],
716 ourmem[0] + hvmem[1] + inmatemem - 1,
717 'JAILHOUSE Inmate Memory')
718 regions.append(inmatereg)
720 cpucount = count_cpus()
722 pm_timer_base = parse_ioports()
725 f = open(options.file, 'w')
726 tmpl = Template(filename=os.path.join(options.template_dir,
727 'root-cell-config.c.tmpl'))
728 f.write(tmpl.render(regions=regions,
730 argstr=' '.join(sys.argv),
733 pcidevices=pcidevices,
737 pm_timer_base=pm_timer_base,
739 dmar_units=dmar_units))