141 lines
5.3 KiB
Python
141 lines
5.3 KiB
Python
# Copyright (c) 2022-23 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-with-kvm.py
|
|
```
|
|
|
|
"""
|
|
|
|
from m5.objects import (
|
|
ArmDefaultRelease,
|
|
VExpress_GEM5_V1,
|
|
)
|
|
|
|
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_switchable_processor import (
|
|
SimpleSwitchableProcessor,
|
|
)
|
|
from gem5.isas import ISA
|
|
from gem5.resources.resource import obtain_resource
|
|
from gem5.simulate.exit_event import ExitEvent
|
|
from gem5.simulate.simulator import Simulator
|
|
from gem5.utils.requires import requires
|
|
|
|
# This runs a check to ensure the gem5 binary is compiled for ARM.
|
|
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="16KiB", l1i_size="16KiB", l2_size="256KiB"
|
|
)
|
|
|
|
# Memory: Dual Channel DDR4 2400 DRAM device.
|
|
memory = DualChannelDDR4_2400(size="2GiB")
|
|
|
|
# Here we setup the processor. This is a special switchable processor in which
|
|
# a starting core type and a switch core type must be specified. Once a
|
|
# configuration is instantiated a user may call `processor.switch()` to switch
|
|
# from the starting core types to the switch core types. In this simulation
|
|
# we start with KVM cores to simulate the OS boot, then switch to the Timing
|
|
# cores for the command we wish to run after boot.
|
|
processor = SimpleSwitchableProcessor(
|
|
starting_core_type=CPUTypes.KVM,
|
|
switch_core_type=CPUTypes.TIMING,
|
|
isa=ISA.ARM,
|
|
num_cores=2,
|
|
)
|
|
|
|
# The ArmBoard requires a `release` to be specified. This adds all the
|
|
# extensions or features to the system. We are setting this to for_kvm()
|
|
# to enable KVM simulation.
|
|
release = ArmDefaultRelease.for_kvm()
|
|
|
|
# The platform sets up the memory ranges of all the on-chip and off-chip
|
|
# devices present on the ARM system. ARM KVM only works with VExpress_GEM5_V1
|
|
# on the ArmBoard at the moment.
|
|
platform = VExpress_GEM5_V1()
|
|
|
|
# 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 "arm-ubuntu-24.04-boot-with-systemd" boots
|
|
# Ubuntu 24.04.
|
|
workload = obtain_resource("arm-ubuntu-24.04-boot-with-systemd")
|
|
board.set_workload(workload)
|
|
|
|
|
|
def exit_event_handler():
|
|
print("First exit: kernel booted")
|
|
yield False # gem5 is now executing systemd startup
|
|
print("Second exit: Started `after_boot.sh` script")
|
|
# The after_boot.sh script is executed after the kernel and systemd have
|
|
# booted.
|
|
# Here we switch the CPU type to Timing.
|
|
print("Switching to Timing CPU")
|
|
processor.switch()
|
|
yield False # gem5 is now executing the `after_boot.sh` script
|
|
print("Third exit: Finished `after_boot.sh` script")
|
|
# The after_boot.sh script will run a script if it is passed via
|
|
# m5 readfile. This is the last exit event before the simulation exits.
|
|
yield True
|
|
|
|
|
|
simulator = Simulator(
|
|
board=board,
|
|
on_exit_event={
|
|
# Here we want override the default behavior for the first m5 exit
|
|
# exit event.
|
|
ExitEvent.EXIT: exit_event_handler()
|
|
},
|
|
)
|
|
|
|
simulator.run()
|