xref: /gem5/src/mem/ruby/network/MessageBuffer.py

# Copyright (c) 2015 Mark D. Hill and David A. Wood.
# 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.
#
# Authors: Joel Hestness

from m5.params import *
from m5.proxy import *
from m5.SimObject import SimObject

class MessageBuffer(SimObject):
    type = 'MessageBuffer'
    cxx_class = 'MessageBuffer'
    cxx_header = "mem/ruby/network/MessageBuffer.hh"
    ordered = Param.Bool(False, "Whether the buffer is ordered")
    buffer_size = Param.Unsigned(0, "Maximum number of entries to buffer \
                                     (0 allows infinite entries)")
    randomization = Param.Bool(False, "Insert random delays on message \
                                       enqueue times (enforced to have \
                                       random delays if RubySystem \
                                       randomization flag is True)")

    master = MasterPort("Master port to MessageBuffer receiver")
    slave = SlavePort("Slave port from MessageBuffer sender")