1 # Copyright (c) 2012, 2017-2018 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 from __future__
import print_function
44 from m5
.objects
import *
45 from m5
.defines
import buildEnv
46 from m5
.util
import addToPath
, fatal
50 from common
import ObjectList
51 from common
import MemConfig
52 from common
import FileSystemConfig
54 from topologies
import *
55 from network
import Network
57 def define_options(parser
):
58 # By default, ruby uses the simple timing cpu
59 parser
.set_defaults(cpu_type
="TimingSimpleCPU")
61 parser
.add_option("--ruby-clock", action
="store", type="string",
63 help="Clock for blocks running at Ruby system's speed")
65 parser
.add_option("--access-backing-store", action
="store_true", default
=False,
66 help="Should ruby maintain a second copy of memory")
68 # Options related to cache structure
69 parser
.add_option("--ports", action
="store", type="int", default
=4,
70 help="used of transitions per cycle which is a proxy \
71 for the number of ports.")
73 # network options are in network/Network.py
75 # ruby mapping options
76 parser
.add_option("--numa-high-bit", type="int", default
=0,
77 help="high order address bit to use for numa mapping. " \
78 "0 = highest bit, not specified = lowest bit")
79 parser
.add_option("--interleaving-bits", type="int", default
=0,
80 help="number of bits to specify interleaving " \
81 "in directory, memory controllers and caches. "
83 parser
.add_option("--xor-low-bit", type="int", default
=20,
84 help="hashing bit for channel selection" \
85 "see MemConfig for explanation of the default"\
86 "parameter. If set to 0, xor_high_bit is also"\
89 parser
.add_option("--recycle-latency", type="int", default
=10,
90 help="Recycle latency for ruby controller input buffers")
92 protocol
= buildEnv
['PROTOCOL']
93 exec("from . import %s" % protocol
)
94 eval("%s.define_options(parser)" % protocol
)
95 Network
.define_options(parser
)
97 def setup_memory_controllers(system
, ruby
, dir_cntrls
, options
):
98 if (options
.numa_high_bit
):
99 block_size_bits
= options
.numa_high_bit
+ 1 - \
100 int(math
.log(options
.num_dirs
, 2))
101 ruby
.block_size_bytes
= 2 ** (block_size_bits
)
103 ruby
.block_size_bytes
= options
.cacheline_size
105 ruby
.memory_size_bits
= 48
111 if options
.numa_high_bit
:
112 dir_bits
= int(math
.log(options
.num_dirs
, 2))
113 intlv_size
= 2 ** (options
.numa_high_bit
- dir_bits
+ 1)
115 # if the numa_bit is not specified, set the directory bits as the
116 # lowest bits above the block offset bits
117 intlv_size
= options
.cacheline_size
119 # Sets bits to be used for interleaving. Creates memory controllers
120 # attached to a directory controller. A separate controller is created
121 # for each address range as the abstract memory can handle only one
122 # contiguous address range as of now.
123 for dir_cntrl
in dir_cntrls
:
125 if len(system
.mem_ranges
) > 1:
127 crossbars
.append(crossbar
)
128 dir_cntrl
.memory
= crossbar
.slave
131 for r
in system
.mem_ranges
:
132 mem_type
= ObjectList
.mem_list
.get(options
.mem_type
)
133 dram_intf
= MemConfig
.create_mem_intf(mem_type
, r
, index
,
134 options
.num_dirs
, int(math
.log(options
.num_dirs
, 2)),
135 intlv_size
, options
.xor_low_bit
)
136 mem_ctrl
= m5
.objects
.MemCtrl(dram
= dram_intf
)
138 if options
.access_backing_store
:
139 dram_intf
.kvm_map
=False
141 mem_ctrls
.append(mem_ctrl
)
142 dir_ranges
.append(mem_ctrl
.dram
.range)
145 mem_ctrl
.port
= crossbar
.master
147 mem_ctrl
.port
= dir_cntrl
.memory
149 # Enable low-power DRAM states if option is set
150 if issubclass(mem_type
, DRAMInterface
):
151 mem_ctrl
.dram
.enable_dram_powerdown
= \
152 options
.enable_dram_powerdown
155 dir_cntrl
.addr_ranges
= dir_ranges
157 system
.mem_ctrls
= mem_ctrls
159 if len(crossbars
) > 0:
160 ruby
.crossbars
= crossbars
163 def create_topology(controllers
, options
):
164 """ Called from create_system in configs/ruby/<protocol>.py
165 Must return an object which is a subclass of BaseTopology
166 found in configs/topologies/BaseTopology.py
167 This is a wrapper for the legacy topologies.
169 exec("import topologies.%s as Topo" % options
.topology
)
170 topology
= eval("Topo.%s(controllers)" % options
.topology
)
173 def create_system(options
, full_system
, system
, piobus
= None, dma_ports
= [],
176 system
.ruby
= RubySystem()
179 # Generate pseudo filesystem
180 FileSystemConfig
.config_filesystem(system
, options
)
182 # Create the network object
183 (network
, IntLinkClass
, ExtLinkClass
, RouterClass
, InterfaceClass
) = \
184 Network
.create_network(options
, ruby
)
185 ruby
.network
= network
187 protocol
= buildEnv
['PROTOCOL']
188 exec("from . import %s" % protocol
)
190 (cpu_sequencers
, dir_cntrls
, topology
) = \
191 eval("%s.create_system(options, full_system, system, dma_ports,\
195 print("Error: could not create sytem for ruby protocol %s" % protocol
)
198 # Create the network topology
199 topology
.makeTopology(options
, network
, IntLinkClass
, ExtLinkClass
,
202 # Register the topology elements with faux filesystem (SE mode only)
204 topology
.registerTopology(options
)
207 # Initialize network based on topology
208 Network
.init_network(options
, network
, InterfaceClass
)
210 # Create a port proxy for connecting the system port. This is
211 # independent of the protocol and kept in the protocol-agnostic
213 sys_port_proxy
= RubyPortProxy(ruby_system
= ruby
)
214 if piobus
is not None:
215 sys_port_proxy
.pio_master_port
= piobus
.slave
217 # Give the system port proxy a SimObject parent without creating a
218 # full-fledged controller
219 system
.sys_port_proxy
= sys_port_proxy
221 # Connect the system port for loading of binaries etc
222 system
.system_port
= system
.sys_port_proxy
.slave
224 setup_memory_controllers(system
, ruby
, dir_cntrls
, options
)
226 # Connect the cpu sequencers and the piobus
228 for cpu_seq
in cpu_sequencers
:
229 cpu_seq
.connectIOPorts(piobus
)
231 ruby
.number_of_virtual_networks
= ruby
.network
.number_of_virtual_networks
232 ruby
._cpu
_ports
= cpu_sequencers
233 ruby
.num_of_sequencers
= len(cpu_sequencers
)
235 # Create a backing copy of physical memory in case required
236 if options
.access_backing_store
:
237 ruby
.access_backing_store
= True
238 ruby
.phys_mem
= SimpleMemory(range=system
.mem_ranges
[0],
241 def create_directories(options
, bootmem
, ruby_system
, system
):
243 for i
in range(options
.num_dirs
):
244 dir_cntrl
= Directory_Controller()
245 dir_cntrl
.version
= i
246 dir_cntrl
.directory
= RubyDirectoryMemory()
247 dir_cntrl
.ruby_system
= ruby_system
249 exec("ruby_system.dir_cntrl%d = dir_cntrl" % i
)
250 dir_cntrl_nodes
.append(dir_cntrl
)
252 if bootmem
is not None:
253 rom_dir_cntrl
= Directory_Controller()
254 rom_dir_cntrl
.directory
= RubyDirectoryMemory()
255 rom_dir_cntrl
.ruby_system
= ruby_system
256 rom_dir_cntrl
.version
= i
+ 1
257 rom_dir_cntrl
.memory
= bootmem
.port
258 rom_dir_cntrl
.addr_ranges
= bootmem
.range
259 return (dir_cntrl_nodes
, rom_dir_cntrl
)
261 return (dir_cntrl_nodes
, None)
263 def send_evicts(options
):
264 # currently, 2 scenarios warrant forwarding evictions to the CPU:
265 # 1. The O3 model must keep the LSQ coherent with the caches
266 # 2. The x86 mwait instruction is built on top of coherence invalidations
267 # 3. The local exclusive monitor in ARM systems
268 if options
.cpu_type
== "DerivO3CPU" or \
269 buildEnv
['TARGET_ISA'] in ('x86', 'arm'):