Ruby: Add support for functional accesses
[gem5.git] / configs / example / se.py
index c4150eed73077f2ebbe0a44301458d3219e6b645..be7d87bc68d609648c12ef1a330387eae99aad7a 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2006 The Regents of The University of Michigan
+# Copyright (c) 2006-2008 The Regents of The University of Michigan
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 #
 # "m5 test.py"
 
+import os
+import optparse
+import sys
+from os.path import join as joinpath
+
 import m5
+from m5.defines import buildEnv
 from m5.objects import *
-import os, optparse, sys
-m5.AddToPath('../common')
+from m5.util import addToPath, fatal
+
+if buildEnv['FULL_SYSTEM']:
+    fatal("This script requires syscall emulation mode (*_SE).")
+
+addToPath('../common')
+addToPath('../ruby')
+
+import Ruby
+
+import Simulation
+import CacheConfig
+from Caches import *
+from cpu2000 import *
+
+# Get paths we might need.  It's expected this file is in m5/configs/example.
+config_path = os.path.dirname(os.path.abspath(__file__))
+config_root = os.path.dirname(config_path)
+m5_root = os.path.dirname(config_root)
 
 parser = optparse.OptionParser()
 
 # Benchmark options
 parser.add_option("-c", "--cmd",
-                  default="../../tests/test-progs/hello/bin/alpha/linux/hello",
-                  help="The binary to run in syscall emulation mode.")
+    default=joinpath(m5_root, "tests/test-progs/hello/bin/%s/linux/hello" % \
+            buildEnv['TARGET_ISA']),
+    help="The binary to run in syscall emulation mode.")
 parser.add_option("-o", "--options", default="",
-                  help="The options to pass to the binary, use \" \" around the entire\
-                        string.")
-parser.add_option("-i", "--input", default="",
-                  help="A file of input to give to the binary.")
-
-# System options
-parser.add_option("-d", "--detailed", action="store_true")
-parser.add_option("-t", "--timing", action="store_true")
-parser.add_option("--caches", action="store_true")
-
-# Run duration options
-parser.add_option("-m", "--maxtick", type="int")
-parser.add_option("--maxtime", type="float")
-
-#Checkpointing options
-###Note that performing checkpointing via python script files will override
-###checkpoint instructions built into binaries.
-parser.add_option("--take_checkpoints", action="store", type="string",
-                  help="<M,N> will take checkpoint at cycle M and every N cycles \
-                  thereafter")
-parser.add_option("--max_checkpoints", action="store", type="int",
-                  help="the maximum number of checkpoints to drop",
-                  default=5)
-parser.add_option("--checkpoint_dir", action="store", type="string",
-                  help="Place all checkpoints in this absolute directory")
-parser.add_option("-r", "--checkpoint_restore", action="store", type="int",
-                  help="restore from checkpoint <N>")
-
-#CPU Switching - default switch model generally goes from a checkpoint
-#to a timing simple CPU with caches to warm up, then to detailed CPU for
-#data measurement
-parser.add_option("-s", "--standard_switch", action="store_true",
-                  help="switch from one cpu mode to another")
+    help='The options to pass to the binary, use " " around the entire string')
+parser.add_option("-i", "--input", default="", help="Read stdin from a file.")
+parser.add_option("--output", default="", help="Redirect stdout to a file.")
+parser.add_option("--errout", default="", help="Redirect stderr to a file.")
+parser.add_option("--ruby", action="store_true")
+
+execfile(os.path.join(config_root, "common", "Options.py"))
 
 (options, args) = parser.parse_args()
 
+if options.ruby:
+    Ruby.define_options(parser)
+    (options, args) = parser.parse_args()
+
 if args:
     print "Error: script doesn't take any positional arguments"
     sys.exit(1)
 
-class MyCache(BaseCache):
-    assoc = 2
-    block_size = 64
-    latency = 1
-    mshrs = 10
-    tgts_per_mshr = 5
+multiprocesses = []
+apps = []
+
+if options.bench:
+    apps = options.bench.split("-")
+    if len(apps) != options.num_cpus:
+        print "number of benchmarks not equal to set num_cpus!"
+        sys.exit(1)
+
+    for app in apps:
+        try:
+            if buildEnv['TARGET_ISA'] == 'alpha':
+                exec("workload = %s('alpha', 'tru64', 'ref')" % app)
+            else:
+                exec("workload = %s(buildEnv['TARGET_ISA'], 'linux', 'ref')" % app)
+            multiprocesses.append(workload.makeLiveProcess())
+        except:
+            print >>sys.stderr, "Unable to find workload for %s: %s" % (buildEnv['TARGET_ISA'], app)
+            sys.exit(1)
+else:
+    process = LiveProcess()
+    process.executable = options.cmd
+    process.cmd = [options.cmd] + options.options.split()
+    multiprocesses.append(process)
+
 
-process = LiveProcess()
-process.executable = options.cmd
-process.cmd = options.cmd + " " + options.options
 if options.input != "":
     process.input = options.input
+if options.output != "":
+    process.output = options.output
+if options.errout != "":
+    process.errout = options.errout
+
 
-if options.detailed:
+# By default, set workload to path of user-specified binary
+workloads = options.cmd
+numThreads = 1
+
+if options.detailed or options.inorder:
     #check for SMT workload
     workloads = options.cmd.split(';')
     if len(workloads) > 1:
         process = []
         smt_idx = 0
         inputs = []
+        outputs = []
+        errouts = []
 
         if options.input != "":
             inputs = options.input.split(';')
+        if options.output != "":
+            outputs = options.output.split(';')
+        if options.errout != "":
+            errouts = options.errout.split(';')
 
         for wrkld in workloads:
             smt_process = LiveProcess()
@@ -112,165 +145,54 @@ if options.detailed:
             smt_process.cmd = wrkld + " " + options.options
             if inputs and inputs[smt_idx]:
                 smt_process.input = inputs[smt_idx]
+            if outputs and outputs[smt_idx]:
+                smt_process.output = outputs[smt_idx]
+            if errouts and errouts[smt_idx]:
+                smt_process.errout = errouts[smt_idx]
             process += [smt_process, ]
             smt_idx += 1
-
-
-if options.timing:
-    cpu = TimingSimpleCPU()
-elif options.detailed:
-    cpu = DerivO3CPU()
+    numThreads = len(workloads)
+    
+if options.ruby:
+    if options.detailed:
+        print >> sys.stderr, "Ruby only works with TimingSimpleCPU!!"
+        sys.exit(1)
+    elif not options.timing:
+        print >> sys.stderr, "****WARN:  using Timing CPU since it's needed by Ruby"
+
+    class CPUClass(TimingSimpleCPU): pass
+    test_mem_mode = 'timing'
+    FutureClass = None
 else:
-    cpu = AtomicSimpleCPU()
+    (CPUClass, test_mem_mode, FutureClass) = Simulation.setCPUClass(options)
 
-cpu.workload = process
-cpu.cpu_id = 0
+CPUClass.clock = '2GHz'
+CPUClass.numThreads = numThreads;
 
-system = System(cpu = cpu,
+np = options.num_cpus
+
+system = System(cpu = [CPUClass(cpu_id=i) for i in xrange(np)],
                 physmem = PhysicalMemory(range=AddrRange("512MB")),
-                membus = Bus())
+                membus = Bus(), mem_mode = test_mem_mode)
+
+if options.ruby:
+    options.use_map = True
+    Ruby.create_system(options, system)
+    assert(options.num_cpus == len(system.ruby._cpu_ruby_ports))
+else:
+    system.physmem.port = system.membus.port
+    CacheConfig.config_cache(options, system)
 
-if options.caches and not options.standard_switch:
-    system.cpu.addPrivateSplitL1Caches(MyCache(size = '32kB'),
-                                       MyCache(size = '64kB'))
+for i in xrange(np):
+    system.cpu[i].workload = multiprocesses[i]
 
-system.physmem.port = system.membus.port
-system.cpu.connectMemPorts(system.membus)
-system.cpu.mem = system.physmem
-system.cpu.clock = '2GHz'
-root = Root(system = system)
+    if options.ruby:
+        system.cpu[i].icache_port = system.ruby._cpu_ruby_ports[i].port
+        system.cpu[i].dcache_port = system.ruby._cpu_ruby_ports[i].port
 
-if options.timing or options.detailed:
-    root.system.mem_mode = 'timing'
-
-if options.standard_switch:
-    switch_cpu = TimingSimpleCPU(defer_registration=True, cpu_id=1)
-    switch_cpu1 = DerivO3CPU(defer_registration=True, cpu_id=2)
-    switch_cpu.system =  system
-    switch_cpu1.system =  system
-    switch_cpu.clock = cpu.clock
-    switch_cpu1.clock = cpu.clock
-    if options.caches:
-        switch_cpu.addPrivateSplitL1Caches(MyCache(size = '32kB'),
-                                           MyCache(size = '64kB'))
-
-    switch_cpu.workload = process
-    switch_cpu1.workload = process
-    switch_cpu.mem = system.physmem
-    switch_cpu1.mem = system.physmem
-    switch_cpu.connectMemPorts(system.membus)
-    root.switch_cpu = switch_cpu
-    root.switch_cpu1 = switch_cpu1
-    switch_cpu_list = [(system.cpu, switch_cpu)]
-    switch_cpu_list1 = [(switch_cpu, switch_cpu1)]
-
-# instantiate configuration
-m5.instantiate(root)
-
-if options.checkpoint_dir:
-    cptdir = options.checkpoint_dir
-else:
-    cptdir = os.getcwd()
-
-if options.checkpoint_restore:
-    from os.path import isdir
-    from os import listdir, getcwd
-    import re
-
-    if not isdir(cptdir):
-        m5.panic("checkpoint dir %s does not exist!" % cptdir)
-
-    dirs = listdir(cptdir)
-    expr = re.compile('cpt.([0-9]*)')
-    cpts = []
-    for dir in dirs:
-        match = expr.match(dir)
-        if match:
-            cpts.append(match.group(1))
-
-    cpts.sort(lambda a,b: cmp(long(a), long(b)))
-
-    if options.checkpoint_restore > len(cpts):
-        m5.panic('Checkpoint %d not found' % options.checkpoint_restore)
-
-    print "restoring checkpoint from ","/".join([cptdir, "cpt.%s" % cpts[options.checkpoint_restore - 1]])
-    m5.restoreCheckpoint(root, "/".join([cptdir, "cpt.%s" % cpts[options.checkpoint_restore - 1]]))
-
-if options.standard_switch:
-    exit_event = m5.simulate(10000)
-    ## when you change to Timing (or Atomic), you halt the system given
-    ## as argument.  When you are finished with the system changes
-    ## (including switchCpus), you must resume the system manually.
-    ## You DON'T need to resume after just switching CPUs if you haven't
-    ## changed anything on the system level.
-    m5.changeToTiming(system)
-    m5.switchCpus(switch_cpu_list)
-    m5.resume(system)
-
-    exit_event = m5.simulate(500000000000)
-    m5.switchCpus(switch_cpu_list1)
-
-if options.maxtick:
-    maxtick = options.maxtick
-elif options.maxtime:
-    simtime = int(options.maxtime * root.clock.value)
-    print "simulating for: ", simtime
-    maxtick = simtime
-else:
-    maxtick = -1
-
-num_checkpoints = 0
-
-exit_cause = ''
-
-if options.take_checkpoints:
-    [when, period] = options.take_checkpoints.split(",", 1)
-    when = int(when)
-    period = int(period)
-
-    exit_event = m5.simulate(when)
-    while exit_event.getCause() == "checkpoint":
-        exit_event = m5.simulate(when - m5.curTick())
-
-    if exit_event.getCause() == "simulate() limit reached":
-        m5.checkpoint(root, cptdir + "cpt.%d")
-        num_checkpoints += 1
-
-    sim_ticks = when
-    exit_cause = "maximum %d checkpoints dropped" % options.max_checkpoints
-    while num_checkpoints < options.max_checkpoints:
-        if (sim_ticks + period) > maxtick and maxtick != -1:
-            exit_event = m5.simulate(maxtick - sim_ticks)
-            exit_cause = exit_event.getCause()
-            break
-        else:
-            exit_event = m5.simulate(period)
-            sim_ticks += period
-            while exit_event.getCause() == "checkpoint":
-                exit_event = m5.simulate(period - m5.curTick())
-            if exit_event.getCause() == "simulate() limit reached":
-                m5.checkpoint(root, cptdir + "cpt.%d")
-                num_checkpoints += 1
-
-else: #no checkpoints being taken via this script
-    exit_event = m5.simulate(maxtick)
-
-    while exit_event.getCause() == "checkpoint":
-        m5.checkpoint(root, cptdir + "cpt.%d")
-        num_checkpoints += 1
-        if num_checkpoints == options.max_checkpoints:
-            exit_cause =  "maximum %d checkpoints dropped" % options.max_checkpoints
-            break
-
-        if maxtick == -1:
-            exit_event = m5.simulate(maxtick)
-        else:
-            exit_event = m5.simulate(maxtick - m5.curTick())
-
-        exit_cause = exit_event.getCause()
-
-if exit_cause == '':
-    exit_cause = exit_event.getCause()
-print 'Exiting @ cycle', m5.curTick(), 'because ', exit_cause
+    if options.fastmem:
+        system.cpu[0].physmem_port = system.physmem.port
 
+root = Root(system = system)
 
+Simulation.run(options, root, system, FutureClass)