Files
gem5/configs/example/gem5_library/riscv-demo-board-run.py
Erin (Jianghua) Le f01d68bf96 stdlib, configs: Add RiscvDemoBoard (#1490)
This PR adds a RiscvDemoBoard that can be used with both SE and FS
mode.This was tested using the workloads riscv-matrix-multiply-run for
SE and riscv-ubuntu-20.04-boot for FS. Two example config scripts have
also been added.
2024-10-22 10:13:22 -07:00

113 lines
3.5 KiB
Python

# Copyright (c) 2024 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 utilizes the RiscvDemoBoard to run a simple Ubunutu boot. The script
will boot the the OS to login before exiting the simulation.
A detailed terminal output can be found in `m5out/board.platform.terminal`.
**Warning:** The RiscvDemoBoard uses the Timing CPU. The boot may take
considerable time to complete execution.
Usage
-----
```
scons build/ALL/gem5.opt
./build/ALL/gem5.opt configs/example/gem5_library/riscv-demo-board-run.py --workload=riscv-ubuntu-24.04-boot-no-systemd
```
"""
import argparse
import m5
from gem5.prebuilt.demo.riscv_demo_board import RiscvDemoBoard
from gem5.resources.resource import obtain_resource
from gem5.simulate.exit_event import ExitEvent
from gem5.simulate.simulator import Simulator
parser = argparse.ArgumentParser()
parser.add_argument(
"--workload",
help="Enter the name of the workload you would like to run. You can browse"
" through the available workloads and resources at "
"https://resources.gem5.org",
)
parser.add_argument(
"--version",
help="Enter the workload version you would like to use. The latest version"
" will be used if this is left blank.",
)
args = parser.parse_args()
board = RiscvDemoBoard()
def handle_workend():
print("Dump stats at the end of the ROI!")
m5.stats.dump()
yield False
def handle_workbegin():
print("Done booting Linux")
print("Resetting stats at the start of ROI!")
m5.stats.reset()
yield False
def exit_event_handler():
print("first exit event: Kernel booted")
yield False
print("second exit event: In after boot")
yield False
print("third exit event: After run script")
yield True
board.set_workload(
obtain_resource(resource_id=args.workload, resource_version=args.version)
)
simulator = Simulator(
board=board,
on_exit_event={
ExitEvent.WORKBEGIN: handle_workbegin(),
ExitEvent.WORKEND: handle_workend(),
ExitEvent.EXIT: exit_event_handler(),
},
)
simulator.run()