source: mainline/tools/ew.py@ 089901e

#!/usr/bin/env python
#
# Copyright (c) 2013 Jakub Jermar 
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# - Redistributions of source code must retain the above copyright
#   notice, this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright
#   notice, this list of conditions and the following disclaimer in the
#   documentation and/or other materials provided with the distribution.
# - The name of the author may not be used to endorse or promote products
#   derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#


"""
Emulator wrapper for running HelenOS
"""

import os 
import sys
import subprocess 
import autotool
import platform

overrides = {}

def is_override(str):
        if str in overrides.keys():
                return overrides[str]
        return False

def cfg_get(platform, machine):
        if machine == "":
                return emulators[platform]
        else:
                return emulators[platform][machine]

def run_in_console(cmd, title):
        cmdline = 'xterm -T ' + '"' + title + '"' + ' -e ' + cmd
        print(cmdline)
        if not is_override('dryrun'):
                subprocess.call(cmdline, shell = True);

def get_host_native_width():
        return int(platform.architecture()[0].strip('bit'))

def pc_options(guest_width):
        opts = ''
        
        # Do not enable KVM if running 64 bits HelenOS
        # on 32 bits host
        host_width = get_host_native_width()
        if guest_width <= host_width and not is_override('nokvm'):
                opts = opts + ' -enable-kvm'
        
        # Remove the leading space
        return opts[1:]

def malta_options():
        return '-cpu 4Kc'

def platform_to_qemu_options(platform, machine):
        if platform == 'amd64':
                return 'system-x86_64', pc_options(64)
        elif platform == 'arm32':
                return 'system-arm', '-M integratorcp'
        elif platform == 'ia32':
                return 'system-i386', pc_options(32)
        elif platform == 'mips32':
                if machine == 'lmalta':
                        return 'system-mipsel', malta_options()
                elif machine == 'bmalta':
                        return 'system-mips', malta_options()
        elif platform == 'ppc32':
                return 'system-ppc', ''
        elif platform == 'sparc64':
                return 'system-sparc64', ''

def qemu_bd_options():
        if is_override('nohdd'):
                return ''

        if not os.path.exists('hdisk.img'):
                subprocess.call('tools/mkfat.py 1048576 uspace/dist/data hdisk.img', shell = True)

        return ' -hda hdisk.img'

def qemu_nic_ne2k_options():
        return ' -device ne2k_isa,irq=5,vlan=0'

def qemu_nic_e1k_options():
        return ' -device e1000,vlan=0'

def qemu_nic_rtl8139_options():
        return ' -device rtl8139,vlan=0'

def qemu_net_options():
        if is_override('nonet'):
                return ''

        nic_options = ''
        if 'net' in overrides.keys():
                if 'e1k' in overrides['net'].keys():
                        nic_options += qemu_nic_e1k_options()
                if 'rtl8139' in overrides['net'].keys():
                        nic_options += qemu_nic_rtl8139_options()
                if 'ne2k' in overrides['net'].keys():
                        nic_options += qemu_nic_ne2k_options()
        else:
                # Use the default NIC
                nic_options += qemu_nic_e1k_options()

        return nic_options + ' -net user -redir udp:8080::8080 -redir udp:8081::8081 -redir tcp:8080::8080 -redir tcp:8081::8081 -redir tcp:2223::2223'

def qemu_usb_options():
        if is_override('nousb'):
                return ''
        return ' -usb'

def qemu_audio_options():
        if is_override('nosnd'):
                return ''
        return ' -device intel-hda -device hda-duplex'

def qemu_run(platform, machine):
        cfg = cfg_get(platform, machine)
        suffix, options = platform_to_qemu_options(platform, machine)
        cmd = 'qemu-' + suffix

        cmdline = cmd
        if options != '':
                cmdline += ' ' + options

        cmdline += qemu_bd_options()

        if (not 'net' in cfg.keys()) or cfg['net']:
                cmdline += qemu_net_options()
        if (not 'usb' in cfg.keys()) or cfg['usb']:
                cmdline += qemu_usb_options()
        if (not 'audio' in cfg.keys()) or cfg['audio']:
                cmdline += qemu_audio_options()
        
        if cfg['image'] == 'image.iso':
                cmdline += ' -boot d -cdrom image.iso'
        elif cfg['image'] == 'image.boot':
                cmdline += ' -kernel image.boot'

        if ('console' in cfg.keys()) and not cfg['console']:
                cmdline += ' -nographic'

                title = 'HelenOS/' + platform
                if machine != '':
                        title += ' on ' + machine
                run_in_console(cmdline, title)
        else:
                print(cmdline)
                if not is_override('dryrun'):
                        subprocess.call(cmdline, shell = True)
                
def ski_run(platform, machine):
        run_in_console('ski -i contrib/conf/ski.conf', 'HelenOS/ia64 on ski')

def msim_run(platform, machine):
        run_in_console('msim -c contrib/conf/msim.conf', 'HelenOS/mips32 on msim')


emulators = {
        'amd64' : {
                'run' : qemu_run,
                'image' : 'image.iso'
        },
        'arm32' : {
                'integratorcp' : {
                        'run' : qemu_run,
                        'image' : 'image.boot',
                        'net' : False,
                        'audio' : False
                }
        },
        'ia32' : {
                'run' : qemu_run,
                'image' : 'image.iso'
        },
        'ia64' : {
                'ski' : {
                        'run' : ski_run
                }
        },
        'mips32' : {
                'msim' : {
                        'run' : msim_run
                },
                'lmalta' : {
                        'run' : qemu_run,
                        'image' : 'image.boot',
                        'console' : False
                },
                'bmalta' : {
                        'run' : qemu_run,
                        'image' : 'image.boot',
                        'console' : False
                },
        },
        'ppc32' : {
                'run' : qemu_run,
                'image' : 'image.iso',
                'audio' : False
        },
        'sparc64' : {
                'generic' : {
                        'run' : qemu_run,
                        'image' : 'image.iso',
                        'audio' : False
                }
        },
}

def usage():
        print("%s - emulator wrapper for running HelenOS\n" % os.path.basename(sys.argv[0]))
        print("%s [-d] [-h] [-net e1k|rtl8139|ne2k] [-nohdd] [-nokvm] [-nonet] [-nosnd] [-nousb]\n" %
            os.path.basename(sys.argv[0]))
        print("-d\tDry run: do not run the emulation, just print the command line.")
        print("-h\tPrint the usage information and exit.")
        print("-nohdd\tDisable hard disk, if applicable.")
        print("-nokvm\tDisable KVM, if applicable.")
        print("-nonet\tDisable networking support, if applicable.")
        print("-nosnd\tDisable sound, if applicable.")
        print("-nousb\tDisable USB support, if applicable.")

def run():
        expect_nic = False

        for i in range(1, len(sys.argv)):

                if expect_nic:
                        expect_nic = False
                        if not 'net' in overrides.keys():
                                overrides['net'] = {}
                        if sys.argv[i] == 'e1k':
                                overrides['net']['e1k'] = True
                        elif sys.argv[i] == 'rtl8139':
                                overrides['net']['rtl8139'] = True
                        elif sys.argv[i] == 'ne2k':
                                overrides['net']['ne2k'] = True
                        else:
                                usage()
                                exit()

                elif sys.argv[i] == '-h':
                        usage()
                        exit()
                elif sys.argv[i] == '-d':
                        overrides['dryrun'] = True
                elif sys.argv[i] == '-net' and i < len(sys.argv) - 1:
                        expect_nic = True
                elif sys.argv[i] == '-nohdd':
                        overrides['nohdd'] = True
                elif sys.argv[i] == '-nokvm':
                        overrides['nokvm'] = True
                elif sys.argv[i] == '-nonet':
                        overrides['nonet'] = True
                elif sys.argv[i] == '-nosnd':
                        overrides['nosnd'] = True
                elif sys.argv[i] == '-nousb':
                        overrides['nousb'] = True
                else:
                        usage()
                        exit()

        config = {}
        autotool.read_config(autotool.CONFIG, config)

        if 'PLATFORM' in config.keys():
                platform = config['PLATFORM']
        else:
                platform = ''

        if 'MACHINE' in config.keys():
                mach = config['MACHINE']
        else:
                mach = ''

        try:
                emu_run = cfg_get(platform, mach)['run']
        except:
                print("Cannot start emulation for the chosen configuration. (%s/%s)" % (platform, mach))
                return

        emu_run(platform, mach)

run()