Ruby.py revision 6911:1fdbff869ff4 
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
33from m5.util import addToPath
34
35import MOESI_hammer
36import MOESI_CMP_directory
37import MI_example
38import MOESI_CMP_token
39
40def create_system(options, physmem, piobus = None, dma_devices = []):
41
42    protocol = buildEnv['PROTOCOL']
43
44    if protocol == "MOESI_hammer":
45        (cpu_sequencers, dir_cntrls, all_cntrls) = \
46            MOESI_hammer.create_system(options, \
47                                       physmem, \
48                                       piobus, \
49                                       dma_devices)
50    elif protocol == "MOESI_CMP_directory":
51        (cpu_sequencers, dir_cntrls, all_cntrls) = \
52            MOESI_CMP_directory.create_system(options, \
53                                          physmem, \
54                                          piobus, \
55                                          dma_devices)
56    elif protocol == "MI_example":
57        (cpu_sequencers, dir_cntrls, all_cntrls) = \
58            MI_example.create_system(options, \
59                                     physmem, \
60                                     piobus, \
61                                     dma_devices)
62    elif protocol == "MOESI_CMP_token":
63        (cpu_sequencers, dir_cntrls, all_cntrls) = \
64            MOESI_CMP_token.create_system(options, \
65                                          physmem, \
66                                          piobus, \
67                                          dma_devices)
68    else:
69         print "Error: unsupported ruby protocol"
70         sys.exit(1)
71
72    #
73    # Important: the topology constructor must be called before the network
74    # constructor.
75    #
76    network = SimpleNetwork(topology = makeCrossbar(all_cntrls))
77
78    #
79    # determine the total memory size of the ruby system and verify it is equal
80    # to physmem
81    #
82    total_mem_size = MemorySize('0B')
83    for dir_cntrl in dir_cntrls:
84        total_mem_size.value += dir_cntrl.directory.size.value
85    physmem_size = long(physmem.range.second) - long(physmem.range.first) + 1
86    assert(total_mem_size.value == physmem_size)
87
88    ruby_profiler = RubyProfiler(num_of_sequencers = len(cpu_sequencers))
89
90    ruby = RubySystem(clock = options.clock,
91                      network = network,
92                      profiler = ruby_profiler,
93                      tracer = RubyTracer(),
94                      debug = RubyDebug(filter_string = 'none',
95                                        verbosity_string = 'none',
96                                        protocol_trace = False),
97                      mem_size = total_mem_size)
98
99    ruby.cpu_ruby_ports = cpu_sequencers
100
101    return ruby
102