1# Copyright (c) 2016 Georgia Institute of Technology
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: Tushar Krishna
28
29from m5.objects.ClockedObject import ClockedObject
30from m5.params import *
31from m5.proxy import *
32
33class GarnetSyntheticTraffic(ClockedObject):
34    type = 'GarnetSyntheticTraffic'
35    cxx_header = \
36        "cpu/testers/garnet_synthetic_traffic/GarnetSyntheticTraffic.hh"
37    block_offset = Param.Int(6, "block offset in bits")
38    num_dest = Param.Int(1, "Number of Destinations")
39    memory_size = Param.Int(65536, "memory size")
40    sim_cycles = Param.Int(1000, "Number of simulation cycles")
41    num_packets_max = Param.Int(-1, "Max number of packets to send. \
42                        Default is to keep sending till simulation ends")
43    single_sender = Param.Int(-1, "Send only from this node. \
44                                   By default every node sends")
45    single_dest = Param.Int(-1, "Send only to this dest. \
46                                 Default depends on traffic_type")
47    traffic_type = Param.String("uniform_random", "Traffic type")
48    inj_rate = Param.Float(0.1, "Packet injection rate")
49    inj_vnet = Param.Int(-1, "Vnet to inject in. \
50                              0 and 1 are 1-flit, 2 is 5-flit. \
51                                Default is to inject in all three vnets")
52    precision = Param.Int(3, "Number of digits of precision \
53                              after decimal point")
54    response_limit = Param.Cycles(5000000, "Cycles before exiting \
55                                            due to lack of progress")
56    test = MasterPort("Port to the memory system to test")
57    system = Param.System(Parent.any, "System we belong to")
58