fs_bigLITTLE.py revision 11630:6e2408ad4425 
1# Copyright (c) 2016 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
43import argparse
44import os
45import sys
46import m5
47from m5.objects import *
48
49m5.util.addToPath("../../common")
50import SysPaths
51import CpuConfig
52
53import devices
54
55
56default_dtb = 'armv8_gem5_v1_big_little_2_2.dtb'
57default_kernel = 'vmlinux4.3.aarch64'
58default_disk = 'aarch64-ubuntu-trusty-headless.img'
59default_rcs = 'bootscript.rcS'
60
61default_mem_size= "2GB"
62
63
64class BigCluster(devices.CpuCluster):
65    def __init__(self, system, num_cpus, cpu_clock,
66                 cpu_voltage="1.0V"):
67        cpu_config = [ CpuConfig.get("arm_detailed"), devices.L1I, devices.L1D,
68                    devices.WalkCache, devices.L2 ]
69        super(BigCluster, self).__init__(system, num_cpus, cpu_clock,
70                                         cpu_voltage, *cpu_config)
71
72class LittleCluster(devices.CpuCluster):
73    def __init__(self, system, num_cpus, cpu_clock,
74                 cpu_voltage="1.0V"):
75        cpu_config = [ CpuConfig.get("minor"), devices.L1I, devices.L1D,
76                       devices.WalkCache, devices.L2 ]
77        super(LittleCluster, self).__init__(system, num_cpus, cpu_clock,
78                                         cpu_voltage, *cpu_config)
79
80
81def createSystem(kernel, bootscript, disks=[]):
82    sys = devices.SimpleSystem(kernel=SysPaths.binary(kernel),
83                               readfile=bootscript,
84                               machine_type="DTOnly")
85
86    mem_region = sys.realview._mem_regions[0]
87    sys.mem_ctrls = SimpleMemory(
88        range=AddrRange(start=mem_region[0], size=default_mem_size))
89    sys.mem_ctrls.port = sys.membus.master
90
91    sys.connect()
92
93    # Attach disk images
94    if disks:
95        def cow_disk(image_file):
96            image = CowDiskImage()
97            image.child.image_file = SysPaths.disk(image_file)
98            return image
99
100        sys.disk_images = [ cow_disk(f) for f in disks ]
101        sys.pci_vio_block = [ PciVirtIO(vio=VirtIOBlock(image=img))
102                              for img in sys.disk_images ]
103        for dev in sys.pci_vio_block:
104            sys.attach_pci(dev)
105
106    sys.realview.setupBootLoader(sys.membus, sys, SysPaths.binary)
107
108    return sys
109
110
111def main():
112    parser = argparse.ArgumentParser(
113        description="Generic ARM big.LITTLE configuration")
114
115    parser.add_argument("--restore-from", type=str, default=None,
116                        help="Restore from checkpoint")
117    parser.add_argument("--dtb", type=str, default=default_dtb,
118                        help="DTB file to load")
119    parser.add_argument("--kernel", type=str, default=default_kernel,
120                        help="Linux kernel")
121    parser.add_argument("--disk", action="append", type=str, default=[],
122                        help="Disks to instantiate")
123    parser.add_argument("--bootscript", type=str, default=default_rcs,
124                        help="Linux bootscript")
125    parser.add_argument("--atomic", action="store_true", default=False,
126                        help="Use atomic CPUs")
127    parser.add_argument("--kernel-init", type=str, default="/sbin/init",
128                        help="Override init")
129    parser.add_argument("--big-cpus", type=int, default=1,
130                        help="Number of big CPUs to instantiate")
131    parser.add_argument("--little-cpus", type=int, default=1,
132                        help="Number of little CPUs to instantiate")
133    parser.add_argument("--caches", action="store_true", default=False,
134                        help="Instantiate caches")
135    parser.add_argument("--last-cache-level", type=int, default=2,
136                        help="Last level of caches (e.g. 3 for L3)")
137    parser.add_argument("--big-cpu-clock", type=str, default="2GHz",
138                        help="Big CPU clock frequency")
139    parser.add_argument("--little-cpu-clock", type=str, default="1GHz",
140                        help="Little CPU clock frequency")
141
142    m5.ticks.fixGlobalFrequency()
143
144    options = parser.parse_args()
145
146    kernel_cmd = [
147        "earlyprintk=pl011,0x1c090000",
148        "console=ttyAMA0",
149        "lpj=19988480",
150        "norandmaps",
151        "loglevel=8",
152        "mem=%s" % default_mem_size,
153        "root=/dev/vda1",
154        "rw",
155        "init=%s" % options.kernel_init,
156        "vmalloc=768MB",
157    ]
158
159    root = Root(full_system=True)
160
161    disks = default_disk if len(options.disk) == 0 else options.disk
162    system = createSystem(options.kernel, options.bootscript, disks=disks)
163
164    root.system = system
165    system.boot_osflags = " ".join(kernel_cmd)
166
167    AtomicCluster = devices.AtomicCluster
168
169    if options.big_cpus + options.little_cpus == 0:
170        m5.util.panic("Empty CPU clusters")
171
172    # big cluster
173    if options.big_cpus > 0:
174        if options.atomic:
175            system.bigCluster = AtomicCluster(system, options.big_cpus,
176                                              options.big_cpu_clock)
177        else:
178            system.bigCluster = BigCluster(system, options.big_cpus,
179                                           options.big_cpu_clock)
180        mem_mode = system.bigCluster.memoryMode()
181    # little cluster
182    if options.little_cpus > 0:
183        if options.atomic:
184            system.littleCluster = AtomicCluster(system, options.little_cpus,
185                                                 options.little_cpu_clock)
186
187        else:
188            system.littleCluster = LittleCluster(system, options.little_cpus,
189                                                 options.little_cpu_clock)
190        mem_mode = system.littleCluster.memoryMode()
191
192    if options.big_cpus > 0 and options.little_cpus > 0:
193        if system.bigCluster.memoryMode() != system.littleCluster.memoryMode():
194            m5.util.panic("Memory mode missmatch among CPU clusters")
195    system.mem_mode = mem_mode
196
197    # create caches
198    system.addCaches(options.caches, options.last_cache_level)
199    if not options.caches:
200        if options.big_cpus > 0 and system.bigCluster.requireCaches():
201            m5.util.panic("Big CPU model requires caches")
202        if options.little_cpus > 0 and system.littleCluster.requireCaches():
203            m5.util.panic("Little CPU model requires caches")
204
205    # Linux device tree
206    system.dtb_filename = SysPaths.binary(options.dtb)
207
208    # Get and load from the chkpt or simpoint checkpoint
209    if options.restore_from is not None:
210        m5.instantiate(options.restore_from)
211    else:
212        m5.instantiate()
213
214    # start simulation (and drop checkpoints when requested)
215    while True:
216        event = m5.simulate()
217        exit_msg = event.getCause()
218        if exit_msg == "checkpoint":
219            print "Dropping checkpoint at tick %d" % m5.curTick()
220            cpt_dir = os.path.join(m5.options.outdir, "cpt.%d" % m5.curTick())
221            m5.checkpoint(os.path.join(cpt_dir))
222            print "Checkpoint done."
223        else:
224            print exit_msg, " @ ", m5.curTick()
225            break
226
227    sys.exit(event.getCode())
228
229
230if __name__ == "__m5_main__":
231    main()
232