MI_example.py revision 10591:fea29fc045ee 
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
35from Ruby import send_evicts
36
37#
38# Note: the cache latency is only used by the sequencer on fast path hits
39#
40class Cache(RubyCache):
41    latency = 3
42
43def define_options(parser):
44    return
45
46def create_system(options, full_system, system, dma_ports, ruby_system):
47
48    if buildEnv['PROTOCOL'] != 'MI_example':
49        panic("This script requires the MI_example protocol to be built.")
50
51    cpu_sequencers = []
52
53    #
54    # The ruby network creation expects the list of nodes in the system to be
55    # consistent with the NetDest list.  Therefore the l1 controller nodes must be
56    # listed before the directory nodes and directory nodes before dma nodes, etc.
57    #
58    l1_cntrl_nodes = []
59    dir_cntrl_nodes = []
60    dma_cntrl_nodes = []
61
62    #
63    # Must create the individual controllers before the network to ensure the
64    # controller constructors are called before the network constructor
65    #
66    block_size_bits = int(math.log(options.cacheline_size, 2))
67
68    for i in xrange(options.num_cpus):
69        #
70        # First create the Ruby objects associated with this cpu
71        # Only one cache exists for this protocol, so by default use the L1D
72        # config parameters.
73        #
74        cache = Cache(size = options.l1d_size,
75                      assoc = options.l1d_assoc,
76                      start_index_bit = block_size_bits)
77
78        #
79        # Only one unified L1 cache exists.  Can cache instructions and data.
80        #
81        l1_cntrl = L1Cache_Controller(version = i,
82                                      cacheMemory = cache,
83                                      send_evictions = send_evicts(options),
84                                      transitions_per_cycle = options.ports,
85                                      clk_domain=system.cpu[i].clk_domain,
86                                      ruby_system = ruby_system)
87
88        cpu_seq = RubySequencer(version = i,
89                                icache = cache,
90                                dcache = cache,
91                                clk_domain=system.cpu[i].clk_domain,
92                                ruby_system = ruby_system)
93
94        l1_cntrl.sequencer = cpu_seq
95        exec("ruby_system.l1_cntrl%d = l1_cntrl" % i)
96
97        # Add controllers and sequencers to the appropriate lists
98        cpu_sequencers.append(cpu_seq)
99        l1_cntrl_nodes.append(l1_cntrl)
100
101        # Connect the L1 controllers and the network
102        l1_cntrl.requestFromCache =  ruby_system.network.slave
103        l1_cntrl.responseFromCache =  ruby_system.network.slave
104        l1_cntrl.forwardToCache =  ruby_system.network.master
105        l1_cntrl.responseToCache =  ruby_system.network.master
106
107
108    phys_mem_size = sum(map(lambda r: r.size(), system.mem_ranges))
109    assert(phys_mem_size % options.num_dirs == 0)
110    mem_module_size = phys_mem_size / options.num_dirs
111
112    # Run each of the ruby memory controllers at a ratio of the frequency of
113    # the ruby system.
114    # clk_divider value is a fix to pass regression.
115    ruby_system.memctrl_clk_domain = DerivedClockDomain(
116                                          clk_domain=ruby_system.clk_domain,
117                                          clk_divider=3)
118
119    for i in xrange(options.num_dirs):
120        dir_size = MemorySize('0B')
121        dir_size.value = mem_module_size
122        dir_cntrl = Directory_Controller(version = i,
123                                         directory = RubyDirectoryMemory(
124                                             version = i, size = dir_size),
125                                         transitions_per_cycle = options.ports,
126                                         ruby_system = ruby_system)
127
128        exec("ruby_system.dir_cntrl%d = dir_cntrl" % i)
129        dir_cntrl_nodes.append(dir_cntrl)
130
131        # Connect the directory controllers and the network
132        dir_cntrl.requestToDir = ruby_system.network.master
133        dir_cntrl.dmaRequestToDir = ruby_system.network.master
134
135        dir_cntrl.responseFromDir = ruby_system.network.slave
136        dir_cntrl.dmaResponseFromDir = ruby_system.network.slave
137        dir_cntrl.forwardFromDir = ruby_system.network.slave
138
139
140    for i, dma_port in enumerate(dma_ports):
141        #
142        # Create the Ruby objects associated with the dma controller
143        #
144        dma_seq = DMASequencer(version = i,
145                               ruby_system = ruby_system)
146
147        dma_cntrl = DMA_Controller(version = i,
148                                   dma_sequencer = dma_seq,
149                                   transitions_per_cycle = options.ports,
150                                   ruby_system = ruby_system)
151
152        exec("ruby_system.dma_cntrl%d = dma_cntrl" % i)
153        exec("ruby_system.dma_cntrl%d.dma_sequencer.slave = dma_port" % i)
154        dma_cntrl_nodes.append(dma_cntrl)
155
156        # Connect the directory controllers and the network
157        dma_cntrl.requestToDir = ruby_system.network.slave
158        dma_cntrl.responseFromDir = ruby_system.network.master
159
160    all_cntrls = l1_cntrl_nodes + dir_cntrl_nodes + dma_cntrl_nodes
161
162    # Create the io controller and the sequencer
163    if full_system:
164        io_seq = DMASequencer(version=len(dma_ports), ruby_system=ruby_system)
165        ruby_system._io_port = io_seq
166        io_controller = DMA_Controller(version = len(dma_ports),
167                                       dma_sequencer = io_seq,
168                                       ruby_system = ruby_system)
169        ruby_system.io_controller = io_controller
170
171        # Connect the dma controller to the network
172        io_controller.responseFromDir = ruby_system.network.master
173        io_controller.requestToDir = ruby_system.network.slave
174
175        all_cntrls = all_cntrls + [io_controller]
176
177    topology = create_topology(all_cntrls, options)
178    return (cpu_sequencers, dir_cntrl_nodes, topology)
179