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