MI_example.py revision 8180:d8587c913ccf 
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 m5
31from m5.objects import *
32from m5.defines import buildEnv
33
34#
35# Note: the cache latency is only used by the sequencer on fast path hits
36#
37class Cache(RubyCache):
38    latency = 3
39
40def define_options(parser):
41    return
42
43def create_system(options, system, piobus, dma_devices):
44
45    if buildEnv['PROTOCOL'] != 'MI_example':
46        panic("This script requires the MI_example protocol to be built.")
47
48    cpu_sequencers = []
49
50    #
51    # The ruby network creation expects the list of nodes in the system to be
52    # consistent with the NetDest list.  Therefore the l1 controller nodes must be
53    # listed before the directory nodes and directory nodes before dma nodes, etc.
54    #
55    l1_cntrl_nodes = []
56    dir_cntrl_nodes = []
57    dma_cntrl_nodes = []
58
59    #
60    # Must create the individual controllers before the network to ensure the
61    # controller constructors are called before the network constructor
62    #
63    block_size_bits = int(math.log(options.cacheline_size, 2))
64
65    for i in xrange(options.num_cpus):
66        #
67        # First create the Ruby objects associated with this cpu
68        # Only one cache exists for this protocol, so by default use the L1D
69        # config parameters.
70        #
71        cache = Cache(size = options.l1d_size,
72                      assoc = options.l1d_assoc,
73                      start_index_bit = block_size_bits)
74
75        #
76        # Only one unified L1 cache exists.  Can cache instructions and data.
77        #
78        cpu_seq = RubySequencer(version = i,
79                                icache = cache,
80                                dcache = cache,
81                                physMemPort = system.physmem.port,
82                                physmem = system.physmem)
83
84        if piobus != None:
85            cpu_seq.pio_port = piobus.port
86
87        l1_cntrl = L1Cache_Controller(version = i,
88                                      sequencer = cpu_seq,
89                                      cacheMemory = cache)
90
91        exec("system.l1_cntrl%d = l1_cntrl" % i)
92        #
93        # Add controllers and sequencers to the appropriate lists
94        #
95        cpu_sequencers.append(cpu_seq)
96        l1_cntrl_nodes.append(l1_cntrl)
97
98    phys_mem_size = long(system.physmem.range.second) - \
99                      long(system.physmem.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( \
115                                                    version = i,
116                                                    size = dir_size,
117                                                    use_map = options.use_map,
118                                                    map_levels = \
119                                                      options.map_levels),
120                                         memBuffer = mem_cntrl)
121
122        exec("system.dir_cntrl%d = dir_cntrl" % i)
123        dir_cntrl_nodes.append(dir_cntrl)
124
125    for i, dma_device in enumerate(dma_devices):
126        #
127        # Create the Ruby objects associated with the dma controller
128        #
129        dma_seq = DMASequencer(version = i,
130                               physMemPort = system.physmem.port,
131                               physmem = system.physmem)
132
133        dma_cntrl = DMA_Controller(version = i,
134                                   dma_sequencer = dma_seq)
135
136        exec("system.dma_cntrl%d = dma_cntrl" % i)
137        if dma_device.type == 'MemTest':
138            system.dma_cntrl.dma_sequencer.port = dma_device.test
139        else:
140            system.dma_cntrl.dma_sequencer.port = dma_device.dma
141        dma_cntrl.dma_sequencer.port = dma_device.dma
142        dma_cntrl_nodes.append(dma_cntrl)
143
144    all_cntrls = l1_cntrl_nodes + dir_cntrl_nodes + dma_cntrl_nodes
145
146    return (cpu_sequencers, dir_cntrl_nodes, all_cntrls)
147