Melissa Jost has uploaded this change for review. ( https://gem5-review.googlesource.com/c/public/gem5/+/53046 )

Change subject: dev: Added LupV script to configs
......................................................................

dev: Added LupV script to configs

This commit adds run_lupv.py, the script to run the LupVBoard, as well
as a README that details how to set up your system in order to run
the LupIO devices.

Change-Id: Ibea098f0409819b4c79063ab0be01518c7c6a61f
---
A configs/example/lupv/run_lupv.py
A configs/example/lupv/README.md
2 files changed, 186 insertions(+), 0 deletions(-)



diff --git a/configs/example/lupv/README.md b/configs/example/lupv/README.md
new file mode 100644
index 0000000..c3192da
--- /dev/null
+++ b/configs/example/lupv/README.md
@@ -0,0 +1,48 @@
+# README
+
+This README details how to build a RISCV full system that utilizes the
+lupIO devices. The LupIO devices were created by Professor Joël Porquet-Lupine, +and more information about the device can be found here (https://luplab.cs.ucdavis.edu/assets/lupio/wcae21-porquet-lupio-paper.pdf). The specs for each individual device can +be found here (https://gitlab.com/luplab/lupio/lupio-specs), and the Linux drivers +for each of these devices can be found here (https://gitlab.com/luplab/lupio/linux).
+
+In order to run this system, you need the following:
+
+* `run_lupv.py`
+* a built version of the lupIO gem5 repo
+* bbl
+* disk image
+
+Both the bbl and a working disk image can be found on the LupIO+gem5 Google
+Drive. In addition, instructions to build a version of Linux with the lupIO
+drivers are there, but should not be needed.
+
+In order for `run_lupv.py` to work in its current state, move it within the
+gem5 directory.
+
+Once you have everything set up, you can run the RISCV full system by using
+the following command line prompt. Note that for the cpu type, you can choose
+between `atomic` and `simple` modes.
+
+``` bash
+[gem5 binary] gem5/run_lupv.py [path to bbl] [path to the disk image] [cpu type] [num cpus]
+```
+
+example:
+
+```bash
+gem5/build/RISCV/gem5.opt gem5/run_lupv.py bbl rootfs.img atomic 1
+```
+
+Once you've started the gem5 simulation, you can open up a separate terminal
+and use m5term to connect to the simulated console. The port number will be
+specified in the gem5 simulation.
+
+example:
+
+```bash
+m5term localhost 3456
+```
+
+This should allow you to run busybox, in which you can see the LupIO device at
+work!
diff --git a/configs/example/lupv/run_lupv.py b/configs/example/lupv/run_lupv.py
new file mode 100644
index 0000000..a5d3cbb
--- /dev/null
+++ b/configs/example/lupv/run_lupv.py
@@ -0,0 +1,125 @@
+# Copyright (c) 2021 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 example runs a simple linux boot.
+Characteristics
+---------------
+* Runs exclusively on the RISC-V ISA with the classic caches
+* Assumes that the kernel is compiled into the bootloader
+* Automatically generates the DTB file
+"""
+import m5
+from m5.objects import Root
+import sys
+import os
+# This is a lame hack to get the imports working correctly.
+# TODO: This needs fixed.
+sys.path.append(
+    os.path.join(
+        os.path.dirname(os.path.abspath(__file__)),
+        os.pardir,
+        os.pardir,
+        os.pardir,
+    )
+)
+from src.python.gem5.runtime import get_runtime_isa
+from src.python.gem5.components.boards.experimental.lupv_board import LupvBoard
+from src.python.gem5.components.memory.single_channel import (
+    SingleChannelDDR3_1600
+)
+from src.python.gem5.components.processors.simple_processor import (
+    SimpleProcessor
+)
+from src.python.gem5.components.processors.cpu_types import CPUTypes
+from src.python.gem5.isas import ISA
+import os
+import argparse
+import subprocess
+import gzip
+import shutil
+# Run a check to ensure the right version of gem5 is being used.
+if get_runtime_isa() != ISA.RISCV:
+    raise EnvironmentError(
+        "The run_lupv.py should be run with RISCV ISA."
+    )
+from src.python.gem5.components.cachehierarchies.classic. \
+    private_l1_private_l2_cache_hierarchy import (
+    PrivateL1PrivateL2CacheHierarchy,
+)
+
+def parse_options():
+    parser = argparse.ArgumentParser(description='Runs Linux fs test with'
+                'RISCV.')
+    parser.add_argument("bbl", help='Path to the bbl (berkeley bootloader)'
+                                        'binary with kernel payload')
+    parser.add_argument("disk", help="Path to the disk image to boot")
+    parser.add_argument("cpu_type", help="The type of CPU in the system")
+    parser.add_argument("num_cpus", type=int,
+                        help="The number of CPU in the system")
+
+    return parser.parse_args()
+
+args = parse_options()
+
+cache_hierarchy = PrivateL1PrivateL2CacheHierarchy(
+    l1d_size='32KiB',
+    l1i_size='32KiB',
+    l2_size='512KiB'
+)
+
+# Setup the system memory.
+memory = SingleChannelDDR3_1600(size='128MB')
+# Setup a single core Processor.
+if args.cpu_type == "atomic":
+    processor = SimpleProcessor(cpu_type=CPUTypes.ATOMIC,
+                                num_cores=args.num_cpus)
+elif args.cpu_type == "simple":
+    processor = SimpleProcessor(cpu_type=CPUTypes.TIMING,
+                                num_cores=args.num_cpus)
+
+# Setup the board.
+board = LupvBoard(
+    clk_freq="1GHz",
+    processor=processor,
+    memory=memory,
+    cache_hierarchy=cache_hierarchy,
+)
+board.connect_things()
+# Set the Full System workload.
+board.set_workload(disk_image=args.disk, bootloader=args.bbl)
+# Begin running of the simulation. This will exit once the Linux system boot
+# is complete.
+print("Running with ISA: " + get_runtime_isa().name)
+print()
+root = Root(full_system=True, system=board)
+m5.instantiate()
+print("Beginning simulation!")
+
+exit_event = m5.simulate()
+
+print(
+ "Exiting @ tick {} because {}.".format(m5.curTick(), exit_event.getCause())
+)

--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/53046
To unsubscribe, or for help writing mail filters, visit https://gem5-review.googlesource.com/settings

Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: Ibea098f0409819b4c79063ab0be01518c7c6a61f
Gerrit-Change-Number: 53046
Gerrit-PatchSet: 1
Gerrit-Owner: Melissa Jost <melissakj...@gmail.com>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s

Reply via email to