src/python/gem5/components/processors/traffic_generator.py

# Copyright (c) 2022 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 ...utils.override import overrides
from .traffic_generator_core import TrafficGeneratorCore

from .abstract_generator import AbstractGenerator

from typing import List


class TrafficGenerator(AbstractGenerator):
    def __init__(
        self,
        config_file_list: List[str],
    ) -> None:
        super().__init__(
            cores=self._create_cores(config_file_list=config_file_list)
        )
        """The traffic generator

        This class defines an external interface to create a list of traffic
        generator cores that could replace the processing cores in a board.

        :param config_file_list: A list containing the path to configuration
        file each describing the traffic pattern that should be created by
        each core of the generator.
        """

    def _create_cores(
        self, config_file_list: List[str]
    ) -> List[TrafficGeneratorCore]:
        """
        The helper function to create the cores for the generator, it will use
        the same inputs as the constructor function.
        """
        return [
            TrafficGeneratorCore(config_file)
            for config_file in config_file_list
        ]

    @overrides(AbstractGenerator)
    def start_traffic(self) -> None:
        pass