Ruby.py revision 8612 
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
34
35def define_options(parser):
36    # ruby network options
37    parser.add_option("--topology", type="string", default="Crossbar",
38                 help="check src/mem/ruby/network/topologies for complete set")
39    parser.add_option("--mesh-rows", type="int", default=1,
40                      help="the number of rows in the mesh topology")
41    parser.add_option("--garnet-network", type="string", default=None,
42                      help="'fixed'|'flexible'")
43    parser.add_option("--network-fault-model", action="store_true", default=False,
44                      help="enable network fault model: see src/mem/ruby/network/fault_model/")
45
46    # ruby mapping options
47    parser.add_option("--numa-high-bit", type="int", default=0,
48                      help="high order address bit to use for numa mapping. " \
49                           "0 = highest bit, not specified = lowest bit")
50
51    # ruby sparse memory options
52    parser.add_option("--use-map", action="store_true", default=False)
53    parser.add_option("--map-levels", type="int", default=4)
54
55    parser.add_option("--recycle-latency", type="int", default=10,
56                      help="Recycle latency for ruby controller input buffers")
57
58    parser.add_option("--random_seed", type="int", default=1234,
59                      help="Used for seeding the random number generator")
60
61    protocol = buildEnv['PROTOCOL']
62    exec "import %s" % protocol
63    eval("%s.define_options(parser)" % protocol)
64
65def create_system(options, system, piobus = None, dma_devices = []):
66
67    system.ruby = RubySystem(clock = options.clock)
68    ruby = system.ruby
69
70    protocol = buildEnv['PROTOCOL']
71    exec "import %s" % protocol
72    try:
73        (cpu_sequencers, dir_cntrls, all_cntrls) = \
74             eval("%s.create_system(options, system, piobus, \
75                                    dma_devices, ruby)" \
76                  % protocol)
77    except:
78        print "Error: could not create sytem for ruby protocol %s" % protocol
79        raise
80
81    #
82    # Set the network classes based on the command line options
83    #
84    if options.garnet_network == "fixed":
85        class NetworkClass(GarnetNetwork_d): pass
86        class IntLinkClass(GarnetIntLink_d): pass
87        class ExtLinkClass(GarnetExtLink_d): pass
88        class RouterClass(GarnetRouter_d): pass
89    elif options.garnet_network == "flexible":
90        class NetworkClass(GarnetNetwork): pass
91        class IntLinkClass(GarnetIntLink): pass
92        class ExtLinkClass(GarnetExtLink): pass
93        class RouterClass(GarnetRouter): pass
94    else:
95        class NetworkClass(SimpleNetwork): pass
96        class IntLinkClass(SimpleIntLink): pass
97        class ExtLinkClass(SimpleExtLink): pass
98        class RouterClass(BasicRouter): pass
99
100    #
101    # Important: the topology must be created before the network and after the
102    # controllers.
103    #
104    exec "import %s" % options.topology
105    try:
106        net_topology = eval("%s.makeTopology(all_cntrls, options, \
107                                             IntLinkClass, ExtLinkClass, \
108                                             RouterClass)" \
109                            % options.topology)
110    except:
111        print "Error: could not create topology %s" % options.topology
112        raise
113
114    if options.network_fault_model:
115        assert(options.garnet_network == "fixed")
116        fault_model = FaultModel()
117        network = NetworkClass(ruby_system = ruby, topology = net_topology,\
118                               enable_fault_model=True, fault_model = fault_model)
119    else:
120        network = NetworkClass(ruby_system = ruby, topology = net_topology)
121
122    #
123    # Loop through the directory controlers.
124    # Determine the total memory size of the ruby system and verify it is equal
125    # to physmem.  However, if Ruby memory is using sparse memory in SE
126    # mode, then the system should not back-up the memory state with
127    # the Memory Vector and thus the memory size bytes should stay at 0.
128    # Also set the numa bits to the appropriate values.
129    #
130    total_mem_size = MemorySize('0B')
131
132    dir_bits = int(math.log(options.num_dirs, 2))
133
134    if options.numa_high_bit:
135        numa_bit = options.numa_high_bit
136    else:
137        # if not specified, use the lowest bits above the block offest
138        if dir_bits > 0:
139            # add 5 because bits 0-5 are the block offset
140            numa_bit = dir_bits + 5
141        else:
142            numa_bit = 6
143
144    for dir_cntrl in dir_cntrls:
145        total_mem_size.value += dir_cntrl.directory.size.value
146        dir_cntrl.directory.numa_high_bit = numa_bit
147
148    physmem_size = long(system.physmem.range.second) - \
149                     long(system.physmem.range.first) + 1
150    assert(total_mem_size.value == physmem_size)
151
152    ruby_profiler = RubyProfiler(ruby_system = ruby,
153                                 num_of_sequencers = len(cpu_sequencers))
154    ruby_tracer   = RubyTracer(ruby_system = ruby)
155
156    ruby.network = network
157    ruby.profiler = ruby_profiler
158    ruby.tracer = ruby_tracer
159    ruby.mem_size = total_mem_size
160    ruby._cpu_ruby_ports = cpu_sequencers
161    ruby.random_seed    = options.random_seed
162