Ruby.py revision 7541 
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
34def define_options(parser):
35    # ruby network options
36    parser.add_option("--topology", type="string", default="Crossbar",
37                 help="check src/mem/ruby/network/topologies for complete set")
38    parser.add_option("--mesh-rows", type="int", default=1,
39                      help="the number of rows in the mesh topology")
40    parser.add_option("--garnet-network", type="string", default=none,
41                      help="'fixed'|'flexible'")
42
43    # ruby mapping options
44    parser.add_option("--numa-high-bit", type="int", default=none,
45                      help="high order address bit to use for numa mapping")
46
47    # ruby sparse memory options
48    parser.add_option("--use-map", action="store_true", default=False)
49    parser.add_option("--map-levels", type="int", default=4)
50
51    protocol = buildEnv['PROTOCOL']
52    exec "import %s" % protocol
53    eval("%s.define_options(parser)" % protocol)
54
55def create_system(options, system, piobus = None, dma_devices = []):
56
57    protocol = buildEnv['PROTOCOL']
58    exec "import %s" % protocol
59    try:
60        (cpu_sequencers, dir_cntrls, all_cntrls) = \
61          eval("%s.create_system(options, system, piobus, dma_devices)" \
62               % protocol)
63    except:
64        print "Error: could not create sytem for ruby protocol %s" % protocol
65        sys.exit(1)
66
67    #
68    # Important: the topology must be created before the network and after the
69    # controllers.
70    #
71    exec "import %s" % options.topology
72    try:
73        net_topology = eval("%s.makeTopology(all_cntrls, options)" % options.topology)
74    except:
75        print "Error: could not create topology %s" % options.topology
76        sys.exit(1)
77
78    if options.garnet_network == "fixed":
79        network = GarnetNetwork_d(topology = net_topology)
80    elif options.garnet_network == "flexible":
81        network = GarnetNetwork(topology = net_topology)
82    else:
83        network = SimpleNetwork(topology = net_topology)
84
85    #
86    # Determine the total memory size of the ruby system and verify it is equal
87    # to physmem.  However, if Ruby memory is using sparse memory in SE
88    # mode, then the system should not back-up the memory state with
89    # the Memory Vector and thus the memory size bytes should stay at 0.
90    #
91    total_mem_size = MemorySize('0B')
92    for dir_cntrl in dir_cntrls:
93        total_mem_size.value += dir_cntrl.directory.size.value
94    physmem_size = long(system.physmem.range.second) - \
95                     long(system.physmem.range.first) + 1
96    assert(total_mem_size.value == physmem_size)
97
98    ruby_profiler = RubyProfiler(num_of_sequencers = len(cpu_sequencers))
99
100    ruby = RubySystem(clock = options.clock,
101                      network = network,
102                      profiler = ruby_profiler,
103                      tracer = RubyTracer(),
104                      debug = RubyDebug(filter_string = 'none',
105                                        verbosity_string = 'none',
106                                        protocol_trace = False),
107                      mem_size = total_mem_size)
108
109    ruby.cpu_ruby_ports = cpu_sequencers
110
111    return ruby
112