44a160793e0d5782c803d1b61894ed90312b87ac
[gem5.git] / configs / ruby / Ruby.py
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
30 import m5
31 from m5.objects import *
32 from m5.defines import buildEnv
33 from m5.util import addToPath
34 addToPath('../ruby/networks')
35 from MeshDirCorners import *
36
37 protocol = buildEnv['PROTOCOL']
38
39 exec "import %s" % protocol
40
41 def create_system(options, physmem, piobus = None, dma_devices = []):
42
43 try:
44 (cpu_sequencers, dir_cntrls, all_cntrls) = \
45 eval("%s.create_system(options, physmem, piobus, dma_devices)" \
46 % protocol)
47 except:
48 print "Error: could not create sytem for ruby protocol %s" % protocol
49 sys.exit(1)
50
51 #
52 # Important: the topology constructor must be called before the network
53 # constructor.
54 #
55 if options.topology == "crossbar":
56 net_topology = makeCrossbar(all_cntrls)
57 elif options.topology == "mesh":
58 #
59 # The uniform mesh topology assumes one router per cpu
60 #
61 net_topology = makeMesh(all_cntrls,
62 len(cpu_sequencers),
63 options.mesh_rows)
64
65 elif options.topology == "mesh_dir_corner":
66 #
67 # The uniform mesh topology assumes one router per cpu
68 #
69 net_topology = makeMeshDirCorners(all_cntrls,
70 len(cpu_sequencers),
71 options.mesh_rows)
72
73 if options.garnet_network == "fixed":
74 network = GarnetNetwork_d(topology = net_topology)
75 elif options.garnet_network == "flexible":
76 network = GarnetNetwork(topology = net_topology)
77 else:
78 network = SimpleNetwork(topology = net_topology)
79
80 #
81 # Determine the total memory size of the ruby system and verify it is equal
82 # to physmem. However, if Ruby memory is using sparse memory in SE
83 # mode, then the system should not back-up the memory state with
84 # the Memory Vector and thus the memory size bytes should stay at 0.
85 #
86 total_mem_size = MemorySize('0B')
87 for dir_cntrl in dir_cntrls:
88 total_mem_size.value += dir_cntrl.directory.size.value
89 physmem_size = long(physmem.range.second) - long(physmem.range.first) + 1
90 assert(total_mem_size.value == physmem_size)
91
92 ruby_profiler = RubyProfiler(num_of_sequencers = len(cpu_sequencers))
93
94 ruby = RubySystem(clock = options.clock,
95 network = network,
96 profiler = ruby_profiler,
97 tracer = RubyTracer(),
98 debug = RubyDebug(filter_string = 'none',
99 verbosity_string = 'none',
100 protocol_trace = False),
101 mem_size = total_mem_size)
102
103 ruby.cpu_ruby_ports = cpu_sequencers
104
105 return ruby