| # Copyright (c) 2022 The Regents of the University of California |
| # All rights reserved. |
| # |
| # 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. |
| |
| """ |
| This script further shows an example of booting an ARM based full system Ubuntu |
| disk image. This simulation boots the disk image using 2 TIMING CPU cores. The |
| simulation ends when the startup is completed successfully (i.e. when an |
| `m5_exit instruction is reached on successful boot). |
| |
| Usage |
| ----- |
| |
| ``` |
| scons build/ARM/gem5.opt -j<NUM_CPUS> |
| ./build/ARM/gem5.opt configs/example/gem5_library/arm-ubuntu-run.py |
| ``` |
| |
| """ |
| |
| from gem5.isas import ISA |
| from m5.objects import ArmDefaultRelease |
| from gem5.utils.requires import requires |
| from gem5.resources.workload import Workload |
| from gem5.simulate.simulator import Simulator |
| from m5.objects import VExpress_GEM5_Foundation |
| from gem5.coherence_protocol import CoherenceProtocol |
| from gem5.components.boards.arm_board import ArmBoard |
| from gem5.components.memory import DualChannelDDR4_2400 |
| from gem5.components.processors.cpu_types import CPUTypes |
| from gem5.components.processors.simple_processor import SimpleProcessor |
| |
| |
| # This runs a check to ensure the gem5 binary is compiled for ARM and the |
| # protocol is CHI. |
| |
| requires(isa_required=ISA.ARM) |
| |
| from gem5.components.cachehierarchies.classic.private_l1_private_l2_cache_hierarchy import ( |
| PrivateL1PrivateL2CacheHierarchy, |
| ) |
| |
| # Here we setup the parameters of the l1 and l2 caches. |
| cache_hierarchy = PrivateL1PrivateL2CacheHierarchy( |
| l1d_size="16kB", l1i_size="16kB", l2_size="256kB" |
| ) |
| |
| # Memory: Dual Channel DDR4 2400 DRAM device. |
| |
| memory = DualChannelDDR4_2400(size="2GB") |
| |
| # Here we setup the processor. We use a simple TIMING processor. The config |
| # script was also tested with ATOMIC processor. |
| |
| processor = SimpleProcessor(cpu_type=CPUTypes.TIMING, num_cores=2, isa=ISA.ARM) |
| |
| # The ArmBoard requires a `release` to be specified. This adds all the |
| # extensions or features to the system. We are setting this to Armv8 |
| # (ArmDefaultRelease) in this example config script. |
| release = ArmDefaultRelease() |
| |
| # The platform sets up the memory ranges of all the on-chip and off-chip |
| # devices present on the ARM system. |
| |
| platform = VExpress_GEM5_Foundation() |
| |
| # Here we setup the board. The ArmBoard allows for Full-System ARM simulations. |
| |
| board = ArmBoard( |
| clk_freq="3GHz", |
| processor=processor, |
| memory=memory, |
| cache_hierarchy=cache_hierarchy, |
| release=release, |
| platform=platform, |
| ) |
| |
| # Here we set a full system workload. The "arm64-ubuntu-20.04-boot" boots |
| # Ubuntu 20.04. |
| |
| board.set_workload(Workload("arm64-ubuntu-20.04-boot")) |
| |
| # We define the system with the aforementioned system defined. |
| |
| simulator = Simulator(board=board) |
| |
| # Once the system successfully boots, it encounters an |
| # `m5_exit instruction encountered`. We stop the simulation then. When the |
| # simulation has ended you may inspect `m5out/board.terminal` to see |
| # the stdout. |
| |
| simulator.run() |