tools/ew.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2013 Jakub Jermar
   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 """
  32 Emulator wrapper for running HelenOS
  33 """
  34
  35 import os
  36 import sys
  37 import subprocess
  38 import autotool
  39 import platform
  40 import thread
  41 import time
  42
  43 overrides = {}
  44
  45 def is_override(str):
  46         if str in overrides.keys():
  47                 return overrides[str]
  48         return False
  49
  50 def cfg_get(platform, machine, processor):
  51         if machine == "" or emulators[platform].has_key("run"):
  52                 return emulators[platform]
  53         elif processor == "" or emulators[platform][machine].has_key("run"):
  54                 return emulators[platform][machine]
  55         else:
  56                 return emulators[platform][machine][processor]
  57
  58 def termemu_detect():
  59         for termemu in ['xfce4-terminal', 'xterm']:
  60                 try:
  61                         subprocess.check_output('which ' + termemu, shell = True)
  62                         return termemu
  63                 except:
  64                         pass
  65
  66 def run_in_console(cmd, title):
  67         ecmd = cmd.replace('"', '\\"')
  68         cmdline = termemu_detect() + ' -T ' + '"' + title + '"' + ' -e "' + ecmd + '"'
  69         print(cmdline)
  70         if not is_override('dryrun'):
  71                 subprocess.call(cmdline, shell = True)
  72
  73 def get_host_native_width():
  74         return int(platform.architecture()[0].strip('bit'))
  75
  76 def pc_options(guest_width):
  77         opts = ''
  78
  79         # Do not enable KVM if running 64 bits HelenOS
  80         # on 32 bits host
  81         host_width = get_host_native_width()
  82         if guest_width <= host_width and not is_override('nokvm'):
  83                 opts = opts + ' -enable-kvm'
  84
  85         # Remove the leading space
  86         return opts[1:]
  87
  88 def malta_options():
  89         return '-cpu 4Kc'
  90
  91 def platform_to_qemu_options(platform, machine, processor):
  92         if platform == 'amd64':
  93                 return 'system-x86_64', pc_options(64)
  94         elif platform == 'arm32':
  95                 return 'system-arm', '-M integratorcp'
  96         elif platform == 'ia32':
  97                 return 'system-i386', pc_options(32)
  98         elif platform == 'mips32':
  99                 if machine == 'lmalta':
 100                         return 'system-mipsel', malta_options()
 101                 elif machine == 'bmalta':
 102                         return 'system-mips', malta_options()
 103         elif platform == 'ppc32':
 104                 return 'system-ppc', '-m 256'
 105         elif platform == 'sparc64':
 106                 if machine != 'generic':
 107                         raise Exception
 108                 if processor == 'us':
 109                         return 'system-sparc64', '-M sun4u --prom-env boot-args="console=devices/\\hw\\pci0\\01:01.0\\com1\\a"'
 110                 elif processor == 'sun4v':
 111                         default_path = '/usr/local/opensparc/image/'
 112                 try:
 113                         if os.path.exists(default_path):
 114                                 opensparc_bins = default_path
 115                         elif os.path.exists(os.environ['OPENSPARC_BINARIES']):
 116                                 opensparc_bins = os.environ['OPENSPARC_BINARIES']
 117                         else:
 118                                 raise Exception
 119                 except:
 120                         print("Cannot find OpenSPARC binary images!")
 121                         print("Either set OPENSPARC_BINARIES environment variable accordingly or place the images in %s." % (default_path))
 122                         raise Exception
 123
 124                 return 'system-sparc64', '-M niagara -m 256 -L %s' % (opensparc_bins)
 125
 126
 127 def hdisk_mk():
 128         if not os.path.exists('hdisk.img'):
 129                 subprocess.call('tools/mkfat.py 1048576 uspace/dist/data hdisk.img', shell = True)
 130
 131 def qemu_bd_options():
 132         if is_override('nohdd'):
 133                 return ''
 134
 135         hdisk_mk()
 136
 137         return ' -drive file=hdisk.img,index=0,media=disk,format=raw'
 138
 139 def qemu_nic_ne2k_options():
 140         return ' -device ne2k_isa,irq=5,vlan=0'
 141
 142 def qemu_nic_e1k_options():
 143         return ' -device e1000,vlan=0'
 144
 145 def qemu_nic_rtl8139_options():
 146         return ' -device rtl8139,vlan=0'
 147
 148 def qemu_net_options():
 149         if is_override('nonet'):
 150                 return ''
 151
 152         nic_options = ''
 153         if 'net' in overrides.keys():
 154                 if 'e1k' in overrides['net'].keys():
 155                         nic_options += qemu_nic_e1k_options()
 156                 if 'rtl8139' in overrides['net'].keys():
 157                         nic_options += qemu_nic_rtl8139_options()
 158                 if 'ne2k' in overrides['net'].keys():
 159                         nic_options += qemu_nic_ne2k_options()
 160         else:
 161                 # Use the default NIC
 162                 nic_options += qemu_nic_e1k_options()
 163
 164         return nic_options + ' -net user,hostfwd=udp::8080-:8080,hostfwd=udp::8081-:8081,hostfwd=tcp::8080-:8080,hostfwd=tcp::8081-:8081,hostfwd=tcp::2223-:2223'
 165
 166 def qemu_usb_options():
 167         if is_override('nousb'):
 168                 return ''
 169         return ' -usb'
 170
 171 def qemu_xhci_options():
 172         if is_override('noxhci'):
 173                 return ''
 174         return ' -device nec-usb-xhci,id=xhci'
 175
 176 def qemu_tablet_options():
 177         if is_override('notablet') or (is_override('nousb') and is_override('noxhci')):
 178                 return ''
 179         return ' -device usb-tablet'
 180
 181 def qemu_audio_options():
 182         if is_override('nosnd'):
 183                 return ''
 184         return ' -device intel-hda -device hda-duplex'
 185
 186 def qemu_run(platform, machine, processor):
 187         cfg = cfg_get(platform, machine, processor)
 188         suffix, options = platform_to_qemu_options(platform, machine, processor)
 189         cmd = 'qemu-' + suffix
 190
 191         cmdline = cmd
 192         if 'qemu_path' in overrides.keys():
 193                 cmdline = overrides['qemu_path'] + cmd
 194
 195         if options != '':
 196                 cmdline += ' ' + options
 197
 198         cmdline += qemu_bd_options()
 199
 200         if (not 'net' in cfg.keys()) or cfg['net']:
 201                 cmdline += qemu_net_options()
 202         if (not 'usb' in cfg.keys()) or cfg['usb']:
 203                 cmdline += qemu_usb_options()
 204         if (not 'xhci' in cfg.keys()) or cfg['xhci']:
 205                 cmdline += qemu_xhci_options()
 206         if (not 'tablet' in cfg.keys()) or cfg['tablet']:
 207                 cmdline += qemu_tablet_options()
 208         if (not 'audio' in cfg.keys()) or cfg['audio']:
 209                 cmdline += qemu_audio_options()
 210
 211         if cfg['image'] == 'image.iso':
 212                 cmdline += ' -boot d -cdrom image.iso'
 213         elif cfg['image'] == 'image.boot':
 214                 cmdline += ' -kernel image.boot'
 215         else:
 216                 cmdline += ' ' + cfg['image']
 217
 218         if ('console' in cfg.keys()) and not cfg['console']:
 219                 cmdline += ' -nographic'
 220
 221                 title = 'HelenOS/' + platform
 222                 if machine != '':
 223                         title += ' on ' + machine
 224                 if 'expect' in cfg.keys():
 225                         cmdline = 'expect -c \'spawn %s; expect "%s" { send "%s" } timeout exp_continue; interact\'' % (cmdline, cfg['expect']['src'], cfg['expect']['dst'])
 226                 run_in_console(cmdline, title)
 227         else:
 228                 print(cmdline)
 229                 if not is_override('dryrun'):
 230                         subprocess.call(cmdline, shell = True)
 231
 232 def ski_run(platform, machine, processor):
 233         run_in_console('ski -i contrib/conf/ski.conf', 'HelenOS/ia64 on ski')
 234
 235 def msim_run(platform, machine, processor):
 236         hdisk_mk()
 237         run_in_console('msim -c contrib/conf/msim.conf', 'HelenOS/mips32 on msim')
 238
 239 def spike_run(platform, machine, processor):
 240         run_in_console('spike -m1073741824:1073741824 image.boot', 'HelenOS/risvc64 on Spike')
 241
 242 emulators = {
 243         'amd64' : {
 244                 'run' : qemu_run,
 245                 'image' : 'image.iso'
 246         },
 247         'arm32' : {
 248                 'integratorcp' : {
 249                         'run' : qemu_run,
 250                         'image' : 'image.boot',
 251                         'net' : False,
 252                         'audio' : False,
 253                         'xhci' : False,
 254                         'tablet' : False
 255                 }
 256         },
 257         'ia32' : {
 258                 'run' : qemu_run,
 259                 'image' : 'image.iso'
 260         },
 261         'ia64' : {
 262                 'ski' : {
 263                         'run' : ski_run
 264                 }
 265         },
 266         'mips32' : {
 267                 'msim' : {
 268                         'run' : msim_run
 269                 },
 270                 'lmalta' : {
 271                         'run' : qemu_run,
 272                         'image' : 'image.boot',
 273                         'console' : False
 274                 },
 275                 'bmalta' : {
 276                         'run' : qemu_run,
 277                         'image' : 'image.boot',
 278                         'console' : False
 279                 },
 280         },
 281         'ppc32' : {
 282                 'run' : qemu_run,
 283                 'image' : 'image.iso',
 284                 'audio' : False
 285         },
 286         'riscv64' : {
 287                 'run' : spike_run,
 288                 'image' : 'image.boot'
 289         },
 290         'sparc64' : {
 291                 'generic' : {
 292                         'us' : {
 293                                 'run' : qemu_run,
 294                                 'image' : 'image.iso',
 295                                 'audio' : False,
 296                                 'console' : False,
 297                                 'net' : False,
 298                                 'usb' : False,
 299                                 'xhci' : False,
 300                                 'tablet' : False
 301                         },
 302                         'sun4v' : {
 303                                 'run' : qemu_run,
 304                                 'image' : '-drive if=pflash,readonly=on,file=image.iso',
 305                                 'audio' : False,
 306                                 'console' : False,
 307                                 'net' : False,
 308                                 'usb' : False,
 309                                 'xhci' : False,
 310                                 'tablet' : False,
 311                                 'expect' : {
 312                                         'src' : 'ok ',
 313                                         'dst' : 'boot\n'
 314                                 },
 315                         }
 316                 }
 317         },
 318 }
 319
 320 def usage():
 321         print("%s - emulator wrapper for running HelenOS\n" % os.path.basename(sys.argv[0]))
 322         print("%s [-d] [-h] [-net e1k|rtl8139|ne2k] [-nohdd] [-nokvm] [-nonet] [-nosnd] [-nousb] [-noxhci] [-notablet]\n" %
 323             os.path.basename(sys.argv[0]))
 324         print("-d\tDry run: do not run the emulation, just print the command line.")
 325         print("-h\tPrint the usage information and exit.")
 326         print("-nohdd\tDisable hard disk, if applicable.")
 327         print("-nokvm\tDisable KVM, if applicable.")
 328         print("-nonet\tDisable networking support, if applicable.")
 329         print("-nosnd\tDisable sound, if applicable.")
 330         print("-nousb\tDisable USB support, if applicable.")
 331         print("-noxhci\tDisable XHCI support, if applicable.")
 332         print("-notablet\tDisable USB tablet (use only relative-position PS/2 mouse instead), if applicable.")
 333
 334 def fail(platform, machine):
 335         print("Cannot start emulation for the chosen configuration. (%s/%s)" % (platform, machine))
 336
 337
 338 def run():
 339         expect_nic = False
 340         expect_qemu = False
 341
 342         for i in range(1, len(sys.argv)):
 343
 344                 if expect_nic:
 345                         expect_nic = False
 346                         if not 'net' in overrides.keys():
 347                                 overrides['net'] = {}
 348                         if sys.argv[i] == 'e1k':
 349                                 overrides['net']['e1k'] = True
 350                         elif sys.argv[i] == 'rtl8139':
 351                                 overrides['net']['rtl8139'] = True
 352                         elif sys.argv[i] == 'ne2k':
 353                                 overrides['net']['ne2k'] = True
 354                         else:
 355                                 usage()
 356                                 exit()
 357
 358                 if expect_qemu:
 359                         expect_qemu = False
 360                         overrides['qemu_path'] = sys.argv[i]
 361
 362                 elif sys.argv[i] == '-h':
 363                         usage()
 364                         exit()
 365                 elif sys.argv[i] == '-d':
 366                         overrides['dryrun'] = True
 367                 elif sys.argv[i] == '-net' and i < len(sys.argv) - 1:
 368                         expect_nic = True
 369                 elif sys.argv[i] == '-nohdd':
 370                         overrides['nohdd'] = True
 371                 elif sys.argv[i] == '-nokvm':
 372                         overrides['nokvm'] = True
 373                 elif sys.argv[i] == '-nonet':
 374                         overrides['nonet'] = True
 375                 elif sys.argv[i] == '-nosnd':
 376                         overrides['nosnd'] = True
 377                 elif sys.argv[i] == '-nousb':
 378                         overrides['nousb'] = True
 379                 elif sys.argv[i] == '-noxhci':
 380                         overrides['noxhci'] = True
 381                 elif sys.argv[i] == '-notablet':
 382                         overrides['notablet'] = True
 383                 elif sys.argv[i] == '-qemu_path' and i < len(sys.argv) - 1:
 384                         expect_qemu = True
 385                 else:
 386                         usage()
 387                         exit()
 388
 389         config = {}
 390         autotool.read_config(autotool.CONFIG, config)
 391
 392         if 'PLATFORM' in config.keys():
 393                 platform = config['PLATFORM']
 394         else:
 395                 platform = ''
 396
 397         if 'MACHINE' in config.keys():
 398                 mach = config['MACHINE']
 399         else:
 400                 mach = ''
 401
 402         if 'PROCESSOR' in config.keys():
 403                 processor = config['PROCESSOR']
 404         else:
 405                 processor = ''
 406
 407         try:
 408                 emu_run = cfg_get(platform, mach, processor)['run']
 409                 emu_run(platform, mach, processor)
 410         except:
 411                 fail(platform, mach)
 412                 return
 413
 414 run()