ruby: Memory size consistency check
[gem5.git] / configs / ruby / MOESI_hammer.py
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
30 import m5
31 from m5.objects import *
32 from m5.defines import buildEnv
33 from m5.util import addToPath
34
35
36 #
37 # Note: the L1 Cache latency is only used by the sequencer on fast path hits
38 #
39 class L1Cache(RubyCache):
40 latency = 3
41
42 #
43 # Note: the L2 Cache latency is not currently used
44 #
45 class L2Cache(RubyCache):
46 latency = 15
47
48 def create_system(options, phys_mem, piobus, dma_devices):
49
50 if buildEnv['PROTOCOL'] != 'MOESI_hammer':
51 panic("This script requires the MOESI_hammer protocol to be built.")
52
53 cpu_sequencers = []
54
55 #
56 # The ruby network creation expects the list of nodes in the system to be
57 # consistent with the NetDest list. Therefore the l1 controller nodes must be
58 # listed before the directory nodes and directory nodes before dma nodes, etc.
59 #
60 l1_cntrl_nodes = []
61 dir_cntrl_nodes = []
62 dma_cntrl_nodes = []
63
64 #
65 # Must create the individual controllers before the network to ensure the
66 # controller constructors are called before the network constructor
67 #
68
69 for i in xrange(options.num_cpus):
70 #
71 # First create the Ruby objects associated with this cpu
72 #
73 l1i_cache = L1Cache(size = options.l1i_size,
74 assoc = options.l1i_assoc)
75 l1d_cache = L1Cache(size = options.l1d_size,
76 assoc = options.l1d_assoc)
77 l2_cache = L2Cache(size = options.l2_size,
78 assoc = options.l2_assoc)
79
80 cpu_seq = RubySequencer(icache = l1i_cache,
81 dcache = l1d_cache,
82 physMemPort = phys_mem.port,
83 physmem = phys_mem)
84
85 if piobus != None:
86 cpu_seq.pio_port = piobus.port
87
88 l1_cntrl = L1Cache_Controller(version = i,
89 sequencer = cpu_seq,
90 L1IcacheMemory = l1i_cache,
91 L1DcacheMemory = l1d_cache,
92 L2cacheMemory = l2_cache)
93 #
94 # Add controllers and sequencers to the appropriate lists
95 #
96 cpu_sequencers.append(cpu_seq)
97 l1_cntrl_nodes.append(l1_cntrl)
98
99 phys_mem_size = long(phys_mem.range.second) - long(phys_mem.range.first) + 1
100 mem_module_size = phys_mem_size / options.num_dirs
101
102 for i in xrange(options.num_dirs):
103 #
104 # Create the Ruby objects associated with the directory controller
105 #
106
107 mem_cntrl = RubyMemoryControl(version = i)
108
109 dir_size = MemorySize('0B')
110 dir_size.value = mem_module_size
111
112 dir_cntrl = Directory_Controller(version = i,
113 directory = \
114 RubyDirectoryMemory(version = i,
115 size = dir_size),
116 memBuffer = mem_cntrl)
117
118 dir_cntrl_nodes.append(dir_cntrl)
119
120 for i, dma_device in enumerate(dma_devices):
121 #
122 # Create the Ruby objects associated with the dma controller
123 #
124 dma_seq = DMASequencer(version = i,
125 physMemPort = phys_mem.port,
126 physmem = phys_mem)
127
128 dma_cntrl = DMA_Controller(version = i,
129 dma_sequencer = dma_seq)
130
131 dma_cntrl.dma_sequencer.port = dma_device.dma
132 dma_cntrl_nodes.append(dma_cntrl)
133
134 all_cntrls = l1_cntrl_nodes + dir_cntrl_nodes + dma_cntrl_nodes
135
136 return (cpu_sequencers, dir_cntrl_nodes, all_cntrls)