configs/topologies/BaseTopology.py

   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 from __future__ import print_function
  30 from __future__ import absolute_import
  31
  32 import m5
  33
  34 class BaseTopology(object):
  35     description = "BaseTopology"
  36
  37     def __init__(self):
  38         """ When overriding place any objects created in
  39             configs/ruby/<protocol>.py that are needed in
  40             makeTopology (below) here. The minimum is usually
  41             all of the controllers created in the above file.
  42         """
  43
  44     def makeTopology(self, options, network, IntLink, ExtLink, Router):
  45         """ Called from configs/ruby/Ruby.py
  46             The return value is ( list(Router), list(IntLink), list(ExtLink))
  47             The API of this function cannot change when subclassing!!
  48             Any additional information needed to create this topology should
  49             be passed into the constructor when it's instantiated in
  50             configs/ruby/<protocol>.py
  51         """
  52         m5.util.fatal("BaseTopology should have been overridden!!")
  53
  54 class SimpleTopology(BaseTopology):
  55     """ Provides methods needed for the topologies included in Ruby before
  56         topology changes.
  57         These topologies are "simple" in the sense that they only use a flat
  58         list of controllers to construct the topology.
  59     """
  60     description = "SimpleTopology"
  61
  62     def __init__(self, controllers):
  63         self.nodes = controllers
  64
  65     def addController(self, controller):
  66         self.nodes.append(controller)
  67
  68     def __len__(self):
  69         return len(self.nodes)