0b54ad277f
The purpose of the gem5 components library is to provide gem5 users a standard set of common and useful gem5 components pre-built to add to their experiments. The gem5 components library adopts a modular architecture design with the goal of components being easy to add and remove from designs, and extendable as needed. E.g., any Memory system should be interchangable with any other, and if not a helpful error messages should be raised. Examples of using the gem5 components library can be found in `configs/example/components-library`. Important Disclaimer: This is a pre-alpha release of the gem5 components library. The purpose of this release is to get some community feedback on this new component of gem5. Though some testing has been done, we expect regular fixes and improvements until this is in a stable state. The components library has been formatted with Python Black; typing has been checked with MyPy; and the library has been tested with the scripts in `configs/example/components-libary`. More rigorous tests are to be added in future revisions. More detailed documentation will appear in future revisions. Jira Ticket outlining TODOs and known bugs can be found here: https://gem5.atlassian.net/browse/GEM5-648 Change-Id: I3492ec4a6d8c59ffbae899ce8e87ab4ffb92b976 Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/47466 Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu> Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu> Tested-by: kokoro <noreply+kokoro@google.com>
87 lines
3.3 KiB
Python
87 lines
3.3 KiB
Python
# 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.
|
|
|
|
from abc import ABCMeta, abstractmethod
|
|
from .cpu_types import CPUTypes
|
|
|
|
from m5.objects import Port, SubSystem
|
|
|
|
|
|
class AbstractCore(SubSystem):
|
|
__metaclass__ = ABCMeta
|
|
|
|
def __init__(self, cpu_type: CPUTypes):
|
|
super(AbstractCore, self).__init__()
|
|
self._cpu_type = cpu_type
|
|
|
|
def get_type(self) -> CPUTypes:
|
|
return self._cpu_type
|
|
|
|
@abstractmethod
|
|
def connect_icache(self, port: Port) -> None:
|
|
"""
|
|
This function should connect the response port from the instruction
|
|
cache to the right request port on the core.
|
|
|
|
:param port: The response port from the icache to connect to.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def connect_dcache(self, port: Port) -> None:
|
|
"""
|
|
This function should connect the response port from the data cache to
|
|
the right request port on the core.
|
|
|
|
:param port: The response port from the icache to connect to.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def connect_walker_ports(self, port1: Port, port2: Port) -> None:
|
|
"""
|
|
Connect the response port from itb and dtb to their respective request
|
|
ports in the core.
|
|
|
|
:param port1: The response port from itb walker to connect to.
|
|
:param port2: The response port from dtb walker to connect to.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def set_workload(self, process: "Process") -> None:
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def set_switched_out(self, value: bool) -> None:
|
|
raise NotImplementedError
|
|
|
|
@abstractmethod
|
|
def connect_interrupt(
|
|
self, interrupt_requestor: Port, interrupt_responce: Port
|
|
) -> None:
|
|
raise NotImplementedError
|