MessageBuffer.py revision 13062:6f9defe1c11e 
1# Copyright (c) 2015 Mark D. Hill and David A. Wood.
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26#
27# Authors: Joel Hestness
28
29from m5.params import *
30from m5.proxy import *
31from m5.SimObject import SimObject
32
33class MessageBuffer(SimObject):
34    type = 'MessageBuffer'
35    cxx_class = 'MessageBuffer'
36    cxx_header = "mem/ruby/network/MessageBuffer.hh"
37    ordered = Param.Bool(False, "Whether the buffer is ordered")
38    buffer_size = Param.Unsigned(0, "Maximum number of entries to buffer \
39                                     (0 allows infinite entries)")
40    randomization = Param.Bool(False, "Insert random delays on message \
41                                       enqueue times (enforced to have \
42                                       random delays if RubySystem \
43                                       randomization flag is True)")
44
45    master = MasterPort("Master port to MessageBuffer receiver")
46    slave = SlavePort("Slave port from MessageBuffer sender")
47