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