BaseTopology.py revision 9100:3caf131d7a95 
1# Copyright (c) 2012 Advanced Micro Devices, Inc.
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26#
27# Authors: Jason Power
28
29
30class BaseTopology(object):
31    description = "BaseTopology"
32
33    def __init__(self):
34        """ When overriding place any objects created in
35            configs/ruby/<protocol>.py that are needed in
36            makeTopology (below) here. The minimum is usually
37            all of the controllers created in the above file.
38        """
39
40    def makeTopology(self, options, IntLink, ExtLink, Router):
41        """ Called from src/mem/ruby/network/topologies/TopologyCreatory.py
42            The return value is ( list(Router), list(IntLink), list(ExtLink))
43            The API of this function cannot change when subclassing!!
44            Any additional information needed to create this topology should
45            be passed into the constructor when it's instantiated in
46            configs/ruby/<protocol>.py
47        """
48        print "BaseTopology should have been overridden in a sub class!!"
49        import sys
50        sys.exit(1)
51
52