Ruby.py (10004:5d8b72563869) Ruby.py (10012:ec5a5bfb941d)
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 # By default, ruby uses the simple timing cpu
49 parser.set_defaults(cpu_type="timing")
50
51 parser.add_option("--ruby-clock", action="store", type="string",
52 default='2GHz',
53 help="Clock for blocks running at Ruby system's speed")
54
55 # Options related to cache structure
56 parser.add_option("--ports", action="store", type="int", default=4,
57 help="used of transitions per cycle which is a proxy \
58 for the number of ports.")
59
60 # ruby network options
61 parser.add_option("--topology", type="string", default="Crossbar",
62 help="check src/mem/ruby/network/topologies for complete set")
63 parser.add_option("--mesh-rows", type="int", default=1,
64 help="the number of rows in the mesh topology")
65 parser.add_option("--garnet-network", type="choice",
66 choices=['fixed', 'flexible'], help="'fixed'|'flexible'")
67 parser.add_option("--network-fault-model", action="store_true", default=False,
68 help="enable network fault model: see src/mem/ruby/network/fault_model/")
69
70 # ruby mapping options
71 parser.add_option("--numa-high-bit", type="int", default=0,
72 help="high order address bit to use for numa mapping. " \
73 "0 = highest bit, not specified = lowest bit")
74
75 # ruby sparse memory options
76 parser.add_option("--use-map", action="store_true", default=False)
77 parser.add_option("--map-levels", type="int", default=4)
78
79 parser.add_option("--recycle-latency", type="int", default=10,
80 help="Recycle latency for ruby controller input buffers")
81
82 parser.add_option("--random_seed", type="int", default=1234,
83 help="Used for seeding the random number generator")
84
85 parser.add_option("--ruby_stats", type="string", default="ruby.stats")
86
87 protocol = buildEnv['PROTOCOL']
88 exec "import %s" % protocol
89 eval("%s.define_options(parser)" % protocol)
90
91def create_topology(controllers, options):
92 """ Called from create_system in configs/ruby/<protocol>.py
93 Must return an object which is a subclass of BaseTopology
94 found in configs/topologies/BaseTopology.py
95 This is a wrapper for the legacy topologies.
96 """
97 exec "import %s as Topo" % options.topology
98 topology = eval("Topo.%s(controllers)" % options.topology)
99 return topology
100
101def create_system(options, system, piobus = None, dma_ports = []):
102
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 # By default, ruby uses the simple timing cpu
49 parser.set_defaults(cpu_type="timing")
50
51 parser.add_option("--ruby-clock", action="store", type="string",
52 default='2GHz',
53 help="Clock for blocks running at Ruby system's speed")
54
55 # Options related to cache structure
56 parser.add_option("--ports", action="store", type="int", default=4,
57 help="used of transitions per cycle which is a proxy \
58 for the number of ports.")
59
60 # ruby network options
61 parser.add_option("--topology", type="string", default="Crossbar",
62 help="check src/mem/ruby/network/topologies for complete set")
63 parser.add_option("--mesh-rows", type="int", default=1,
64 help="the number of rows in the mesh topology")
65 parser.add_option("--garnet-network", type="choice",
66 choices=['fixed', 'flexible'], help="'fixed'|'flexible'")
67 parser.add_option("--network-fault-model", action="store_true", default=False,
68 help="enable network fault model: see src/mem/ruby/network/fault_model/")
69
70 # ruby mapping options
71 parser.add_option("--numa-high-bit", type="int", default=0,
72 help="high order address bit to use for numa mapping. " \
73 "0 = highest bit, not specified = lowest bit")
74
75 # ruby sparse memory options
76 parser.add_option("--use-map", action="store_true", default=False)
77 parser.add_option("--map-levels", type="int", default=4)
78
79 parser.add_option("--recycle-latency", type="int", default=10,
80 help="Recycle latency for ruby controller input buffers")
81
82 parser.add_option("--random_seed", type="int", default=1234,
83 help="Used for seeding the random number generator")
84
85 parser.add_option("--ruby_stats", type="string", default="ruby.stats")
86
87 protocol = buildEnv['PROTOCOL']
88 exec "import %s" % protocol
89 eval("%s.define_options(parser)" % protocol)
90
91def create_topology(controllers, options):
92 """ Called from create_system in configs/ruby/<protocol>.py
93 Must return an object which is a subclass of BaseTopology
94 found in configs/topologies/BaseTopology.py
95 This is a wrapper for the legacy topologies.
96 """
97 exec "import %s as Topo" % options.topology
98 topology = eval("Topo.%s(controllers)" % options.topology)
99 return topology
100
101def create_system(options, system, piobus = None, dma_ports = []):
102
103 system.ruby = RubySystem(stats_filename = options.ruby_stats,
104 no_mem_vec = options.use_map)
103 system.ruby = RubySystem(no_mem_vec = options.use_map)
105 ruby = system.ruby
106
107 protocol = buildEnv['PROTOCOL']
108 exec "import %s" % protocol
109 try:
110 (cpu_sequencers, dir_cntrls, topology) = \
111 eval("%s.create_system(options, system, piobus, dma_ports, ruby)"
112 % protocol)
113 except:
114 print "Error: could not create sytem for ruby protocol %s" % protocol
115 raise
116
117 # Create a port proxy for connecting the system port. This is
118 # independent of the protocol and kept in the protocol-agnostic
119 # part (i.e. here).
120 sys_port_proxy = RubyPortProxy(ruby_system = ruby)
121 # Give the system port proxy a SimObject parent without creating a
122 # full-fledged controller
123 system.sys_port_proxy = sys_port_proxy
124
125 # Connect the system port for loading of binaries etc
126 system.system_port = system.sys_port_proxy.slave
127
128
129 #
130 # Set the network classes based on the command line options
131 #
132 if options.garnet_network == "fixed":
133 class NetworkClass(GarnetNetwork_d): pass
134 class IntLinkClass(GarnetIntLink_d): pass
135 class ExtLinkClass(GarnetExtLink_d): pass
136 class RouterClass(GarnetRouter_d): pass
137 elif options.garnet_network == "flexible":
138 class NetworkClass(GarnetNetwork): pass
139 class IntLinkClass(GarnetIntLink): pass
140 class ExtLinkClass(GarnetExtLink): pass
141 class RouterClass(GarnetRouter): pass
142 else:
143 class NetworkClass(SimpleNetwork): pass
144 class IntLinkClass(SimpleIntLink): pass
145 class ExtLinkClass(SimpleExtLink): pass
146 class RouterClass(Switch): pass
147
148
149 # Create the network topology
150 network = NetworkClass(ruby_system = ruby, topology = topology.description,
151 routers = [], ext_links = [], int_links = [])
152 topology.makeTopology(options, network, IntLinkClass, ExtLinkClass,
153 RouterClass)
154
155 if options.network_fault_model:
156 assert(options.garnet_network == "fixed")
157 network.enable_fault_model = True
158 network.fault_model = FaultModel()
159
160 #
161 # Loop through the directory controlers.
162 # Determine the total memory size of the ruby system and verify it is equal
163 # to physmem. However, if Ruby memory is using sparse memory in SE
164 # mode, then the system should not back-up the memory state with
165 # the Memory Vector and thus the memory size bytes should stay at 0.
166 # Also set the numa bits to the appropriate values.
167 #
168 total_mem_size = MemorySize('0B')
169
170 ruby.block_size_bytes = options.cacheline_size
171 block_size_bits = int(math.log(options.cacheline_size, 2))
172
173 if options.numa_high_bit:
174 numa_bit = options.numa_high_bit
175 else:
176 # if the numa_bit is not specified, set the directory bits as the
177 # lowest bits above the block offset bits, and the numa_bit as the
178 # highest of those directory bits
179 dir_bits = int(math.log(options.num_dirs, 2))
180 numa_bit = block_size_bits + dir_bits - 1
181
182 for dir_cntrl in dir_cntrls:
183 total_mem_size.value += dir_cntrl.directory.size.value
184 dir_cntrl.directory.numa_high_bit = numa_bit
185
186 phys_mem_size = sum(map(lambda r: r.size(), system.mem_ranges))
187 assert(total_mem_size.value == phys_mem_size)
188
104 ruby = system.ruby
105
106 protocol = buildEnv['PROTOCOL']
107 exec "import %s" % protocol
108 try:
109 (cpu_sequencers, dir_cntrls, topology) = \
110 eval("%s.create_system(options, system, piobus, dma_ports, ruby)"
111 % protocol)
112 except:
113 print "Error: could not create sytem for ruby protocol %s" % protocol
114 raise
115
116 # Create a port proxy for connecting the system port. This is
117 # independent of the protocol and kept in the protocol-agnostic
118 # part (i.e. here).
119 sys_port_proxy = RubyPortProxy(ruby_system = ruby)
120 # Give the system port proxy a SimObject parent without creating a
121 # full-fledged controller
122 system.sys_port_proxy = sys_port_proxy
123
124 # Connect the system port for loading of binaries etc
125 system.system_port = system.sys_port_proxy.slave
126
127
128 #
129 # Set the network classes based on the command line options
130 #
131 if options.garnet_network == "fixed":
132 class NetworkClass(GarnetNetwork_d): pass
133 class IntLinkClass(GarnetIntLink_d): pass
134 class ExtLinkClass(GarnetExtLink_d): pass
135 class RouterClass(GarnetRouter_d): pass
136 elif options.garnet_network == "flexible":
137 class NetworkClass(GarnetNetwork): pass
138 class IntLinkClass(GarnetIntLink): pass
139 class ExtLinkClass(GarnetExtLink): pass
140 class RouterClass(GarnetRouter): pass
141 else:
142 class NetworkClass(SimpleNetwork): pass
143 class IntLinkClass(SimpleIntLink): pass
144 class ExtLinkClass(SimpleExtLink): pass
145 class RouterClass(Switch): pass
146
147
148 # Create the network topology
149 network = NetworkClass(ruby_system = ruby, topology = topology.description,
150 routers = [], ext_links = [], int_links = [])
151 topology.makeTopology(options, network, IntLinkClass, ExtLinkClass,
152 RouterClass)
153
154 if options.network_fault_model:
155 assert(options.garnet_network == "fixed")
156 network.enable_fault_model = True
157 network.fault_model = FaultModel()
158
159 #
160 # Loop through the directory controlers.
161 # Determine the total memory size of the ruby system and verify it is equal
162 # to physmem. However, if Ruby memory is using sparse memory in SE
163 # mode, then the system should not back-up the memory state with
164 # the Memory Vector and thus the memory size bytes should stay at 0.
165 # Also set the numa bits to the appropriate values.
166 #
167 total_mem_size = MemorySize('0B')
168
169 ruby.block_size_bytes = options.cacheline_size
170 block_size_bits = int(math.log(options.cacheline_size, 2))
171
172 if options.numa_high_bit:
173 numa_bit = options.numa_high_bit
174 else:
175 # if the numa_bit is not specified, set the directory bits as the
176 # lowest bits above the block offset bits, and the numa_bit as the
177 # highest of those directory bits
178 dir_bits = int(math.log(options.num_dirs, 2))
179 numa_bit = block_size_bits + dir_bits - 1
180
181 for dir_cntrl in dir_cntrls:
182 total_mem_size.value += dir_cntrl.directory.size.value
183 dir_cntrl.directory.numa_high_bit = numa_bit
184
185 phys_mem_size = sum(map(lambda r: r.size(), system.mem_ranges))
186 assert(total_mem_size.value == phys_mem_size)
187
189 ruby_profiler = RubyProfiler(ruby_system = ruby,
190 num_of_sequencers = len(cpu_sequencers))
191 ruby.network = network
188 ruby.network = network
192 ruby.profiler = ruby_profiler
193 ruby.mem_size = total_mem_size
194 ruby._cpu_ruby_ports = cpu_sequencers
189 ruby.mem_size = total_mem_size
190 ruby._cpu_ruby_ports = cpu_sequencers
191 ruby.num_of_sequencers = len(cpu_sequencers)
195 ruby.random_seed = options.random_seed
192 ruby.random_seed = options.random_seed