Ruby.py revision 7563:406e98960def 
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
44    # ruby mapping options
45    parser.add_option("--numa-high-bit", type="int", default=none,
46                      help="high order address bit to use for numa mapping. " \
47                           "0 = highest bit, not specified = lowest bit")
48
49    # ruby sparse memory options
50    parser.add_option("--use-map", action="store_true", default=False)
51    parser.add_option("--map-levels", type="int", default=4)
52
53    # ruby debug cmd line options
54    parser.add_option("--ruby-debug", action="store_true", default=False)
55    parser.add_option("--ruby-debug-cycle", type="int", default=1)
56
57    protocol = buildEnv['PROTOCOL']
58    exec "import %s" % protocol
59    eval("%s.define_options(parser)" % protocol)
60
61def create_system(options, system, piobus = None, dma_devices = []):
62
63    protocol = buildEnv['PROTOCOL']
64    exec "import %s" % protocol
65    try:
66        (cpu_sequencers, dir_cntrls, all_cntrls) = \
67             eval("%s.create_system(options, system, piobus, dma_devices)" \
68                  % protocol)
69    except:
70        print "Error: could not create sytem for ruby protocol %s" % protocol
71        raise
72
73    #
74    # Important: the topology must be created before the network and after the
75    # controllers.
76    #
77    exec "import %s" % options.topology
78    try:
79        net_topology = eval("%s.makeTopology(all_cntrls, options)" \
80                            % options.topology)
81    except:
82        print "Error: could not create topology %s" % options.topology
83        raise
84
85    if options.garnet_network == "fixed":
86        network = GarnetNetwork_d(topology = net_topology)
87    elif options.garnet_network == "flexible":
88        network = GarnetNetwork(topology = net_topology)
89    else:
90        network = SimpleNetwork(topology = net_topology)
91
92    #
93    # Loop through the directory controlers.
94    # Determine the total memory size of the ruby system and verify it is equal
95    # to physmem.  However, if Ruby memory is using sparse memory in SE
96    # mode, then the system should not back-up the memory state with
97    # the Memory Vector and thus the memory size bytes should stay at 0.
98    # Also set the numa bits to the appropriate values.
99    #
100    total_mem_size = MemorySize('0B')
101
102    dir_bits = int(math.log(options.num_dirs, 2))
103
104    if options.numa_high_bit:
105        numa_bit = options.numa_high_bit
106    else:
107        # if not specified, use the lowest bits above the block offest
108        if options.numa_high_bit == 0:
109            if dir_bits > 0:
110                # add 5 because bits 0-5 are the block offset
111                numa_bit = dir_bits + 5
112            else:
113                numa_bit = 6
114
115    for dir_cntrl in dir_cntrls:
116        total_mem_size.value += dir_cntrl.directory.size.value
117        dir_cntrl.directory.numa_high_bit = numa_bit
118
119    physmem_size = long(system.physmem.range.second) - \
120                     long(system.physmem.range.first) + 1
121    assert(total_mem_size.value == physmem_size)
122
123    ruby_profiler = RubyProfiler(num_of_sequencers = len(cpu_sequencers))
124
125    ruby = RubySystem(clock = options.clock,
126                      network = network,
127                      profiler = ruby_profiler,
128                      tracer = RubyTracer(),
129                      debug = RubyDebug(filter_string = 'none',
130                                        verbosity_string = 'none',
131                                        protocol_trace = options.ruby_debug,
132                                        start_time = options.ruby_debug_cycle),
133                      mem_size = total_mem_size)
134
135    ruby.cpu_ruby_ports = cpu_sequencers
136
137    return ruby
138