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
31import m5
32from m5.objects import *
33from m5.defines import buildEnv
34from m5.util import addToPath
35from Ruby import create_topology, create_directories
36
37#
38# Declare caches used by the protocol
39#
40class L1Cache(RubyCache): pass
41
42def define_options(parser):
43    return
44
45def create_system(options, full_system, system, dma_ports, bootmem,
46                  ruby_system):
47    if buildEnv['PROTOCOL'] != 'Garnet_standalone':
48        panic("This script requires Garnet_standalone protocol to be built.")
49
50    cpu_sequencers = []
51
52    #
53    # The Garnet_standalone protocol does not support fs nor dma
54    #
55    assert(dma_ports == [])
56
57    #
58    # The ruby network creation expects the list of nodes in the system to be
59    # consistent with the NetDest list.
60    # Therefore the l1 controller nodes must be listed before
61    # the directory nodes and directory nodes before dma nodes, etc.
62    l1_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 range(options.num_cpus):
70        #
71        # First create the Ruby objects associated with this cpu
72        # Only one cache exists for this protocol, so by default use the L1D
73        # config parameters.
74        #
75        cache = L1Cache(size = options.l1d_size,
76                        assoc = options.l1d_assoc)
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                                      ruby_system = ruby_system)
84
85        cpu_seq = RubySequencer(icache = cache,
86                                dcache = cache,
87                                garnet_standalone = True,
88                                ruby_system = ruby_system)
89
90        l1_cntrl.sequencer = cpu_seq
91        exec("ruby_system.l1_cntrl%d = l1_cntrl" % i)
92
93        # Add controllers and sequencers to the appropriate lists
94        cpu_sequencers.append(cpu_seq)
95        l1_cntrl_nodes.append(l1_cntrl)
96
97        # Connect the L1 controllers and the network
98        l1_cntrl.mandatoryQueue = MessageBuffer()
99        l1_cntrl.requestFromCache = MessageBuffer()
100        l1_cntrl.responseFromCache = MessageBuffer()
101        l1_cntrl.forwardFromCache = MessageBuffer()
102
103    mem_dir_cntrl_nodes, rom_dir_cntrl_node = create_directories(
104        options, bootmem, ruby_system, system)
105    dir_cntrl_nodes = mem_dir_cntrl_nodes[:]
106    if rom_dir_cntrl_node is not None:
107        dir_cntrl_nodes.append(rom_dir_cntrl_node)
108    for dir_cntrl in dir_cntrl_nodes:
109        # Connect the directory controllers and the network
110        dir_cntrl.requestToDir = MessageBuffer()
111        dir_cntrl.forwardToDir = MessageBuffer()
112        dir_cntrl.responseToDir = MessageBuffer()
113
114
115    all_cntrls = l1_cntrl_nodes + dir_cntrl_nodes
116    ruby_system.network.number_of_virtual_networks = 3
117    topology = create_topology(all_cntrls, options)
118    return (cpu_sequencers, mem_dir_cntrl_nodes, topology)
119