87939fac88dfae8883ff2af4d9fadd1a8a88b35d
1 # Copyright (c) 2012 ARM Limited
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.
13 # Copyright (c) 2006-2007 The Regents of The University of Michigan
14 # Copyright (c) 2009 Advanced Micro Devices, Inc.
15 # All rights reserved.
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.
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.
40 # Authors: Brad Beckmann
44 from m5
.objects
import *
45 from m5
.defines
import buildEnv
47 def define_options(parser
):
48 # By default, ruby uses the simple timing cpu
49 parser
.set_defaults(cpu_type
="timing")
51 # ruby network options
52 parser
.add_option("--topology", type="string", default
="Crossbar",
53 help="check src/mem/ruby/network/topologies for complete set")
54 parser
.add_option("--mesh-rows", type="int", default
=1,
55 help="the number of rows in the mesh topology")
56 parser
.add_option("--garnet-network", type="string", default
=None,
57 help="'fixed'|'flexible'")
58 parser
.add_option("--network-fault-model", action
="store_true", default
=False,
59 help="enable network fault model: see src/mem/ruby/network/fault_model/")
61 # ruby mapping options
62 parser
.add_option("--numa-high-bit", type="int", default
=0,
63 help="high order address bit to use for numa mapping. " \
64 "0 = highest bit, not specified = lowest bit")
66 # ruby sparse memory options
67 parser
.add_option("--use-map", action
="store_true", default
=False)
68 parser
.add_option("--map-levels", type="int", default
=4)
70 parser
.add_option("--recycle-latency", type="int", default
=10,
71 help="Recycle latency for ruby controller input buffers")
73 parser
.add_option("--random_seed", type="int", default
=1234,
74 help="Used for seeding the random number generator")
76 parser
.add_option("--ruby_stats", type="string", default
="ruby.stats")
78 protocol
= buildEnv
['PROTOCOL']
79 exec "import %s" % protocol
80 eval("%s.define_options(parser)" % protocol
)
82 def create_system(options
, system
, piobus
= None, dma_ports
= []):
84 system
.ruby
= RubySystem(clock
= options
.clock
,
85 stats_filename
= options
.ruby_stats
,
86 no_mem_vec
= options
.use_map
)
89 protocol
= buildEnv
['PROTOCOL']
90 exec "import %s" % protocol
92 (cpu_sequencers
, dir_cntrls
, all_cntrls
) = \
93 eval("%s.create_system(options, system, piobus, dma_ports, ruby)"
96 print "Error: could not create sytem for ruby protocol %s" % protocol
99 # Create a port proxy for connecting the system port. This is
100 # independent of the protocol and kept in the protocol-agnostic
102 sys_port_proxy
= RubyPortProxy(ruby_system
= ruby
)
103 # Give the system port proxy a SimObject parent without creating a
104 # full-fledged controller
105 system
.sys_port_proxy
= sys_port_proxy
107 # Connect the system port for loading of binaries etc
108 system
.system_port
= system
.sys_port_proxy
.slave
112 # Set the network classes based on the command line options
114 if options
.garnet_network
== "fixed":
115 class NetworkClass(GarnetNetwork_d
): pass
116 class IntLinkClass(GarnetIntLink_d
): pass
117 class ExtLinkClass(GarnetExtLink_d
): pass
118 class RouterClass(GarnetRouter_d
): pass
119 elif options
.garnet_network
== "flexible":
120 class NetworkClass(GarnetNetwork
): pass
121 class IntLinkClass(GarnetIntLink
): pass
122 class ExtLinkClass(GarnetExtLink
): pass
123 class RouterClass(GarnetRouter
): pass
125 class NetworkClass(SimpleNetwork
): pass
126 class IntLinkClass(SimpleIntLink
): pass
127 class ExtLinkClass(SimpleExtLink
): pass
128 class RouterClass(BasicRouter
): pass
131 # Important: the topology must be created before the network and after the
134 exec "import %s" % options
.topology
136 net_topology
= eval("%s.makeTopology(all_cntrls, options, \
137 IntLinkClass, ExtLinkClass, \
141 print "Error: could not create topology %s" % options
.topology
144 if options
.network_fault_model
:
145 assert(options
.garnet_network
== "fixed")
146 fault_model
= FaultModel()
147 network
= NetworkClass(ruby_system
= ruby
, topology
= net_topology
,\
148 enable_fault_model
=True, fault_model
= fault_model
)
150 network
= NetworkClass(ruby_system
= ruby
, topology
= net_topology
)
153 # Loop through the directory controlers.
154 # Determine the total memory size of the ruby system and verify it is equal
155 # to physmem. However, if Ruby memory is using sparse memory in SE
156 # mode, then the system should not back-up the memory state with
157 # the Memory Vector and thus the memory size bytes should stay at 0.
158 # Also set the numa bits to the appropriate values.
160 total_mem_size
= MemorySize('0B')
162 dir_bits
= int(math
.log(options
.num_dirs
, 2))
164 if options
.numa_high_bit
:
165 numa_bit
= options
.numa_high_bit
167 # if not specified, use the lowest bits above the block offest
169 # add 5 because bits 0-5 are the block offset
170 numa_bit
= dir_bits
+ 5
174 for dir_cntrl
in dir_cntrls
:
175 total_mem_size
.value
+= dir_cntrl
.directory
.size
.value
176 dir_cntrl
.directory
.numa_high_bit
= numa_bit
179 for mem
in system
.memories
.unproxy(system
):
180 phys_mem_size
+= long(mem
.range.second
) - long(mem
.range.first
) + 1
181 assert(total_mem_size
.value
== phys_mem_size
)
183 ruby_profiler
= RubyProfiler(ruby_system
= ruby
,
184 num_of_sequencers
= len(cpu_sequencers
))
185 ruby
.network
= network
186 ruby
.profiler
= ruby_profiler
187 ruby
.mem_size
= total_mem_size
188 ruby
._cpu
_ruby
_ports
= cpu_sequencers
189 ruby
.random_seed
= options
.random_seed