configs/example/arm/fs_bigLITTLE.py

   1 # Copyright (c) 2016-2017, 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 # Redistribution and use in source and binary forms, with or without
  14 # modification, are permitted provided that the following conditions are
  15 # met: redistributions of source code must retain the above copyright
  16 # notice, this list of conditions and the following disclaimer;
  17 # redistributions in binary form must reproduce the above copyright
  18 # notice, this list of conditions and the following disclaimer in the
  19 # documentation and/or other materials provided with the distribution;
  20 # neither the name of the copyright holders nor the names of its
  21 # contributors may be used to endorse or promote products derived from
  22 # this software without specific prior written permission.
  23 #
  24 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35 #
  36 # Authors: Gabor Dozsa
  37 #          Andreas Sandberg
  38
  39 # This is an example configuration script for full system simulation of
  40 # a generic ARM bigLITTLE system.
  41
  42
  43 from __future__ import print_function
  44 from __future__ import absolute_import
  45
  46 import argparse
  47 import os
  48 import sys
  49 import m5
  50 import m5.util
  51 from m5.objects import *
  52
  53 m5.util.addToPath("../../")
  54
  55 from common import FSConfig
  56 from common import SysPaths
  57 from common import ObjectList
  58 from common import Options
  59 from common.cores.arm import ex5_big, ex5_LITTLE
  60
  61 import devices
  62 from devices import AtomicCluster, KvmCluster, FastmodelCluster
  63
  64
  65 default_disk = 'aarch64-ubuntu-trusty-headless.img'
  66 default_rcs = 'bootscript.rcS'
  67
  68 default_mem_size= "2GB"
  69
  70 def _to_ticks(value):
  71     """Helper function to convert a latency from string format to Ticks"""
  72
  73     return m5.ticks.fromSeconds(m5.util.convert.anyToLatency(value))
  74
  75 def _using_pdes(root):
  76     """Determine if the simulator is using multiple parallel event queues"""
  77
  78     for obj in root.descendants():
  79         if not m5.proxy.isproxy(obj.eventq_index) and \
  80                obj.eventq_index != root.eventq_index:
  81             return True
  82
  83     return False
  84
  85
  86 class BigCluster(devices.CpuCluster):
  87     def __init__(self, system, num_cpus, cpu_clock,
  88                  cpu_voltage="1.0V"):
  89         cpu_config = [ ObjectList.cpu_list.get("O3_ARM_v7a_3"),
  90             devices.L1I, devices.L1D, devices.WalkCache, devices.L2 ]
  91         super(BigCluster, self).__init__(system, num_cpus, cpu_clock,
  92                                          cpu_voltage, *cpu_config)
  93
  94 class LittleCluster(devices.CpuCluster):
  95     def __init__(self, system, num_cpus, cpu_clock,
  96                  cpu_voltage="1.0V"):
  97         cpu_config = [ ObjectList.cpu_list.get("MinorCPU"), devices.L1I,
  98             devices.L1D, devices.WalkCache, devices.L2 ]
  99         super(LittleCluster, self).__init__(system, num_cpus, cpu_clock,
 100                                          cpu_voltage, *cpu_config)
 101
 102 class Ex5BigCluster(devices.CpuCluster):
 103     def __init__(self, system, num_cpus, cpu_clock,
 104                  cpu_voltage="1.0V"):
 105         cpu_config = [ ObjectList.cpu_list.get("ex5_big"), ex5_big.L1I,
 106             ex5_big.L1D, ex5_big.WalkCache, ex5_big.L2 ]
 107         super(Ex5BigCluster, self).__init__(system, num_cpus, cpu_clock,
 108                                          cpu_voltage, *cpu_config)
 109
 110 class Ex5LittleCluster(devices.CpuCluster):
 111     def __init__(self, system, num_cpus, cpu_clock,
 112                  cpu_voltage="1.0V"):
 113         cpu_config = [ ObjectList.cpu_list.get("ex5_LITTLE"),
 114             ex5_LITTLE.L1I, ex5_LITTLE.L1D, ex5_LITTLE.WalkCache,
 115             ex5_LITTLE.L2 ]
 116         super(Ex5LittleCluster, self).__init__(system, num_cpus, cpu_clock,
 117                                          cpu_voltage, *cpu_config)
 118
 119 def createSystem(caches, kernel, bootscript, machine_type="VExpress_GEM5",
 120                  disks=[],  mem_size=default_mem_size, bootloader=None):
 121     platform = ObjectList.platform_list.get(machine_type)
 122     m5.util.inform("Simulated platform: %s", platform.__name__)
 123
 124     sys = devices.simpleSystem(LinuxArmSystem,
 125                                caches, mem_size, platform(),
 126                                kernel=SysPaths.binary(kernel),
 127                                readfile=bootscript)
 128
 129     sys.mem_ctrls = [ SimpleMemory(range=r, port=sys.membus.master)
 130                       for r in sys.mem_ranges ]
 131
 132     sys.connect()
 133
 134     # Attach disk images
 135     if disks:
 136         def cow_disk(image_file):
 137             image = CowDiskImage()
 138             image.child.image_file = SysPaths.disk(image_file)
 139             return image
 140
 141         sys.disk_images = [ cow_disk(f) for f in disks ]
 142         sys.pci_vio_block = [ PciVirtIO(vio=VirtIOBlock(image=img))
 143                               for img in sys.disk_images ]
 144         for dev in sys.pci_vio_block:
 145             sys.attach_pci(dev)
 146
 147     sys.realview.setupBootLoader(sys, SysPaths.binary, bootloader)
 148
 149     return sys
 150
 151 cpu_types = {
 152     "atomic" : (AtomicCluster, AtomicCluster),
 153     "timing" : (BigCluster, LittleCluster),
 154     "exynos" : (Ex5BigCluster, Ex5LittleCluster),
 155 }
 156
 157 # Only add the KVM CPU if it has been compiled into gem5
 158 if devices.have_kvm:
 159     cpu_types["kvm"] = (KvmCluster, KvmCluster)
 160
 161 # Only add the FastModel CPU if it has been compiled into gem5
 162 if devices.have_fastmodel:
 163     cpu_types["fastmodel"] = (FastmodelCluster, FastmodelCluster)
 164
 165 def addOptions(parser):
 166     parser.add_argument("--restore-from", type=str, default=None,
 167                         help="Restore from checkpoint")
 168     parser.add_argument("--dtb", type=str, default=None,
 169                         help="DTB file to load")
 170     parser.add_argument("--kernel", type=str, required=True,
 171                         help="Linux kernel")
 172     parser.add_argument("--root", type=str, default="/dev/vda1",
 173                         help="Specify the kernel CLI root= argument")
 174     parser.add_argument("--machine-type", type=str,
 175                         choices=ObjectList.platform_list.get_names(),
 176                         default="VExpress_GEM5",
 177                         help="Hardware platform class")
 178     parser.add_argument("--disk", action="append", type=str, default=[],
 179                         help="Disks to instantiate")
 180     parser.add_argument("--bootscript", type=str, default=default_rcs,
 181                         help="Linux bootscript")
 182     parser.add_argument("--cpu-type", type=str, choices=cpu_types.keys(),
 183                         default="timing",
 184                         help="CPU simulation mode. Default: %(default)s")
 185     parser.add_argument("--kernel-init", type=str, default="/sbin/init",
 186                         help="Override init")
 187     parser.add_argument("--big-cpus", type=int, default=1,
 188                         help="Number of big CPUs to instantiate")
 189     parser.add_argument("--little-cpus", type=int, default=1,
 190                         help="Number of little CPUs to instantiate")
 191     parser.add_argument("--caches", action="store_true", default=False,
 192                         help="Instantiate caches")
 193     parser.add_argument("--last-cache-level", type=int, default=2,
 194                         help="Last level of caches (e.g. 3 for L3)")
 195     parser.add_argument("--big-cpu-clock", type=str, default="2GHz",
 196                         help="Big CPU clock frequency")
 197     parser.add_argument("--little-cpu-clock", type=str, default="1GHz",
 198                         help="Little CPU clock frequency")
 199     parser.add_argument("--sim-quantum", type=str, default="1ms",
 200                         help="Simulation quantum for parallel simulation. " \
 201                         "Default: %(default)s")
 202     parser.add_argument("--mem-size", type=str, default=default_mem_size,
 203                         help="System memory size")
 204     parser.add_argument("--kernel-cmd", type=str, default=None,
 205                         help="Custom Linux kernel command")
 206     parser.add_argument("--bootloader", action="append",
 207                         help="executable file that runs before the --kernel")
 208     parser.add_argument("-P", "--param", action="append", default=[],
 209         help="Set a SimObject parameter relative to the root node. "
 210              "An extended Python multi range slicing syntax can be used "
 211              "for arrays. For example: "
 212              "'system.cpu[0,1,3:8:2].max_insts_all_threads = 42' "
 213              "sets max_insts_all_threads for cpus 0, 1, 3, 5 and 7 "
 214              "Direct parameters of the root object are not accessible, "
 215              "only parameters of its children.")
 216     parser.add_argument("--vio-9p", action="store_true",
 217                         help=Options.vio_9p_help)
 218     return parser
 219
 220 def build(options):
 221     m5.ticks.fixGlobalFrequency()
 222
 223     kernel_cmd = [
 224         "earlyprintk=pl011,0x1c090000",
 225         "console=ttyAMA0",
 226         "lpj=19988480",
 227         "norandmaps",
 228         "loglevel=8",
 229         "mem=%s" % options.mem_size,
 230         "root=%s" % options.root,
 231         "rw",
 232         "init=%s" % options.kernel_init,
 233         "vmalloc=768MB",
 234     ]
 235
 236     root = Root(full_system=True)
 237
 238     disks = [default_disk] if len(options.disk) == 0 else options.disk
 239     system = createSystem(options.caches,
 240                           options.kernel,
 241                           options.bootscript,
 242                           options.machine_type,
 243                           disks=disks,
 244                           mem_size=options.mem_size,
 245                           bootloader=options.bootloader)
 246
 247     root.system = system
 248     if options.kernel_cmd:
 249         system.boot_osflags = options.kernel_cmd
 250     else:
 251         system.boot_osflags = " ".join(kernel_cmd)
 252
 253     if options.big_cpus + options.little_cpus == 0:
 254         m5.util.panic("Empty CPU clusters")
 255
 256     big_model, little_model = cpu_types[options.cpu_type]
 257
 258     all_cpus = []
 259     # big cluster
 260     if options.big_cpus > 0:
 261         system.bigCluster = big_model(system, options.big_cpus,
 262                                       options.big_cpu_clock)
 263         system.mem_mode = system.bigCluster.memoryMode()
 264         all_cpus += system.bigCluster.cpus
 265
 266     # little cluster
 267     if options.little_cpus > 0:
 268         system.littleCluster = little_model(system, options.little_cpus,
 269                                             options.little_cpu_clock)
 270         system.mem_mode = system.littleCluster.memoryMode()
 271         all_cpus += system.littleCluster.cpus
 272
 273     # Figure out the memory mode
 274     if options.big_cpus > 0 and options.little_cpus > 0 and \
 275        system.bigCluster.memoryMode() != system.littleCluster.memoryMode():
 276         m5.util.panic("Memory mode missmatch among CPU clusters")
 277
 278
 279     # create caches
 280     system.addCaches(options.caches, options.last_cache_level)
 281     if not options.caches:
 282         if options.big_cpus > 0 and system.bigCluster.requireCaches():
 283             m5.util.panic("Big CPU model requires caches")
 284         if options.little_cpus > 0 and system.littleCluster.requireCaches():
 285             m5.util.panic("Little CPU model requires caches")
 286
 287     # Create a KVM VM and do KVM-specific configuration
 288     if issubclass(big_model, KvmCluster):
 289         _build_kvm(system, all_cpus)
 290
 291     # Linux device tree
 292     if options.dtb is not None:
 293         system.dtb_filename = SysPaths.binary(options.dtb)
 294     else:
 295         system.generateDtb(m5.options.outdir, 'system.dtb')
 296
 297     if devices.have_fastmodel and issubclass(big_model, FastmodelCluster):
 298         from m5 import arm_fast_model as fm, systemc as sc
 299         # setup FastModels for simulation
 300         fm.setup_simulation("cortexa76")
 301         # setup SystemC
 302         root.systemc_kernel = m5.objects.SystemC_Kernel()
 303         m5.tlm.tlm_global_quantum_instance().set(
 304             sc.sc_time(10000.0 / 100000000.0, sc.sc_time.SC_SEC))
 305
 306     if options.vio_9p:
 307         FSConfig.attach_9p(system.realview, system.iobus)
 308
 309     return root
 310
 311 def _build_kvm(system, cpus):
 312     system.kvm_vm = KvmVM()
 313
 314     # Assign KVM CPUs to their own event queues / threads. This
 315     # has to be done after creating caches and other child objects
 316     # since these mustn't inherit the CPU event queue.
 317     if len(cpus) > 1:
 318         device_eq = 0
 319         first_cpu_eq = 1
 320         for idx, cpu in enumerate(cpus):
 321             # Child objects usually inherit the parent's event
 322             # queue. Override that and use the same event queue for
 323             # all devices.
 324             for obj in cpu.descendants():
 325                 obj.eventq_index = device_eq
 326             cpu.eventq_index = first_cpu_eq + idx
 327
 328
 329
 330 def instantiate(options, checkpoint_dir=None):
 331     # Setup the simulation quantum if we are running in PDES-mode
 332     # (e.g., when using KVM)
 333     root = Root.getInstance()
 334     if root and _using_pdes(root):
 335         m5.util.inform("Running in PDES mode with a %s simulation quantum.",
 336                        options.sim_quantum)
 337         root.sim_quantum = _to_ticks(options.sim_quantum)
 338
 339     # Get and load from the chkpt or simpoint checkpoint
 340     if options.restore_from:
 341         if checkpoint_dir and not os.path.isabs(options.restore_from):
 342             cpt = os.path.join(checkpoint_dir, options.restore_from)
 343         else:
 344             cpt = options.restore_from
 345
 346         m5.util.inform("Restoring from checkpoint %s", cpt)
 347         m5.instantiate(cpt)
 348     else:
 349         m5.instantiate()
 350
 351
 352 def run(checkpoint_dir=m5.options.outdir):
 353     # start simulation (and drop checkpoints when requested)
 354     while True:
 355         event = m5.simulate()
 356         exit_msg = event.getCause()
 357         if exit_msg == "checkpoint":
 358             print("Dropping checkpoint at tick %d" % m5.curTick())
 359             cpt_dir = os.path.join(checkpoint_dir, "cpt.%d" % m5.curTick())
 360             m5.checkpoint(cpt_dir)
 361             print("Checkpoint done.")
 362         else:
 363             print(exit_msg, " @ ", m5.curTick())
 364             break
 365
 366     sys.exit(event.getCode())
 367
 368
 369 def main():
 370     parser = argparse.ArgumentParser(
 371         description="Generic ARM big.LITTLE configuration")
 372     addOptions(parser)
 373     options = parser.parse_args()
 374     root = build(options)
 375     root.apply_config(options.param)
 376     instantiate(options)
 377     run()
 378
 379
 380 if __name__ == "__m5_main__":
 381     main()