config, arm: FS configuration for the ARM starter kit

Add a full system example configuration for the ARM Research Starter
Kit on System Modeling. More information can be found at:
http://www.arm.com/ResearchEnablement/SystemModeling

Change-Id: Ifa40419d21923a32bb383d58466e421fe4260ddd
Signed-off-by: Gabor Dozsa <gabor.dozsa@arm.com>
[ Minor cleanups and more documentation ]
Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/4202
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
Maintainer: Jason Lowe-Power <jason@lowepower.com>

1 files changed, 242 insertions, 0 deletions

diff --git a/configs/example/arm/starter_fs.py b/configs/example/arm/starter_fs.py
new file mode 100644
index 000000000..9b6f68f55
--- /dev/null
+++ b/configs/example/arm/starter_fs.py
@@ -0,0 +1,242 @@
+# Copyright (c) 2016-2017 ARM Limited
+# All rights reserved.
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# 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;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "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 COPYRIGHT
+# OWNER OR CONTRIBUTORS 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.
+#
+#  Authors:  Andreas Sandberg
+#            Chuan Zhu
+#            Gabor Dozsa
+#
+
+"""This script is the full system example script from the ARM
+Research Starter Kit on System Modeling. More information can be found
+at: http://www.arm.com/ResearchEnablement/SystemModeling
+"""
+
+import os
+import m5
+from m5.util import addToPath
+from m5.objects import *
+import argparse
+
+m5.util.addToPath('../..')
+
+from common import SysPaths
+from common import MemConfig
+from common.cores.arm import HPI
+
+import devices
+
+
+default_dist_version = '20170616'
+default_kernel = 'vmlinux.vexpress_gem5_v1_64.' + default_dist_version
+default_disk = 'linaro-minimal-aarch64.img'
+
+
+# Pre-defined CPU configurations. Each tuple must be ordered as : (cpu_class,
+# l1_icache_class, l1_dcache_class, walk_cache_class, l2_Cache_class). Any of
+# the cache class may be 'None' if the particular cache is not present.
+cpu_types = {
+
+    "atomic" : ( AtomicSimpleCPU, None, None, None, None),
+    "minor" : (MinorCPU,
+               devices.L1I, devices.L1D,
+               devices.WalkCache,
+               devices.L2),
+    "hpi" : ( HPI.HPI,
+              HPI.HPI_ICache, HPI.HPI_DCache,
+              HPI.HPI_WalkCache,
+              HPI.HPI_L2)
+}
+
+def create_cow_image(name):
+    """Helper function to create a Copy-on-Write disk image"""
+    image = CowDiskImage()
+    image.child.image_file = SysPaths.disk(name)
+
+    return image;
+
+
+def create(args):
+    ''' Create and configure the system object. '''
+
+    if not args.dtb:
+        dtb_file = SysPaths.binary("armv8_gem5_v1_%icpu.%s.dtb" %
+                                   (args.num_cores, default_dist_version))
+    else:
+        dtb_file = args.dtb
+
+    if args.script and not os.path.isfile(args.script):
+        print "Error: Bootscript %s does not exist" % args.script
+        sys.exit(1)
+
+    cpu_class = cpu_types[args.cpu][0]
+    mem_mode = cpu_class.memory_mode()
+    # Only simulate caches when using a timing CPU (e.g., the HPI model)
+    want_caches = True if mem_mode == "timing" else False
+
+    system = devices.SimpleSystem(want_caches,
+                                  args.mem_size,
+                                  mem_mode=mem_mode,
+                                  dtb_filename=dtb_file,
+                                  kernel=SysPaths.binary(args.kernel),
+                                  readfile=args.script,
+                                  machine_type="DTOnly")
+
+    MemConfig.config_mem(args, system)
+
+    # Add the PCI devices we need for this system. The base system
+    # doesn't have any PCI devices by default since they are assumed
+    # to be added by the configurastion scripts needin them.
+    system.pci_devices = [
+        # Create a VirtIO block device for the system's boot
+        # disk. Attach the disk image using gem5's Copy-on-Write
+        # functionality to avoid writing changes to the stored copy of
+        # the disk image.
+        PciVirtIO(vio=VirtIOBlock(image=create_cow_image(args.disk_image))),
+    ]
+
+    # Attach the PCI devices to the system. The helper method in the
+    # system assigns a unique PCI bus ID to each of the devices and
+    # connects them to the IO bus.
+    for dev in system.pci_devices:
+        system.attach_pci(dev)
+
+    # Wire up the system's memory system
+    system.connect()
+
+    # Add CPU clusters to the system
+    system.cpu_cluster = [
+        devices.CpuCluster(system,
+                           args.num_cores,
+                           args.cpu_freq, "1.0V",
+                           *cpu_types[args.cpu]),
+    ]
+
+    # Create a cache hierarchy for the cluster. We are assuming that
+    # clusters have core-private L1 caches and an L2 that's shared
+    # within the cluster.
+    for cluster in system.cpu_cluster:
+        system.addCaches(want_caches, last_cache_level=2)
+
+    # Setup gem5's minimal Linux boot loader.
+    system.realview.setupBootLoader(system.membus, system, SysPaths.binary)
+
+    # Linux boot command flags
+    kernel_cmd = [
+        # Tell Linux to use the simulated serial port as a console
+        "console=ttyAMA0",
+        # Hard-code timi
+        "lpj=19988480",
+        # Disable address space randomisation to get a consistent
+        # memory layout.
+        "norandmaps",
+        # Tell Linux where to find the root disk image.
+        "root=/dev/vda1",
+        # Mount the root disk read-write by default.
+        "rw",
+        # Tell Linux about the amount of physical memory present.
+        "mem=%s" % args.mem_size,
+    ]
+    system.boot_osflags = " ".join(kernel_cmd)
+
+    return system
+
+
+def run(args):
+    cptdir = m5.options.outdir
+    if args.checkpoint:
+        print "Checkpoint directory: %s" % cptdir
+
+    while True:
+        event = m5.simulate()
+        exit_msg = event.getCause()
+        if exit_msg == "checkpoint":
+            print "Dropping checkpoint at tick %d" % m5.curTick()
+            cpt_dir = os.path.join(m5.options.outdir, "cpt.%d" % m5.curTick())
+            m5.checkpoint(os.path.join(cpt_dir))
+            print "Checkpoint done."
+        else:
+            print exit_msg, " @ ", m5.curTick()
+            break
+
+    sys.exit(event.getCode())
+
+
+def main():
+    parser = argparse.ArgumentParser(epilog=__doc__)
+
+    parser.add_argument("--dtb", type=str, default=None,
+                        help="DTB file to load")
+    parser.add_argument("--kernel", type=str, default=default_kernel,
+                        help="Linux kernel")
+    parser.add_argument("--disk-image", type=str,
+                        default=default_disk,
+                        help="Disk to instantiate")
+    parser.add_argument("--script", type=str, default="",
+                        help = "Linux bootscript")
+    parser.add_argument("--cpu", type=str, choices=cpu_types.keys(),
+                        default="atomic",
+                        help="CPU model to use")
+    parser.add_argument("--cpu-freq", type=str, default="4GHz")
+    parser.add_argument("--num-cores", type=int, default=1,
+                        help="Number of CPU cores")
+    parser.add_argument("--mem-type", default="DDR3_1600_8x8",
+                        choices=MemConfig.mem_names(),
+                        help = "type of memory to use")
+    parser.add_argument("--mem-channels", type=int, default=1,
+                        help = "number of memory channels")
+    parser.add_argument("--mem-ranks", type=int, default=None,
+                        help = "number of memory ranks per channel")
+    parser.add_argument("--mem-size", action="store", type=str,
+                        default="2GB",
+                        help="Specify the physical memory size")
+    parser.add_argument("--checkpoint", action="store_true")
+    parser.add_argument("--restore", type=str, default=None)
+
+
+    args = parser.parse_args()
+
+    root = Root(full_system=True)
+    root.system = create(args)
+
+    if args.restore is not None:
+        m5.instantiate(args.restore)
+    else:
+        m5.instantiate()
+
+    run(args)
+
+
+if __name__ == "__m5_main__":
+    main()