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>
77 lines
3.2 KiB
Python
77 lines
3.2 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 abstractmethod
|
|
from components_library.isas import ISA
|
|
from components_library.processors.cpu_types import CPUTypes
|
|
from components_library.processors.abstract_core import AbstractCore
|
|
|
|
from m5.objects import L1Cache_Controller
|
|
|
|
import math
|
|
|
|
|
|
class AbstractL1Cache(L1Cache_Controller):
|
|
|
|
_version = 0
|
|
|
|
@classmethod
|
|
def versionCount(cls):
|
|
cls._version += 1 # Use count for this particular type
|
|
return cls._version - 1
|
|
|
|
# TODO: I don't love that we have to pass in the cache line size.
|
|
# However, we need some way to set the index bits
|
|
def __init__(self, network, cache_line_size):
|
|
""" """
|
|
super(AbstractL1Cache, self).__init__()
|
|
|
|
self.version = self.versionCount()
|
|
self._cache_line_size = cache_line_size
|
|
self.connectQueues(network)
|
|
|
|
def getBlockSizeBits(self):
|
|
bits = int(math.log(self._cache_line_size, 2))
|
|
if 2 ** bits != self._cache_line_size.value:
|
|
raise Exception("Cache line size not a power of 2!")
|
|
return bits
|
|
|
|
def sendEvicts(self, core: AbstractCore, target_isa: ISA):
|
|
"""True if the CPU model or ISA requires sending evictions from caches
|
|
to the CPU. Two scenarios warrant forwarding evictions to the CPU:
|
|
1. The O3 model must keep the LSQ coherent with the caches
|
|
2. The x86 mwait instruction is built on top of coherence
|
|
3. The local exclusive monitor in ARM systems
|
|
"""
|
|
if core.get_type() is CPUTypes.O3 or target_isa in (ISA.X86, ISA.ARM):
|
|
return True
|
|
return False
|
|
|
|
@abstractmethod
|
|
def connectQueues(self, network):
|
|
"""Connect all of the queues for this controller."""
|
|
raise NotImplementedError
|