Ruby.py (8923:820111f58fbb) Ruby.py (8929:4148f9af0b70)
1# Copyright (c) 2012 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder. You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Copyright (c) 2006-2007 The Regents of The University of Michigan
14# Copyright (c) 2009 Advanced Micro Devices, Inc.
15# All rights reserved.
16#
17# Redistribution and use in source and binary forms, with or without
18# modification, are permitted provided that the following conditions are
19# met: redistributions of source code must retain the above copyright
20# notice, this list of conditions and the following disclaimer;
21# redistributions in binary form must reproduce the above copyright
22# notice, this list of conditions and the following disclaimer in the
23# documentation and/or other materials provided with the distribution;
24# neither the name of the copyright holders nor the names of its
25# contributors may be used to endorse or promote products derived from
26# this software without specific prior written permission.
27#
28# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39#
40# Authors: Brad Beckmann
41
42import math
43import m5
44from m5.objects import *
45from m5.defines import buildEnv
46
47def define_options(parser):
48 # ruby network options
49 parser.add_option("--topology", type="string", default="Crossbar",
50 help="check src/mem/ruby/network/topologies for complete set")
51 parser.add_option("--mesh-rows", type="int", default=1,
52 help="the number of rows in the mesh topology")
53 parser.add_option("--garnet-network", type="string", default=None,
54 help="'fixed'|'flexible'")
55 parser.add_option("--network-fault-model", action="store_true", default=False,
56 help="enable network fault model: see src/mem/ruby/network/fault_model/")
57
58 # ruby mapping options
59 parser.add_option("--numa-high-bit", type="int", default=0,
60 help="high order address bit to use for numa mapping. " \
61 "0 = highest bit, not specified = lowest bit")
62
63 # ruby sparse memory options
64 parser.add_option("--use-map", action="store_true", default=False)
65 parser.add_option("--map-levels", type="int", default=4)
66
67 parser.add_option("--recycle-latency", type="int", default=10,
68 help="Recycle latency for ruby controller input buffers")
69
70 parser.add_option("--random_seed", type="int", default=1234,
71 help="Used for seeding the random number generator")
72
73 parser.add_option("--ruby_stats", type="string", default="ruby.stats")
74
75 protocol = buildEnv['PROTOCOL']
76 exec "import %s" % protocol
77 eval("%s.define_options(parser)" % protocol)
78
1# Copyright (c) 2012 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder. You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Copyright (c) 2006-2007 The Regents of The University of Michigan
14# Copyright (c) 2009 Advanced Micro Devices, Inc.
15# All rights reserved.
16#
17# Redistribution and use in source and binary forms, with or without
18# modification, are permitted provided that the following conditions are
19# met: redistributions of source code must retain the above copyright
20# notice, this list of conditions and the following disclaimer;
21# redistributions in binary form must reproduce the above copyright
22# notice, this list of conditions and the following disclaimer in the
23# documentation and/or other materials provided with the distribution;
24# neither the name of the copyright holders nor the names of its
25# contributors may be used to endorse or promote products derived from
26# this software without specific prior written permission.
27#
28# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39#
40# Authors: Brad Beckmann
41
42import math
43import m5
44from m5.objects import *
45from m5.defines import buildEnv
46
47def define_options(parser):
48 # ruby network options
49 parser.add_option("--topology", type="string", default="Crossbar",
50 help="check src/mem/ruby/network/topologies for complete set")
51 parser.add_option("--mesh-rows", type="int", default=1,
52 help="the number of rows in the mesh topology")
53 parser.add_option("--garnet-network", type="string", default=None,
54 help="'fixed'|'flexible'")
55 parser.add_option("--network-fault-model", action="store_true", default=False,
56 help="enable network fault model: see src/mem/ruby/network/fault_model/")
57
58 # ruby mapping options
59 parser.add_option("--numa-high-bit", type="int", default=0,
60 help="high order address bit to use for numa mapping. " \
61 "0 = highest bit, not specified = lowest bit")
62
63 # ruby sparse memory options
64 parser.add_option("--use-map", action="store_true", default=False)
65 parser.add_option("--map-levels", type="int", default=4)
66
67 parser.add_option("--recycle-latency", type="int", default=10,
68 help="Recycle latency for ruby controller input buffers")
69
70 parser.add_option("--random_seed", type="int", default=1234,
71 help="Used for seeding the random number generator")
72
73 parser.add_option("--ruby_stats", type="string", default="ruby.stats")
74
75 protocol = buildEnv['PROTOCOL']
76 exec "import %s" % protocol
77 eval("%s.define_options(parser)" % protocol)
78
79def create_system(options, system, piobus = None, dma_devices = []):
79def create_system(options, system, piobus = None, dma_ports = []):
80
81 system.ruby = RubySystem(clock = options.clock,
82 stats_filename = options.ruby_stats,
83 no_mem_vec = options.use_map)
84 ruby = system.ruby
85
86 protocol = buildEnv['PROTOCOL']
87 exec "import %s" % protocol
88 try:
89 (cpu_sequencers, dir_cntrls, all_cntrls) = \
80
81 system.ruby = RubySystem(clock = options.clock,
82 stats_filename = options.ruby_stats,
83 no_mem_vec = options.use_map)
84 ruby = system.ruby
85
86 protocol = buildEnv['PROTOCOL']
87 exec "import %s" % protocol
88 try:
89 (cpu_sequencers, dir_cntrls, all_cntrls) = \
90 eval("%s.create_system(options, system, piobus, \
91 dma_devices, ruby)" \
90 eval("%s.create_system(options, system, piobus, dma_ports, ruby)"
92 % protocol)
93 except:
94 print "Error: could not create sytem for ruby protocol %s" % protocol
95 raise
96
97 # Create a port proxy for connecting the system port. This is
98 # independent of the protocol and kept in the protocol-agnostic
99 # part (i.e. here).
100 sys_port_proxy = RubyPortProxy(ruby_system = ruby)
101 # Give the system port proxy a SimObject parent without creating a
102 # full-fledged controller
103 system.sys_port_proxy = sys_port_proxy
104
105 # Connect the system port for loading of binaries etc
106 system.system_port = system.sys_port_proxy.slave
107
108
109 #
110 # Set the network classes based on the command line options
111 #
112 if options.garnet_network == "fixed":
113 class NetworkClass(GarnetNetwork_d): pass
114 class IntLinkClass(GarnetIntLink_d): pass
115 class ExtLinkClass(GarnetExtLink_d): pass
116 class RouterClass(GarnetRouter_d): pass
117 elif options.garnet_network == "flexible":
118 class NetworkClass(GarnetNetwork): pass
119 class IntLinkClass(GarnetIntLink): pass
120 class ExtLinkClass(GarnetExtLink): pass
121 class RouterClass(GarnetRouter): pass
122 else:
123 class NetworkClass(SimpleNetwork): pass
124 class IntLinkClass(SimpleIntLink): pass
125 class ExtLinkClass(SimpleExtLink): pass
126 class RouterClass(BasicRouter): pass
127
128 #
129 # Important: the topology must be created before the network and after the
130 # controllers.
131 #
132 exec "import %s" % options.topology
133 try:
134 net_topology = eval("%s.makeTopology(all_cntrls, options, \
135 IntLinkClass, ExtLinkClass, \
136 RouterClass)" \
137 % options.topology)
138 except:
139 print "Error: could not create topology %s" % options.topology
140 raise
141
142 if options.network_fault_model:
143 assert(options.garnet_network == "fixed")
144 fault_model = FaultModel()
145 network = NetworkClass(ruby_system = ruby, topology = net_topology,\
146 enable_fault_model=True, fault_model = fault_model)
147 else:
148 network = NetworkClass(ruby_system = ruby, topology = net_topology)
149
150 #
151 # Loop through the directory controlers.
152 # Determine the total memory size of the ruby system and verify it is equal
153 # to physmem. However, if Ruby memory is using sparse memory in SE
154 # mode, then the system should not back-up the memory state with
155 # the Memory Vector and thus the memory size bytes should stay at 0.
156 # Also set the numa bits to the appropriate values.
157 #
158 total_mem_size = MemorySize('0B')
159
160 dir_bits = int(math.log(options.num_dirs, 2))
161
162 if options.numa_high_bit:
163 numa_bit = options.numa_high_bit
164 else:
165 # if not specified, use the lowest bits above the block offest
166 if dir_bits > 0:
167 # add 5 because bits 0-5 are the block offset
168 numa_bit = dir_bits + 5
169 else:
170 numa_bit = 6
171
172 for dir_cntrl in dir_cntrls:
173 total_mem_size.value += dir_cntrl.directory.size.value
174 dir_cntrl.directory.numa_high_bit = numa_bit
175
176 physmem_size = long(system.physmem.range.second) - \
177 long(system.physmem.range.first) + 1
178 assert(total_mem_size.value == physmem_size)
179
180 ruby_profiler = RubyProfiler(ruby_system = ruby,
181 num_of_sequencers = len(cpu_sequencers))
182 ruby.network = network
183 ruby.profiler = ruby_profiler
184 ruby.mem_size = total_mem_size
185 ruby._cpu_ruby_ports = cpu_sequencers
186 ruby.random_seed = options.random_seed
91 % protocol)
92 except:
93 print "Error: could not create sytem for ruby protocol %s" % protocol
94 raise
95
96 # Create a port proxy for connecting the system port. This is
97 # independent of the protocol and kept in the protocol-agnostic
98 # part (i.e. here).
99 sys_port_proxy = RubyPortProxy(ruby_system = ruby)
100 # Give the system port proxy a SimObject parent without creating a
101 # full-fledged controller
102 system.sys_port_proxy = sys_port_proxy
103
104 # Connect the system port for loading of binaries etc
105 system.system_port = system.sys_port_proxy.slave
106
107
108 #
109 # Set the network classes based on the command line options
110 #
111 if options.garnet_network == "fixed":
112 class NetworkClass(GarnetNetwork_d): pass
113 class IntLinkClass(GarnetIntLink_d): pass
114 class ExtLinkClass(GarnetExtLink_d): pass
115 class RouterClass(GarnetRouter_d): pass
116 elif options.garnet_network == "flexible":
117 class NetworkClass(GarnetNetwork): pass
118 class IntLinkClass(GarnetIntLink): pass
119 class ExtLinkClass(GarnetExtLink): pass
120 class RouterClass(GarnetRouter): pass
121 else:
122 class NetworkClass(SimpleNetwork): pass
123 class IntLinkClass(SimpleIntLink): pass
124 class ExtLinkClass(SimpleExtLink): pass
125 class RouterClass(BasicRouter): pass
126
127 #
128 # Important: the topology must be created before the network and after the
129 # controllers.
130 #
131 exec "import %s" % options.topology
132 try:
133 net_topology = eval("%s.makeTopology(all_cntrls, options, \
134 IntLinkClass, ExtLinkClass, \
135 RouterClass)" \
136 % options.topology)
137 except:
138 print "Error: could not create topology %s" % options.topology
139 raise
140
141 if options.network_fault_model:
142 assert(options.garnet_network == "fixed")
143 fault_model = FaultModel()
144 network = NetworkClass(ruby_system = ruby, topology = net_topology,\
145 enable_fault_model=True, fault_model = fault_model)
146 else:
147 network = NetworkClass(ruby_system = ruby, topology = net_topology)
148
149 #
150 # Loop through the directory controlers.
151 # Determine the total memory size of the ruby system and verify it is equal
152 # to physmem. However, if Ruby memory is using sparse memory in SE
153 # mode, then the system should not back-up the memory state with
154 # the Memory Vector and thus the memory size bytes should stay at 0.
155 # Also set the numa bits to the appropriate values.
156 #
157 total_mem_size = MemorySize('0B')
158
159 dir_bits = int(math.log(options.num_dirs, 2))
160
161 if options.numa_high_bit:
162 numa_bit = options.numa_high_bit
163 else:
164 # if not specified, use the lowest bits above the block offest
165 if dir_bits > 0:
166 # add 5 because bits 0-5 are the block offset
167 numa_bit = dir_bits + 5
168 else:
169 numa_bit = 6
170
171 for dir_cntrl in dir_cntrls:
172 total_mem_size.value += dir_cntrl.directory.size.value
173 dir_cntrl.directory.numa_high_bit = numa_bit
174
175 physmem_size = long(system.physmem.range.second) - \
176 long(system.physmem.range.first) + 1
177 assert(total_mem_size.value == physmem_size)
178
179 ruby_profiler = RubyProfiler(ruby_system = ruby,
180 num_of_sequencers = len(cpu_sequencers))
181 ruby.network = network
182 ruby.profiler = ruby_profiler
183 ruby.mem_size = total_mem_size
184 ruby._cpu_ruby_ports = cpu_sequencers
185 ruby.random_seed = options.random_seed