garnet_synth_traffic.py revision 13731:67cd980cb20f 
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# Author: Tushar Krishna
28
29from __future__ import print_function
30
31import m5
32from m5.objects import *
33from m5.defines import buildEnv
34from m5.util import addToPath
35import os, optparse, sys
36
37addToPath('../')
38
39from common import Options
40from ruby import Ruby
41
42# Get paths we might need.  It's expected this file is in m5/configs/example.
43config_path = os.path.dirname(os.path.abspath(__file__))
44config_root = os.path.dirname(config_path)
45m5_root = os.path.dirname(config_root)
46
47parser = optparse.OptionParser()
48Options.addNoISAOptions(parser)
49
50parser.add_option("--synthetic", type="choice", default="uniform_random",
51                  choices=['uniform_random', 'tornado', 'bit_complement', \
52                           'bit_reverse', 'bit_rotation', 'neighbor', \
53                            'shuffle', 'transpose'])
54
55parser.add_option("-i", "--injectionrate", type="float", default=0.1,
56                  metavar="I",
57                  help="Injection rate in packets per cycle per node. \
58                        Takes decimal value between 0 to 1 (eg. 0.225). \
59                        Number of digits after 0 depends upon --precision.")
60
61parser.add_option("--precision", type="int", default=3,
62                  help="Number of digits of precision after decimal point\
63                        for injection rate")
64
65parser.add_option("--sim-cycles", type="int", default=1000,
66                   help="Number of simulation cycles")
67
68parser.add_option("--num-packets-max", type="int", default=-1,
69                  help="Stop injecting after --num-packets-max.\
70                        Set to -1 to disable.")
71
72parser.add_option("--single-sender-id", type="int", default=-1,
73                  help="Only inject from this sender.\
74                        Set to -1 to disable.")
75
76parser.add_option("--single-dest-id", type="int", default=-1,
77                  help="Only send to this destination.\
78                        Set to -1 to disable.")
79
80parser.add_option("--inj-vnet", type="int", default=-1,
81                  help="Only inject in this vnet (0, 1 or 2).\
82                        0 and 1 are 1-flit, 2 is 5-flit.\
83                        Set to -1 to inject randomly in all vnets.")
84
85#
86# Add the ruby specific and protocol specific options
87#
88Ruby.define_options(parser)
89
90exec(compile(open(os.path.join(config_root, "common", "Options.py")).read(),
91             os.path.join(config_root, "common", "Options.py"), 'exec'))
92
93(options, args) = parser.parse_args()
94
95if args:
96     print("Error: script doesn't take any positional arguments")
97     sys.exit(1)
98
99
100if options.inj_vnet > 2:
101    print("Error: Injection vnet %d should be 0 (1-flit), 1 (1-flit) "
102          "or 2 (5-flit) or -1 (random)" % (options.inj_vnet))
103    sys.exit(1)
104
105
106cpus = [ GarnetSyntheticTraffic(
107                     num_packets_max=options.num_packets_max,
108                     single_sender=options.single_sender_id,
109                     single_dest=options.single_dest_id,
110                     sim_cycles=options.sim_cycles,
111                     traffic_type=options.synthetic,
112                     inj_rate=options.injectionrate,
113                     inj_vnet=options.inj_vnet,
114                     precision=options.precision,
115                     num_dest=options.num_dirs) \
116         for i in range(options.num_cpus) ]
117
118# create the desired simulated system
119system = System(cpu = cpus, mem_ranges = [AddrRange(options.mem_size)])
120
121
122# Create a top-level voltage domain and clock domain
123system.voltage_domain = VoltageDomain(voltage = options.sys_voltage)
124
125system.clk_domain = SrcClockDomain(clock = options.sys_clock,
126                                   voltage_domain = system.voltage_domain)
127
128Ruby.create_system(options, False, system)
129
130# Create a seperate clock domain for Ruby
131system.ruby.clk_domain = SrcClockDomain(clock = options.ruby_clock,
132                                        voltage_domain = system.voltage_domain)
133
134i = 0
135for ruby_port in system.ruby._cpu_ports:
136     #
137     # Tie the cpu test ports to the ruby cpu port
138     #
139     cpus[i].test = ruby_port.slave
140     i += 1
141
142# -----------------------
143# run simulation
144# -----------------------
145
146root = Root(full_system = False, system = system)
147root.system.mem_mode = 'timing'
148
149# Not much point in this being higher than the L1 latency
150m5.ticks.setGlobalFrequency('1ns')
151
152# instantiate configuration
153m5.instantiate()
154
155# simulate until program terminates
156exit_event = m5.simulate(options.abs_max_tick)
157
158print('Exiting @ tick', m5.curTick(), 'because', exit_event.getCause())
159