source: mainline/tools/ew.py@ 8b22d44

ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 8b22d44 was 917324b, checked in by Jakub Jermář <jakub@…>, 3 years ago

tools/ew.py: Fix running sun4u in console
  • Property mode set to 100755
File size: 15.1 KB
RevLine 
[edb57bc6]1#!/usr/bin/env python3
[df64dbc]2#
[3f4c537a]3# Copyright (c) 2013 Jakub Jermar
[df64dbc]4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions
8# are met:
9#
10# - Redistributions of source code must retain the above copyright
11# notice, this list of conditions and the following disclaimer.
12# - Redistributions in binary form must reproduce the above copyright
13# notice, this list of conditions and the following disclaimer in the
14# documentation and/or other materials provided with the distribution.
15# - The name of the author may not be used to endorse or promote products
16# derived from this software without specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28#
29
30
31"""
32Emulator wrapper for running HelenOS
33"""
34
[4b65f9a]35import inspect
[1c24c7c]36import os
[8a26f82]37import platform
[1783f75]38import re
39import subprocess
40import sys
[663f445f]41import _thread
[df425da]42import time
[df64dbc]43
[f5ceb18]44overrides = {}
45
[1783f75]46CONFIG = 'Makefile.config'
47
[4b65f9a]48TOOLS_DIR = os.path.dirname(inspect.getabsfile(inspect.currentframe()))
49
[1783f75]50def read_config():
51 "Read HelenOS build configuration"
52
53 inf = open(CONFIG, 'r')
54 config = {}
55
56 for line in inf:
57 res = re.match(r'^(?:#!# )?([^#]\w*)\s*=\s*(.*?)\s*$', line)
58 if (res):
59 config[res.group(1)] = res.group(2)
60
61 inf.close()
62 return config
63
[f5ceb18]64def is_override(str):
65 if str in overrides.keys():
66 return overrides[str]
67 return False
68
[df425da]69def cfg_get(platform, machine, processor):
[663f445f]70 if machine == "" or "run" in emulators[platform]:
[f5ceb18]71 return emulators[platform]
[663f445f]72 elif processor == "" or "run" in emulators[platform][machine]:
[f5ceb18]73 return emulators[platform][machine]
[df425da]74 else:
75 return emulators[platform][machine][processor]
[f5ceb18]76
[e4c8e3cf]77def termemu_detect():
[ac49d23c]78 emus = ['gnome-terminal', 'xfce4-terminal', 'xterm']
79 for termemu in emus:
[e4c8e3cf]80 try:
81 subprocess.check_output('which ' + termemu, shell = True)
82 return termemu
83 except:
84 pass
85
[ac49d23c]86 print('Could not find any of the terminal emulators %s.'%(emus))
87 sys.exit(1)
88
[df64dbc]89def run_in_console(cmd, title):
[ac49d23c]90 temu = termemu_detect()
91 if temu == 'gnome-terminal':
[ecf0a04b]92 cmdline = temu + ' -- ' + cmd
[ac49d23c]93 else:
[ecf0a04b]94 ecmd = cmd.replace('"', '\\"')
[ac49d23c]95 cmdline = temu + ' -T ' + '"' + title + '"' + ' -e "' + ecmd + '"'
96
[e4a1497]97 print(cmdline)
[f5ceb18]98 if not is_override('dryrun'):
[e4c8e3cf]99 subprocess.call(cmdline, shell = True)
[df64dbc]100
[8a26f82]101def get_host_native_width():
102 return int(platform.architecture()[0].strip('bit'))
103
104def pc_options(guest_width):
105 opts = ''
[a35b458]106
[8a26f82]107 # Do not enable KVM if running 64 bits HelenOS
108 # on 32 bits host
109 host_width = get_host_native_width()
[f5ceb18]110 if guest_width <= host_width and not is_override('nokvm'):
[8a26f82]111 opts = opts + ' -enable-kvm'
[a35b458]112
[8a26f82]113 # Remove the leading space
114 return opts[1:]
[df64dbc]115
116def malta_options():
[dabaa83]117 return '-cpu 4Kc -append "console=devices/\\hw\\pci0\\00:0a.0\\com1\\a"'
[df64dbc]118
[739bc43]119def find_firmware(name, environ_var, default_paths, extra_info=None):
120 """Find firmware image(s)."""
121
122 if environ_var in os.environ:
123 return os.environ[environ_var]
124
125 for path in default_paths:
126 if os.path.exists(path):
127 return path
128
129 sys.stderr.write("Cannot find %s binary image(s)!\n" % name)
130 sys.stderr.write(
131 "Either set %s environment variable accordingly or place the image(s) in one of the default locations: %s.\n" %
132 (environ_var, ", ".join(default_paths)))
133 if extra_info is not None:
134 sys.stderr.write(extra_info)
135 return None
136
[9185e42]137def platform_to_qemu_options(platform, machine, processor):
[df64dbc]138 if platform == 'amd64':
[8a26f82]139 return 'system-x86_64', pc_options(64)
[df64dbc]140 elif platform == 'arm32':
[e9f7778]141 if machine == 'integratorcp':
142 return 'system-arm', '-M integratorcp'
143 elif machine == 'raspberrypi':
144 return 'system-arm', '-M raspi1ap'
[84176f3]145 elif platform == 'arm64':
[06f10ac]146 if machine == 'virt':
147 # Search for the EDK2 firmware image
148 default_paths = (
149 '/usr/local/qemu-efi-aarch64/QEMU_EFI.fd', # Custom
150 '/usr/share/edk2/aarch64/QEMU_EFI.fd', # Fedora
151 '/usr/share/qemu-efi-aarch64/QEMU_EFI.fd', # Ubuntu
152 )
153 extra_info = ("Pre-compiled binary can be obtained from "
154 "http://snapshots.linaro.org/components/kernel/leg-virt-tianocore-edk2-upstream/latest/QEMU-AARCH64/RELEASE_GCC5/QEMU_EFI.fd.\n")
155 efi_path = find_firmware(
156 "EDK2", 'EW_QEMU_EFI_AARCH64', default_paths, extra_info)
157 if efi_path is None:
158 raise Exception
159
160 return 'system-aarch64', \
161 '-M virt -cpu cortex-a57 -m 1024 -bios %s' % efi_path
[df64dbc]162 elif platform == 'ia32':
[8a26f82]163 return 'system-i386', pc_options(32)
[df64dbc]164 elif platform == 'mips32':
165 if machine == 'lmalta':
166 return 'system-mipsel', malta_options()
167 elif machine == 'bmalta':
168 return 'system-mips', malta_options()
169 elif platform == 'ppc32':
[644352c]170 return 'system-ppc', '-m 256'
[df64dbc]171 elif platform == 'sparc64':
[9185e42]172 if machine != 'generic':
173 raise Exception
174 if processor == 'us':
[0436aec]175 cmdline = '-M sun4u'
176 if is_override('nographic'):
177 cmdline += ' --prom-env boot-args="console=devices/\\hw\\pci0\\01:01.0\\com1\\a"'
178 return 'system-sparc64', cmdline
[739bc43]179
180 # processor = 'sun4v'
181 opensparc_bins = find_firmware(
182 "OpenSPARC", 'OPENSPARC_BINARIES',
183 ('/usr/local/opensparc/image/', ))
184 if opensparc_bins is None:
[9185e42]185 raise Exception
186
187 return 'system-sparc64', '-M niagara -m 256 -L %s' % (opensparc_bins)
188
[df64dbc]189
[129b92c6]190def hdisk_mk():
[df64dbc]191 if not os.path.exists('hdisk.img'):
[4b65f9a]192 subprocess.call(TOOLS_DIR + '/mkfat.py 1048576 dist/data hdisk.img', shell = True)
[f5ceb18]193
[129b92c6]194def qemu_bd_options():
195 if is_override('nohdd'):
196 return ''
[a35b458]197
[129b92c6]198 hdisk_mk()
[a35b458]199
[13eecc4]200 hdd_options = ''
201 if 'hdd' in overrides.keys():
202 if 'ata' in overrides['hdd'].keys():
203 hdd_options += ''
204 elif 'virtio-blk' in overrides['hdd'].keys():
205 hdd_options += ',if=virtio'
206
207 return ' -drive file=hdisk.img,index=0,media=disk,format=raw' + hdd_options
[df64dbc]208
209def qemu_nic_ne2k_options():
[d4b7b29]210 return ' -device ne2k_isa,irq=5,netdev=n1'
[df64dbc]211
212def qemu_nic_e1k_options():
[d4b7b29]213 return ' -device e1000,netdev=n1'
[df64dbc]214
215def qemu_nic_rtl8139_options():
[d4b7b29]216 return ' -device rtl8139,netdev=n1'
[df64dbc]217
[7bf16b7e]218def qemu_nic_virtio_options():
[d4b7b29]219 return ' -device virtio-net,netdev=n1'
[7bf16b7e]220
[df64dbc]221def qemu_net_options():
[f5ceb18]222 if is_override('nonet'):
223 return ''
224
225 nic_options = ''
226 if 'net' in overrides.keys():
227 if 'e1k' in overrides['net'].keys():
228 nic_options += qemu_nic_e1k_options()
229 if 'rtl8139' in overrides['net'].keys():
230 nic_options += qemu_nic_rtl8139_options()
231 if 'ne2k' in overrides['net'].keys():
232 nic_options += qemu_nic_ne2k_options()
[7bf16b7e]233 if 'virtio-net' in overrides['net'].keys():
234 nic_options += qemu_nic_virtio_options()
[f5ceb18]235 else:
236 # Use the default NIC
237 nic_options += qemu_nic_e1k_options()
238
[d4b7b29]239 return nic_options + ' -netdev user,id=n1,hostfwd=udp::8080-:8080,hostfwd=udp::8081-:8081,hostfwd=tcp::8080-:8080,hostfwd=tcp::8081-:8081,hostfwd=tcp::2223-:2223'
[df64dbc]240
241def qemu_usb_options():
[f5ceb18]242 if is_override('nousb'):
243 return ''
244 return ' -usb'
[df64dbc]245
[5119d34]246def qemu_xhci_options():
247 if is_override('noxhci'):
248 return ''
249 return ' -device nec-usb-xhci,id=xhci'
250
[27de618]251def qemu_tablet_options():
252 if is_override('notablet') or (is_override('nousb') and is_override('noxhci')):
253 return ''
254 return ' -device usb-tablet'
255
[f5ceb18]256def qemu_audio_options():
257 if is_override('nosnd'):
258 return ''
[089901e]259 return ' -device intel-hda -device hda-duplex'
[f5ceb18]260
[df425da]261def qemu_run(platform, machine, processor):
262 cfg = cfg_get(platform, machine, processor)
[9185e42]263 suffix, options = platform_to_qemu_options(platform, machine, processor)
[df64dbc]264 cmd = 'qemu-' + suffix
265
266 cmdline = cmd
[3692678]267 if 'qemu_path' in overrides.keys():
268 cmdline = overrides['qemu_path'] + cmd
269
[df64dbc]270 if options != '':
271 cmdline += ' ' + options
272
[84176f3]273 if (not 'hdd' in cfg.keys() or cfg['hdd']):
274 cmdline += qemu_bd_options()
[f5ceb18]275 if (not 'net' in cfg.keys()) or cfg['net']:
[df64dbc]276 cmdline += qemu_net_options()
[f5ceb18]277 if (not 'usb' in cfg.keys()) or cfg['usb']:
[df64dbc]278 cmdline += qemu_usb_options()
[5119d34]279 if (not 'xhci' in cfg.keys()) or cfg['xhci']:
280 cmdline += qemu_xhci_options()
[27de618]281 if (not 'tablet' in cfg.keys()) or cfg['tablet']:
282 cmdline += qemu_tablet_options()
[f5ceb18]283 if (not 'audio' in cfg.keys()) or cfg['audio']:
284 cmdline += qemu_audio_options()
[a35b458]285
[868d75c]286 console = ('console' in cfg.keys() and cfg['console'])
287
[0ceeac3]288 if (is_override('nographic')):
289 cmdline += ' -nographic'
[917324b]290 console = True
[0ceeac3]291
[868d75c]292 if (not console and (not is_override('nographic')) and not is_override('noserial')):
[01552e3]293 cmdline += ' -serial stdio'
[2fc9bfd]294
[abf8bd8]295 if (is_override('bigmem')):
296 cmdline += ' -m 4G'
297
[f5ceb18]298 if cfg['image'] == 'image.iso':
[4b65f9a]299 cmdline += ' -boot d -cdrom image.iso'
[84176f3]300 elif cfg['image'] == 'image.iso@arm64':
301 # Define image.iso cdrom backend.
[4b65f9a]302 cmdline += ' -drive if=none,file=image.iso,id=cdrom,media=cdrom'
[84176f3]303 # Define scsi bus.
304 cmdline += ' -device virtio-scsi-device'
305 # Define cdrom frontend connected to this scsi bus.
306 cmdline += ' -device scsi-cd,drive=cdrom'
[f5ceb18]307 elif cfg['image'] == 'image.boot':
[4b65f9a]308 cmdline += ' -kernel image.boot'
[e9f7778]309 elif cfg['image'] == 'kernel.img@rpi':
310 cmdline += ' -bios boot/image.boot.bin'
[9185e42]311 else:
312 cmdline += ' ' + cfg['image']
[df64dbc]313
[868d75c]314 if console:
[df64dbc]315 cmdline += ' -nographic'
316
317 title = 'HelenOS/' + platform
318 if machine != '':
319 title += ' on ' + machine
[9185e42]320 if 'expect' in cfg.keys():
321 cmdline = 'expect -c \'spawn %s; expect "%s" { send "%s" } timeout exp_continue; interact\'' % (cmdline, cfg['expect']['src'], cfg['expect']['dst'])
[df64dbc]322 run_in_console(cmdline, title)
323 else:
[e4a1497]324 print(cmdline)
[f5ceb18]325 if not is_override('dryrun'):
326 subprocess.call(cmdline, shell = True)
[3f4c537a]327
[df425da]328def ski_run(platform, machine, processor):
[4b65f9a]329 run_in_console('ski -i ' + TOOLS_DIR + '/conf/ski.conf', 'HelenOS/ia64 on ski')
[df64dbc]330
[df425da]331def msim_run(platform, machine, processor):
[129b92c6]332 hdisk_mk()
[4b65f9a]333 run_in_console('msim -c ' + TOOLS_DIR + '/conf/msim.conf', 'HelenOS/mips32 on msim')
[df64dbc]334
[3f4c537a]335def spike_run(platform, machine, processor):
[4b65f9a]336 run_in_console('spike -m1073741824:1073741824 image.boot', 'HelenOS/risvc64 on Spike')
[3f4c537a]337
[f5ceb18]338emulators = {
339 'amd64' : {
340 'run' : qemu_run,
341 'image' : 'image.iso'
342 },
343 'arm32' : {
344 'integratorcp' : {
345 'run' : qemu_run,
346 'image' : 'image.boot',
347 'net' : False,
[a1a81f69]348 'audio' : False,
349 'xhci' : False,
350 'tablet' : False
[e9f7778]351 },
352 'raspberrypi' : {
353 'run' : qemu_run,
354 'image' : 'kernel.img@rpi',
355 'audio' : False,
356 'console' : True,
357 'hdd' : False,
358 'net' : False,
359 'tablet' : False,
360 'usb' : False,
361 'xhci' : False
362 },
[f5ceb18]363 },
[84176f3]364 'arm64' : {
365 'virt' : {
366 'run' : qemu_run,
367 'image' : 'image.iso@arm64',
368 'audio' : False,
[01552e3]369 'console' : True,
[84176f3]370 'hdd' : False,
371 'net' : False,
372 'tablet' : False,
373 'usb' : False,
374 'xhci' : False
375 }
376 },
[f5ceb18]377 'ia32' : {
378 'run' : qemu_run,
379 'image' : 'image.iso'
380 },
381 'ia64' : {
382 'ski' : {
383 'run' : ski_run
384 }
385 },
386 'mips32' : {
387 'msim' : {
388 'run' : msim_run
389 },
390 'lmalta' : {
391 'run' : qemu_run,
392 'image' : 'image.boot',
[868d75c]393 'console' : True
[f5ceb18]394 },
395 'bmalta' : {
396 'run' : qemu_run,
397 'image' : 'image.boot',
[868d75c]398 'console' : True
[f5ceb18]399 },
400 },
401 'ppc32' : {
402 'run' : qemu_run,
403 'image' : 'image.iso',
404 'audio' : False
405 },
[3f4c537a]406 'riscv64' : {
407 'run' : spike_run,
408 'image' : 'image.boot'
409 },
[f5ceb18]410 'sparc64' : {
411 'generic' : {
[df425da]412 'us' : {
413 'run' : qemu_run,
414 'image' : 'image.iso',
[0195374]415 'audio' : False,
[917324b]416 'console' : False,
[fd57cf17]417 'net' : False,
418 'usb' : False,
419 'xhci' : False,
420 'tablet' : False
[df425da]421 },
422 'sun4v' : {
[9185e42]423 'run' : qemu_run,
[4b65f9a]424 'image' : '-drive if=pflash,readonly=on,file=image.iso',
[9185e42]425 'audio' : False,
[868d75c]426 'console' : True,
[9185e42]427 'net' : False,
428 'usb' : False,
[fd57cf17]429 'xhci' : False,
430 'tablet' : False,
[9185e42]431 'expect' : {
432 'src' : 'ok ',
433 'dst' : 'boot\n'
434 },
[df425da]435 }
[f5ceb18]436 }
437 },
438}
439
440def usage():
441 print("%s - emulator wrapper for running HelenOS\n" % os.path.basename(sys.argv[0]))
[13eecc4]442 print("%s [-d] [-h] [-net e1k|rtl8139|ne2k|virtio-net] [-hdd ata|virtio-blk] [-nohdd] [-nokvm] [-nonet] [-nosnd] [-nousb] [-noxhci] [-notablet]\n" %
[f5ceb18]443 os.path.basename(sys.argv[0]))
444 print("-d\tDry run: do not run the emulation, just print the command line.")
445 print("-h\tPrint the usage information and exit.")
446 print("-nohdd\tDisable hard disk, if applicable.")
447 print("-nokvm\tDisable KVM, if applicable.")
448 print("-nonet\tDisable networking support, if applicable.")
449 print("-nosnd\tDisable sound, if applicable.")
450 print("-nousb\tDisable USB support, if applicable.")
[5119d34]451 print("-noxhci\tDisable XHCI support, if applicable.")
[27de618]452 print("-notablet\tDisable USB tablet (use only relative-position PS/2 mouse instead), if applicable.")
[abf8bd8]453 print("-nographic\tDisable graphical output. Serial port output must be enabled for this to be useful.")
[2fc9bfd]454 print("-noserial\tDisable serial port output in the terminal.")
[abf8bd8]455 print("-bigmem\tSets maximum RAM size to 4GB.")
[df64dbc]456
[df425da]457def fail(platform, machine):
458 print("Cannot start emulation for the chosen configuration. (%s/%s)" % (platform, machine))
[a35b458]459
[df425da]460
[df64dbc]461def run():
[f5ceb18]462 expect_nic = False
[13eecc4]463 expect_hdd = False
[3692678]464 expect_qemu = False
[f5ceb18]465
466 for i in range(1, len(sys.argv)):
467
468 if expect_nic:
469 expect_nic = False
470 if not 'net' in overrides.keys():
471 overrides['net'] = {}
472 if sys.argv[i] == 'e1k':
473 overrides['net']['e1k'] = True
474 elif sys.argv[i] == 'rtl8139':
475 overrides['net']['rtl8139'] = True
476 elif sys.argv[i] == 'ne2k':
477 overrides['net']['ne2k'] = True
[7bf16b7e]478 elif sys.argv[i] == 'virtio-net':
479 overrides['net']['virtio-net'] = True
[f5ceb18]480 else:
481 usage()
482 exit()
[f134413]483 continue
[f5ceb18]484
[13eecc4]485 if expect_hdd:
486 expect_hdd = False
487 if not 'hdd' in overrides.keys():
488 overrides['hdd'] = {}
489 if sys.argv[i] == 'ata':
490 overrides['hdd']['ata'] = True
491 elif sys.argv[i] == 'virtio-blk':
492 overrides['hdd']['virtio-blk'] = True
493 else:
494 usage()
495 exit()
496 continue
497
[3692678]498 if expect_qemu:
499 expect_qemu = False
500 overrides['qemu_path'] = sys.argv[i]
501
[f5ceb18]502 elif sys.argv[i] == '-h':
503 usage()
504 exit()
505 elif sys.argv[i] == '-d':
506 overrides['dryrun'] = True
507 elif sys.argv[i] == '-net' and i < len(sys.argv) - 1:
508 expect_nic = True
[13eecc4]509 elif sys.argv[i] == '-hdd' and i < len(sys.argv) - 1:
510 expect_hdd = True
[f5ceb18]511 elif sys.argv[i] == '-nohdd':
512 overrides['nohdd'] = True
513 elif sys.argv[i] == '-nokvm':
514 overrides['nokvm'] = True
515 elif sys.argv[i] == '-nonet':
516 overrides['nonet'] = True
517 elif sys.argv[i] == '-nosnd':
518 overrides['nosnd'] = True
519 elif sys.argv[i] == '-nousb':
520 overrides['nousb'] = True
[5119d34]521 elif sys.argv[i] == '-noxhci':
522 overrides['noxhci'] = True
[27de618]523 elif sys.argv[i] == '-notablet':
524 overrides['notablet'] = True
[0ceeac3]525 elif sys.argv[i] == '-nographic':
526 overrides['nographic'] = True
[abf8bd8]527 elif sys.argv[i] == '-bigmem':
528 overrides['bigmem'] = True
[2fc9bfd]529 elif sys.argv[i] == '-noserial':
530 overrides['noserial'] = True
[3692678]531 elif sys.argv[i] == '-qemu_path' and i < len(sys.argv) - 1:
532 expect_qemu = True
[f5ceb18]533 else:
534 usage()
535 exit()
536
[1783f75]537 config = read_config()
[df64dbc]538
[f5ceb18]539 if 'PLATFORM' in config.keys():
[df64dbc]540 platform = config['PLATFORM']
[f5ceb18]541 else:
[df64dbc]542 platform = ''
543
[f5ceb18]544 if 'MACHINE' in config.keys():
[df64dbc]545 mach = config['MACHINE']
[f5ceb18]546 else:
[df64dbc]547 mach = ''
548
[df425da]549 if 'PROCESSOR' in config.keys():
550 processor = config['PROCESSOR']
551 else:
552 processor = ''
553
[df64dbc]554 try:
[df425da]555 emu_run = cfg_get(platform, mach, processor)['run']
556 emu_run(platform, mach, processor)
[df64dbc]557 except:
[df425da]558 fail(platform, mach)
[df64dbc]559 return
560
561run()
Note: See TracBrowser for help on using the repository browser.