ruby: Add support for address ranges in the directory
[gem5.git] / configs / ruby / Garnet_standalone.py
1 # Copyright (c) 2009 Advanced Micro Devices, Inc.
2 # Copyright (c) 2016 Georgia Institute of Technology
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 # Tushar Krishna
30
31 import m5
32 from m5.objects import *
33 from m5.defines import buildEnv
34 from m5.util import addToPath
35 from Ruby import create_topology, create_directories
36
37 #
38 # Declare caches used by the protocol
39 #
40 class L1Cache(RubyCache): pass
41
42 def define_options(parser):
43 return
44
45 def create_system(options, full_system, system, dma_ports, ruby_system):
46 if buildEnv['PROTOCOL'] != 'Garnet_standalone':
47 panic("This script requires Garnet_standalone protocol to be built.")
48
49 cpu_sequencers = []
50
51 #
52 # The Garnet_standalone protocol does not support fs nor dma
53 #
54 assert(dma_ports == [])
55
56 #
57 # The ruby network creation expects the list of nodes in the system to be
58 # consistent with the NetDest list.
59 # Therefore the l1 controller nodes must be listed before
60 # the directory nodes and directory nodes before dma nodes, etc.
61 l1_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
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 = L1Cache(size = options.l1d_size,
75 assoc = options.l1d_assoc)
76
77 #
78 # Only one unified L1 cache exists. Can cache instructions and data.
79 #
80 l1_cntrl = L1Cache_Controller(version = i,
81 cacheMemory = cache,
82 ruby_system = ruby_system)
83
84 cpu_seq = RubySequencer(icache = cache,
85 dcache = cache,
86 garnet_standalone = True,
87 ruby_system = ruby_system)
88
89 l1_cntrl.sequencer = cpu_seq
90 exec("ruby_system.l1_cntrl%d = l1_cntrl" % i)
91
92 # Add controllers and sequencers to the appropriate lists
93 cpu_sequencers.append(cpu_seq)
94 l1_cntrl_nodes.append(l1_cntrl)
95
96 # Connect the L1 controllers and the network
97 l1_cntrl.mandatoryQueue = MessageBuffer()
98 l1_cntrl.requestFromCache = MessageBuffer()
99 l1_cntrl.responseFromCache = MessageBuffer()
100 l1_cntrl.forwardFromCache = MessageBuffer()
101
102
103 dir_cntrl_nodes = create_directories(options, system.mem_ranges,
104 ruby_system)
105 for dir_cntrl in dir_cntrl_nodes:
106 # Connect the directory controllers and the network
107 dir_cntrl.requestToDir = MessageBuffer()
108 dir_cntrl.forwardToDir = MessageBuffer()
109 dir_cntrl.responseToDir = MessageBuffer()
110
111
112 all_cntrls = l1_cntrl_nodes + dir_cntrl_nodes
113 ruby_system.network.number_of_virtual_networks = 3
114 topology = create_topology(all_cntrls, options)
115 return (cpu_sequencers, dir_cntrl_nodes, topology)