1# Copyright (c) 2006-2007 The Regents of The University of Michigan
2# Copyright (c) 2009 Advanced Micro Devices, Inc.
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions are
7# met: redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer;
9# redistributions in binary form must reproduce the above copyright
10# notice, this list of conditions and the following disclaimer in the
11# documentation and/or other materials provided with the distribution;
12# neither the name of the copyright holders nor the names of its
13# contributors may be used to endorse or promote products derived from
14# this software without specific prior written permission.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27#
28# Authors: Brad Beckmann
29
30import math
31import m5
32from m5.objects import *
33from m5.defines import buildEnv
34from Ruby import create_topology, create_directories
35from Ruby import send_evicts
36
37#
38# Declare caches used by the protocol
39#
40class L1Cache(RubyCache): pass
41class L2Cache(RubyCache): pass
42
43def define_options(parser):
44    return
45
46def create_system(options, full_system, system, dma_ports, bootmem,
47                  ruby_system):
48
49    if buildEnv['PROTOCOL'] != 'MESI_Two_Level':
50        fatal("This script requires the MESI_Two_Level protocol to be built.")
51
52    cpu_sequencers = []
53
54    #
55    # The ruby network creation expects the list of nodes in the system to be
56    # consistent with the NetDest list.  Therefore the l1 controller nodes must be
57    # listed before the directory nodes and directory nodes before dma nodes, etc.
58    #
59    l1_cntrl_nodes = []
60    l2_cntrl_nodes = []
61    dma_cntrl_nodes = []
62
63    #
64    # Must create the individual controllers before the network to ensure the
65    # controller constructors are called before the network constructor
66    #
67    l2_bits = int(math.log(options.num_l2caches, 2))
68    block_size_bits = int(math.log(options.cacheline_size, 2))
69
70    for i in range(options.num_cpus):
71        #
72        # First create the Ruby objects associated with this cpu
73        #
74        l1i_cache = L1Cache(size = options.l1i_size,
75                            assoc = options.l1i_assoc,
76                            start_index_bit = block_size_bits,
77                            is_icache = True)
78        l1d_cache = L1Cache(size = options.l1d_size,
79                            assoc = options.l1d_assoc,
80                            start_index_bit = block_size_bits,
81                            is_icache = False)
82
83        prefetcher = RubyPrefetcher.Prefetcher()
84
85        # the ruby random tester reuses num_cpus to specify the
86        # number of cpu ports connected to the tester object, which
87        # is stored in system.cpu. because there is only ever one
88        # tester object, num_cpus is not necessarily equal to the
89        # size of system.cpu; therefore if len(system.cpu) == 1
90        # we use system.cpu[0] to set the clk_domain, thereby ensuring
91        # we don't index off the end of the cpu list.
92        if len(system.cpu) == 1:
93            clk_domain = system.cpu[0].clk_domain
94        else:
95            clk_domain = system.cpu[i].clk_domain
96
97        l1_cntrl = L1Cache_Controller(version = i, L1Icache = l1i_cache,
98                                      L1Dcache = l1d_cache,
99                                      l2_select_num_bits = l2_bits,
100                                      send_evictions = send_evicts(options),
101                                      prefetcher = prefetcher,
102                                      ruby_system = ruby_system,
103                                      clk_domain = clk_domain,
104                                      transitions_per_cycle = options.ports,
105                                      enable_prefetch = False)
106
107        cpu_seq = RubySequencer(version = i, icache = l1i_cache,
108                                dcache = l1d_cache, clk_domain = clk_domain,
109                                ruby_system = ruby_system)
110
111
112        l1_cntrl.sequencer = cpu_seq
113        exec("ruby_system.l1_cntrl%d = l1_cntrl" % i)
114
115        # Add controllers and sequencers to the appropriate lists
116        cpu_sequencers.append(cpu_seq)
117        l1_cntrl_nodes.append(l1_cntrl)
118
119        # Connect the L1 controllers and the network
120        l1_cntrl.mandatoryQueue = MessageBuffer()
121        l1_cntrl.requestFromL1Cache = MessageBuffer()
122        l1_cntrl.requestFromL1Cache.master = ruby_system.network.slave
123        l1_cntrl.responseFromL1Cache = MessageBuffer()
124        l1_cntrl.responseFromL1Cache.master = ruby_system.network.slave
125        l1_cntrl.unblockFromL1Cache = MessageBuffer()
126        l1_cntrl.unblockFromL1Cache.master = ruby_system.network.slave
127
128        l1_cntrl.optionalQueue = MessageBuffer()
129
130        l1_cntrl.requestToL1Cache = MessageBuffer()
131        l1_cntrl.requestToL1Cache.slave = ruby_system.network.master
132        l1_cntrl.responseToL1Cache = MessageBuffer()
133        l1_cntrl.responseToL1Cache.slave = ruby_system.network.master
134
135
136    l2_index_start = block_size_bits + l2_bits
137
138    for i in range(options.num_l2caches):
139        #
140        # First create the Ruby objects associated with this cpu
141        #
142        l2_cache = L2Cache(size = options.l2_size,
143                           assoc = options.l2_assoc,
144                           start_index_bit = l2_index_start)
145
146        l2_cntrl = L2Cache_Controller(version = i,
147                                      L2cache = l2_cache,
148                                      transitions_per_cycle = options.ports,
149                                      ruby_system = ruby_system)
150
151        exec("ruby_system.l2_cntrl%d = l2_cntrl" % i)
152        l2_cntrl_nodes.append(l2_cntrl)
153
154        # Connect the L2 controllers and the network
155        l2_cntrl.DirRequestFromL2Cache = MessageBuffer()
156        l2_cntrl.DirRequestFromL2Cache.master = ruby_system.network.slave
157        l2_cntrl.L1RequestFromL2Cache = MessageBuffer()
158        l2_cntrl.L1RequestFromL2Cache.master = ruby_system.network.slave
159        l2_cntrl.responseFromL2Cache = MessageBuffer()
160        l2_cntrl.responseFromL2Cache.master = ruby_system.network.slave
161
162        l2_cntrl.unblockToL2Cache = MessageBuffer()
163        l2_cntrl.unblockToL2Cache.slave = ruby_system.network.master
164        l2_cntrl.L1RequestToL2Cache = MessageBuffer()
165        l2_cntrl.L1RequestToL2Cache.slave = ruby_system.network.master
166        l2_cntrl.responseToL2Cache = MessageBuffer()
167        l2_cntrl.responseToL2Cache.slave = ruby_system.network.master
168
169
170    # Run each of the ruby memory controllers at a ratio of the frequency of
171    # the ruby system
172    # clk_divider value is a fix to pass regression.
173    ruby_system.memctrl_clk_domain = DerivedClockDomain(
174                                          clk_domain = ruby_system.clk_domain,
175                                          clk_divider = 3)
176
177    mem_dir_cntrl_nodes, rom_dir_cntrl_node = create_directories(
178        options, bootmem, ruby_system, system)
179    dir_cntrl_nodes = mem_dir_cntrl_nodes[:]
180    if rom_dir_cntrl_node is not None:
181        dir_cntrl_nodes.append(rom_dir_cntrl_node)
182    for dir_cntrl in dir_cntrl_nodes:
183        # Connect the directory controllers and the network
184        dir_cntrl.requestToDir = MessageBuffer()
185        dir_cntrl.requestToDir.slave = ruby_system.network.master
186        dir_cntrl.responseToDir = MessageBuffer()
187        dir_cntrl.responseToDir.slave = ruby_system.network.master
188        dir_cntrl.responseFromDir = MessageBuffer()
189        dir_cntrl.responseFromDir.master = ruby_system.network.slave
190        dir_cntrl.responseFromMemory = MessageBuffer()
191
192
193    for i, dma_port in enumerate(dma_ports):
194        # Create the Ruby objects associated with the dma controller
195        dma_seq = DMASequencer(version = i, ruby_system = ruby_system,
196                               slave = dma_port)
197
198        dma_cntrl = DMA_Controller(version = i, dma_sequencer = dma_seq,
199                                   transitions_per_cycle = options.ports,
200                                   ruby_system = ruby_system)
201
202        exec("ruby_system.dma_cntrl%d = dma_cntrl" % i)
203        dma_cntrl_nodes.append(dma_cntrl)
204
205        # Connect the dma controller to the network
206        dma_cntrl.mandatoryQueue = MessageBuffer()
207        dma_cntrl.responseFromDir = MessageBuffer(ordered = True)
208        dma_cntrl.responseFromDir.slave = ruby_system.network.master
209        dma_cntrl.requestToDir = MessageBuffer()
210        dma_cntrl.requestToDir.master = ruby_system.network.slave
211
212    all_cntrls = l1_cntrl_nodes + \
213                 l2_cntrl_nodes + \
214                 dir_cntrl_nodes + \
215                 dma_cntrl_nodes
216
217    # Create the io controller and the sequencer
218    if full_system:
219        io_seq = DMASequencer(version = len(dma_ports),
220                              ruby_system = ruby_system)
221        ruby_system._io_port = io_seq
222        io_controller = DMA_Controller(version = len(dma_ports),
223                                       dma_sequencer = io_seq,
224                                       ruby_system = ruby_system)
225        ruby_system.io_controller = io_controller
226
227        # Connect the dma controller to the network
228        io_controller.mandatoryQueue = MessageBuffer()
229        io_controller.responseFromDir = MessageBuffer(ordered = True)
230        io_controller.responseFromDir.slave = ruby_system.network.master
231        io_controller.requestToDir = MessageBuffer()
232        io_controller.requestToDir.master = ruby_system.network.slave
233
234        all_cntrls = all_cntrls + [io_controller]
235
236    ruby_system.network.number_of_virtual_networks = 3
237    topology = create_topology(all_cntrls, options)
238    return (cpu_sequencers, mem_dir_cntrl_nodes, topology)
239