configs/example/fs.py

   1 # Copyright (c) 2010-2013, 2016, 2019 ARM Limited
   2 # All rights reserved.
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Copyright (c) 2012-2014 Mark D. Hill and David A. Wood
  14 # Copyright (c) 2009-2011 Advanced Micro Devices, Inc.
  15 # Copyright (c) 2006-2007 The Regents of The University of Michigan
  16 # All rights reserved.
  17 #
  18 # Redistribution and use in source and binary forms, with or without
  19 # modification, are permitted provided that the following conditions are
  20 # met: redistributions of source code must retain the above copyright
  21 # notice, this list of conditions and the following disclaimer;
  22 # redistributions in binary form must reproduce the above copyright
  23 # notice, this list of conditions and the following disclaimer in the
  24 # documentation and/or other materials provided with the distribution;
  25 # neither the name of the copyright holders nor the names of its
  26 # contributors may be used to endorse or promote products derived from
  27 # this software without specific prior written permission.
  28 #
  29 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  30 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  31 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  32 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  33 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  34 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  36 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  37 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  38 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  39 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40 #
  41 # Authors: Ali Saidi
  42 #          Brad Beckmann
  43
  44 from __future__ import print_function
  45 from __future__ import absolute_import
  46
  47 import optparse
  48 import sys
  49
  50 import m5
  51 from m5.defines import buildEnv
  52 from m5.objects import *
  53 from m5.util import addToPath, fatal, warn
  54 from m5.util.fdthelper import *
  55
  56 addToPath('../')
  57
  58 from ruby import Ruby
  59
  60 from common.FSConfig import *
  61 from common.SysPaths import *
  62 from common.Benchmarks import *
  63 from common import Simulation
  64 from common import CacheConfig
  65 from common import CpuConfig
  66 from common import MemConfig
  67 from common import ObjectList
  68 from common.Caches import *
  69 from common import Options
  70
  71 def cmd_line_template():
  72     if options.command_line and options.command_line_file:
  73         print("Error: --command-line and --command-line-file are "
  74               "mutually exclusive")
  75         sys.exit(1)
  76     if options.command_line:
  77         return options.command_line
  78     if options.command_line_file:
  79         return open(options.command_line_file).read().strip()
  80     return None
  81
  82 def build_test_system(np):
  83     cmdline = cmd_line_template()
  84     if buildEnv['TARGET_ISA'] == "alpha":
  85         test_sys = makeLinuxAlphaSystem(test_mem_mode, bm[0], options.ruby,
  86                                         cmdline=cmdline)
  87     elif buildEnv['TARGET_ISA'] == "mips":
  88         test_sys = makeLinuxMipsSystem(test_mem_mode, bm[0], cmdline=cmdline)
  89     elif buildEnv['TARGET_ISA'] == "sparc":
  90         test_sys = makeSparcSystem(test_mem_mode, bm[0], cmdline=cmdline)
  91     elif buildEnv['TARGET_ISA'] == "x86":
  92         test_sys = makeLinuxX86System(test_mem_mode, np, bm[0], options.ruby,
  93                                       cmdline=cmdline)
  94     elif buildEnv['TARGET_ISA'] == "arm":
  95         test_sys = makeArmSystem(test_mem_mode, options.machine_type, np,
  96                                  bm[0], options.dtb_filename,
  97                                  bare_metal=options.bare_metal,
  98                                  cmdline=cmdline,
  99                                  external_memory=
 100                                    options.external_memory_system,
 101                                  ruby=options.ruby,
 102                                  security=options.enable_security_extensions)
 103         if options.enable_context_switch_stats_dump:
 104             test_sys.enable_context_switch_stats_dump = True
 105     else:
 106         fatal("Incapable of building %s full system!", buildEnv['TARGET_ISA'])
 107
 108     # Set the cache line size for the entire system
 109     test_sys.cache_line_size = options.cacheline_size
 110
 111     # Create a top-level voltage domain
 112     test_sys.voltage_domain = VoltageDomain(voltage = options.sys_voltage)
 113
 114     # Create a source clock for the system and set the clock period
 115     test_sys.clk_domain = SrcClockDomain(clock =  options.sys_clock,
 116             voltage_domain = test_sys.voltage_domain)
 117
 118     # Create a CPU voltage domain
 119     test_sys.cpu_voltage_domain = VoltageDomain()
 120
 121     # Create a source clock for the CPUs and set the clock period
 122     test_sys.cpu_clk_domain = SrcClockDomain(clock = options.cpu_clock,
 123                                              voltage_domain =
 124                                              test_sys.cpu_voltage_domain)
 125
 126     if options.kernel is not None:
 127         test_sys.kernel = binary(options.kernel)
 128     else:
 129         print("Error: a kernel must be provided to run in full system mode")
 130         sys.exit(1)
 131
 132     if options.script is not None:
 133         test_sys.readfile = options.script
 134
 135     if options.lpae:
 136         test_sys.have_lpae = True
 137
 138     if options.virtualisation:
 139         test_sys.have_virtualization = True
 140
 141     test_sys.init_param = options.init_param
 142
 143     # For now, assign all the CPUs to the same clock domain
 144     test_sys.cpu = [TestCPUClass(clk_domain=test_sys.cpu_clk_domain, cpu_id=i)
 145                     for i in range(np)]
 146
 147     if ObjectList.is_kvm_cpu(TestCPUClass) or \
 148         ObjectList.is_kvm_cpu(FutureClass):
 149         test_sys.kvm_vm = KvmVM()
 150
 151     if options.ruby:
 152         bootmem = getattr(test_sys, '_bootmem', None)
 153         Ruby.create_system(options, True, test_sys, test_sys.iobus,
 154                            test_sys._dma_ports, bootmem)
 155
 156         # Create a seperate clock domain for Ruby
 157         test_sys.ruby.clk_domain = SrcClockDomain(clock = options.ruby_clock,
 158                                         voltage_domain = test_sys.voltage_domain)
 159
 160         # Connect the ruby io port to the PIO bus,
 161         # assuming that there is just one such port.
 162         test_sys.iobus.master = test_sys.ruby._io_port.slave
 163
 164         for (i, cpu) in enumerate(test_sys.cpu):
 165             #
 166             # Tie the cpu ports to the correct ruby system ports
 167             #
 168             cpu.clk_domain = test_sys.cpu_clk_domain
 169             cpu.createThreads()
 170             cpu.createInterruptController()
 171
 172             cpu.icache_port = test_sys.ruby._cpu_ports[i].slave
 173             cpu.dcache_port = test_sys.ruby._cpu_ports[i].slave
 174
 175             if buildEnv['TARGET_ISA'] in ("x86", "arm"):
 176                 cpu.itb.walker.port = test_sys.ruby._cpu_ports[i].slave
 177                 cpu.dtb.walker.port = test_sys.ruby._cpu_ports[i].slave
 178
 179             if buildEnv['TARGET_ISA'] in "x86":
 180                 cpu.interrupts[0].pio = test_sys.ruby._cpu_ports[i].master
 181                 cpu.interrupts[0].int_master = test_sys.ruby._cpu_ports[i].slave
 182                 cpu.interrupts[0].int_slave = test_sys.ruby._cpu_ports[i].master
 183
 184     else:
 185         if options.caches or options.l2cache:
 186             # By default the IOCache runs at the system clock
 187             test_sys.iocache = IOCache(addr_ranges = test_sys.mem_ranges)
 188             test_sys.iocache.cpu_side = test_sys.iobus.master
 189             test_sys.iocache.mem_side = test_sys.membus.slave
 190         elif not options.external_memory_system:
 191             test_sys.iobridge = Bridge(delay='50ns', ranges = test_sys.mem_ranges)
 192             test_sys.iobridge.slave = test_sys.iobus.master
 193             test_sys.iobridge.master = test_sys.membus.slave
 194
 195         # Sanity check
 196         if options.simpoint_profile:
 197             if not ObjectList.is_noncaching_cpu(TestCPUClass):
 198                 fatal("SimPoint generation should be done with atomic cpu")
 199             if np > 1:
 200                 fatal("SimPoint generation not supported with more than one CPUs")
 201
 202         for i in range(np):
 203             if options.simpoint_profile:
 204                 test_sys.cpu[i].addSimPointProbe(options.simpoint_interval)
 205             if options.checker:
 206                 test_sys.cpu[i].addCheckerCpu()
 207             if not ObjectList.is_kvm_cpu(TestCPUClass):
 208                 if options.bp_type:
 209                     bpClass = ObjectList.bp_list.get(options.bp_type)
 210                     test_sys.cpu[i].branchPred = bpClass()
 211                 if options.indirect_bp_type:
 212                     IndirectBPClass = ObjectList.indirect_bp_list.get(
 213                         options.indirect_bp_type)
 214                     test_sys.cpu[i].branchPred.indirectBranchPred = \
 215                         IndirectBPClass()
 216             test_sys.cpu[i].createThreads()
 217
 218         # If elastic tracing is enabled when not restoring from checkpoint and
 219         # when not fast forwarding using the atomic cpu, then check that the
 220         # TestCPUClass is DerivO3CPU or inherits from DerivO3CPU. If the check
 221         # passes then attach the elastic trace probe.
 222         # If restoring from checkpoint or fast forwarding, the code that does this for
 223         # FutureCPUClass is in the Simulation module. If the check passes then the
 224         # elastic trace probe is attached to the switch CPUs.
 225         if options.elastic_trace_en and options.checkpoint_restore == None and \
 226             not options.fast_forward:
 227             CpuConfig.config_etrace(TestCPUClass, test_sys.cpu, options)
 228
 229         CacheConfig.config_cache(options, test_sys)
 230
 231         MemConfig.config_mem(options, test_sys)
 232
 233     return test_sys
 234
 235 def build_drive_system(np):
 236     # driver system CPU is always simple, so is the memory
 237     # Note this is an assignment of a class, not an instance.
 238     DriveCPUClass = AtomicSimpleCPU
 239     drive_mem_mode = 'atomic'
 240     DriveMemClass = SimpleMemory
 241
 242     cmdline = cmd_line_template()
 243     if buildEnv['TARGET_ISA'] == 'alpha':
 244         drive_sys = makeLinuxAlphaSystem(drive_mem_mode, bm[1],
 245                                          cmdline=cmdline)
 246     elif buildEnv['TARGET_ISA'] == 'mips':
 247         drive_sys = makeLinuxMipsSystem(drive_mem_mode, bm[1], cmdline=cmdline)
 248     elif buildEnv['TARGET_ISA'] == 'sparc':
 249         drive_sys = makeSparcSystem(drive_mem_mode, bm[1], cmdline=cmdline)
 250     elif buildEnv['TARGET_ISA'] == 'x86':
 251         drive_sys = makeLinuxX86System(drive_mem_mode, np, bm[1],
 252                                        cmdline=cmdline)
 253     elif buildEnv['TARGET_ISA'] == 'arm':
 254         drive_sys = makeArmSystem(drive_mem_mode, options.machine_type, np,
 255                                   bm[1], options.dtb_filename, cmdline=cmdline)
 256
 257     # Create a top-level voltage domain
 258     drive_sys.voltage_domain = VoltageDomain(voltage = options.sys_voltage)
 259
 260     # Create a source clock for the system and set the clock period
 261     drive_sys.clk_domain = SrcClockDomain(clock =  options.sys_clock,
 262             voltage_domain = drive_sys.voltage_domain)
 263
 264     # Create a CPU voltage domain
 265     drive_sys.cpu_voltage_domain = VoltageDomain()
 266
 267     # Create a source clock for the CPUs and set the clock period
 268     drive_sys.cpu_clk_domain = SrcClockDomain(clock = options.cpu_clock,
 269                                               voltage_domain =
 270                                               drive_sys.cpu_voltage_domain)
 271
 272     drive_sys.cpu = DriveCPUClass(clk_domain=drive_sys.cpu_clk_domain,
 273                                   cpu_id=0)
 274     drive_sys.cpu.createThreads()
 275     drive_sys.cpu.createInterruptController()
 276     drive_sys.cpu.connectAllPorts(drive_sys.membus)
 277     if options.kernel is not None:
 278         drive_sys.kernel = binary(options.kernel)
 279     else:
 280         print("Error: a kernel must be provided to run in full system mode")
 281         sys.exit(1)
 282
 283     if ObjectList.is_kvm_cpu(DriveCPUClass):
 284         drive_sys.kvm_vm = KvmVM()
 285
 286     drive_sys.iobridge = Bridge(delay='50ns',
 287                                 ranges = drive_sys.mem_ranges)
 288     drive_sys.iobridge.slave = drive_sys.iobus.master
 289     drive_sys.iobridge.master = drive_sys.membus.slave
 290
 291     # Create the appropriate memory controllers and connect them to the
 292     # memory bus
 293     drive_sys.mem_ctrls = [DriveMemClass(range = r)
 294                            for r in drive_sys.mem_ranges]
 295     for i in range(len(drive_sys.mem_ctrls)):
 296         drive_sys.mem_ctrls[i].port = drive_sys.membus.master
 297
 298     drive_sys.init_param = options.init_param
 299
 300     return drive_sys
 301
 302 # Add options
 303 parser = optparse.OptionParser()
 304 Options.addCommonOptions(parser)
 305 Options.addFSOptions(parser)
 306
 307 # Add the ruby specific and protocol specific options
 308 if '--ruby' in sys.argv:
 309     Ruby.define_options(parser)
 310
 311 (options, args) = parser.parse_args()
 312
 313 if args:
 314     print("Error: script doesn't take any positional arguments")
 315     sys.exit(1)
 316
 317 # system under test can be any CPU
 318 (TestCPUClass, test_mem_mode, FutureClass) = Simulation.setCPUClass(options)
 319
 320 # Match the memories with the CPUs, based on the options for the test system
 321 TestMemClass = Simulation.setMemClass(options)
 322
 323 if options.benchmark:
 324     try:
 325         bm = Benchmarks[options.benchmark]
 326     except KeyError:
 327         print("Error benchmark %s has not been defined." % options.benchmark)
 328         print("Valid benchmarks are: %s" % DefinedBenchmarks)
 329         sys.exit(1)
 330 else:
 331     if options.dual:
 332         bm = [SysConfig(disk=options.disk_image, rootdev=options.root_device,
 333                         mem=options.mem_size, os_type=options.os_type),
 334               SysConfig(disk=options.disk_image, rootdev=options.root_device,
 335                         mem=options.mem_size, os_type=options.os_type)]
 336     else:
 337         bm = [SysConfig(disk=options.disk_image, rootdev=options.root_device,
 338                         mem=options.mem_size, os_type=options.os_type)]
 339
 340 np = options.num_cpus
 341
 342 test_sys = build_test_system(np)
 343 if len(bm) == 2:
 344     drive_sys = build_drive_system(np)
 345     root = makeDualRoot(True, test_sys, drive_sys, options.etherdump)
 346 elif len(bm) == 1 and options.dist:
 347     # This system is part of a dist-gem5 simulation
 348     root = makeDistRoot(test_sys,
 349                         options.dist_rank,
 350                         options.dist_size,
 351                         options.dist_server_name,
 352                         options.dist_server_port,
 353                         options.dist_sync_repeat,
 354                         options.dist_sync_start,
 355                         options.ethernet_linkspeed,
 356                         options.ethernet_linkdelay,
 357                         options.etherdump);
 358 elif len(bm) == 1:
 359     root = Root(full_system=True, system=test_sys)
 360 else:
 361     print("Error I don't know how to create more than 2 systems.")
 362     sys.exit(1)
 363
 364 if options.timesync:
 365     root.time_sync_enable = True
 366
 367 if options.frame_capture:
 368     VncServer.frame_capture = True
 369
 370 if buildEnv['TARGET_ISA'] == "arm" and not options.bare_metal \
 371         and not options.dtb_filename:
 372     if options.machine_type not in ["VExpress_GEM5", "VExpress_GEM5_V1"]:
 373         warn("Can only correctly generate a dtb for VExpress_GEM5_V1 " \
 374              "platforms, unless custom hardware models have been equipped "\
 375              "with generation functionality.")
 376
 377     # Generate a Device Tree
 378     for sysname in ('system', 'testsys', 'drivesys'):
 379         if hasattr(root, sysname):
 380             sys = getattr(root, sysname)
 381             sys.generateDtb(m5.options.outdir, '%s.dtb' % sysname)
 382
 383 Simulation.setWorkCountOptions(test_sys, options)
 384 Simulation.run(options, root, test_sys, FutureClass)