config: add a separate config file for the network.

This patch adds a new file configs/network/Network.py to setup the network,
instead of doing that within Ruby.py.

10 files changed, 131 insertions, 52 deletions

diff --git a/configs/example/apu_se.py b/configs/example/apu_se.py
index a044c9a43..2069daccb 100644
--- a/configs/example/apu_se.py
+++ b/configs/example/apu_se.py
@@ -43,11 +43,13 @@ from m5.objects import *
 from m5.util import addToPath
 
 addToPath('../ruby')
+addToPath('../network')
 addToPath('../common')
 addToPath('../topologies')
 
 import Options
 import Ruby
+import Network
 import Simulation
 import GPUTLBOptions, GPUTLBConfig
 
@@ -157,6 +159,7 @@ parser.add_option('--fast-forward-pseudo-op', action='store_true',
 
 
 Ruby.define_options(parser)
+Network.define_options(parser)
 
 #add TLB options to the parser
 GPUTLBOptions.tlb_options(parser)
diff --git a/configs/example/fs.py b/configs/example/fs.py
index a916ca49f..32fc699ba 100644
--- a/configs/example/fs.py
+++ b/configs/example/fs.py
@@ -51,8 +51,10 @@ from m5.util import addToPath, fatal
 
 addToPath('../common')
 addToPath('../ruby')
+addToPath('../network')
 
 import Ruby
+import Network
 
 from FSConfig import *
 from SysPaths import *
@@ -306,6 +308,7 @@ Options.addFSOptions(parser)
 # Add the ruby specific and protocol specific options
 if '--ruby' in sys.argv:
     Ruby.define_options(parser)
+    Network.define_options(parser)
 
 (options, args) = parser.parse_args()
 
diff --git a/configs/example/garnet_synth_traffic.py b/configs/example/garnet_synth_traffic.py
index a4c44efbc..8962c4af1 100644
--- a/configs/example/garnet_synth_traffic.py
+++ b/configs/example/garnet_synth_traffic.py
@@ -33,10 +33,12 @@ from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
 addToPath('../ruby')
+addToPath('../network')
 addToPath('../topologies')
 
 import Options
 import Ruby
+import Network
 
 # Get paths we might need.  It's expected this file is in m5/configs/example.
 config_path = os.path.dirname(os.path.abspath(__file__))
@@ -85,6 +87,7 @@ parser.add_option("--inj-vnet", type="int", default=-1,
 # Add the ruby specific and protocol specific options
 #
 Ruby.define_options(parser)
+Network.define_options(parser)
 
 execfile(os.path.join(config_root, "common", "Options.py"))
 
diff --git a/configs/example/ruby_direct_test.py b/configs/example/ruby_direct_test.py
index 857909ba9..cc74aec5d 100644
--- a/configs/example/ruby_direct_test.py
+++ b/configs/example/ruby_direct_test.py
@@ -35,10 +35,12 @@ from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
 addToPath('../ruby')
+addToPath('../network')
 addToPath('../topologies')
 
 import Options
 import Ruby
+import Network
 
 # Get paths we might need.  It's expected this file is in m5/configs/example.
 config_path = os.path.dirname(os.path.abspath(__file__))
@@ -63,6 +65,7 @@ parser.add_option("--percent-writes", type="int", default=100,
 # Add the ruby specific and protocol specific options
 #
 Ruby.define_options(parser)
+Network.define_options(parser)
 (options, args) = parser.parse_args()
 
 if args:
diff --git a/configs/example/ruby_gpu_random_test.py b/configs/example/ruby_gpu_random_test.py
index 48567bbfd..005546712 100644
--- a/configs/example/ruby_gpu_random_test.py
+++ b/configs/example/ruby_gpu_random_test.py
@@ -40,10 +40,12 @@ from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
 addToPath('../ruby')
+addToPath('../network')
 addToPath('../topologies')
 
 import Options
 import Ruby
+import Network
 
 # Get paths we might need.
 config_path = os.path.dirname(os.path.abspath(__file__))
@@ -76,6 +78,7 @@ parser.add_option("--wfs-per-simd", type="int", default=10, help="Number of " \
 # Add the ruby specific and protocol specific options
 #
 Ruby.define_options(parser)
+Network.define_options(parser)
 
 execfile(os.path.join(config_root, "common", "Options.py"))
 
diff --git a/configs/example/ruby_mem_test.py b/configs/example/ruby_mem_test.py
index b6e153be4..d7d36d687 100644
--- a/configs/example/ruby_mem_test.py
+++ b/configs/example/ruby_mem_test.py
@@ -35,10 +35,12 @@ from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
 addToPath('../ruby')
+addToPath('../network')
 addToPath('../topologies')
 
 import Options
 import Ruby
+import Network
 
 # Get paths we might need.  It's expected this file is in m5/configs/example.
 config_path = os.path.dirname(os.path.abspath(__file__))
@@ -63,6 +65,7 @@ parser.add_option("--suppress-func-warnings", action="store_true",
 # Add the ruby specific and protocol specific options
 #
 Ruby.define_options(parser)
+Network.define_options(parser)
 
 execfile(os.path.join(config_root, "common", "Options.py"))
 
diff --git a/configs/example/ruby_random_test.py b/configs/example/ruby_random_test.py
index 10d4318c7..44df082b3 100644
--- a/configs/example/ruby_random_test.py
+++ b/configs/example/ruby_random_test.py
@@ -35,10 +35,12 @@ from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
 addToPath('../ruby')
+addToPath('../network')
 addToPath('../topologies')
 
 import Options
 import Ruby
+import Network
 
 # Get paths we might need.  It's expected this file is in m5/configs/example.
 config_path = os.path.dirname(os.path.abspath(__file__))
@@ -57,6 +59,7 @@ parser.add_option("-f", "--wakeup_freq", metavar="N", default=10,
 # Add the ruby specific and protocol specific options
 #
 Ruby.define_options(parser)
+Network.define_options(parser)
 
 execfile(os.path.join(config_root, "common", "Options.py"))
 
diff --git a/configs/example/se.py b/configs/example/se.py
index 1b3458709..238aa9e64 100644
--- a/configs/example/se.py
+++ b/configs/example/se.py
@@ -53,9 +53,11 @@ from m5.util import addToPath, fatal
 
 addToPath('../common')
 addToPath('../ruby')
+addToPath('../network')
 
 import Options
 import Ruby
+import Network
 import Simulation
 import CacheConfig
 import CpuConfig
@@ -127,6 +129,7 @@ Options.addSEOptions(parser)
 
 if '--ruby' in sys.argv:
     Ruby.define_options(parser)
+    Network.define_options(parser)
 
 (options, args) = parser.parse_args()
 
diff --git a/configs/network/Network.py b/configs/network/Network.py
new file mode 100644
index 000000000..871682ff1
--- /dev/null
+++ b/configs/network/Network.py
@@ -0,0 +1,93 @@
+# Copyright (c) 2016 Georgia Institute of Technology
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Tushar Krishna
+
+import math
+import m5
+from m5.objects import *
+from m5.defines import buildEnv
+from m5.util import addToPath, fatal
+
+def define_options(parser):
+    # By default, ruby uses the simple timing cpu
+    parser.set_defaults(cpu_type="timing")
+
+    parser.add_option("--topology", type="string", default="Crossbar",
+                      help="check configs/topologies for complete set")
+    parser.add_option("--mesh-rows", type="int", default=1,
+                      help="the number of rows in the mesh topology")
+    parser.add_option("--garnet-network", type="choice",
+                      choices=['fixed', 'flexible'], help="'fixed'|'flexible'")
+    parser.add_option("--network-fault-model", action="store_true", default=False,
+                      help="enable network fault model: see src/mem/ruby/network/fault_model/")
+
+
+def create_network(options, ruby):
+
+    # Set the network classes based on the command line options
+    if options.garnet_network == "fixed":
+        NetworkClass = GarnetNetwork_d
+        IntLinkClass = GarnetIntLink_d
+        ExtLinkClass = GarnetExtLink_d
+        RouterClass = GarnetRouter_d
+        InterfaceClass = GarnetNetworkInterface_d
+
+    elif options.garnet_network == "flexible":
+        NetworkClass = GarnetNetwork
+        IntLinkClass = GarnetIntLink
+        ExtLinkClass = GarnetExtLink
+        RouterClass = GarnetRouter
+        InterfaceClass = GarnetNetworkInterface
+
+    else:
+        NetworkClass = SimpleNetwork
+        IntLinkClass = SimpleIntLink
+        ExtLinkClass = SimpleExtLink
+        RouterClass = Switch
+        InterfaceClass = None
+
+    # Instantiate the network object
+    # so that the controllers can connect to it.
+    network = NetworkClass(ruby_system = ruby, topology = options.topology,
+            routers = [], ext_links = [], int_links = [], netifs = [])
+
+    return (network, IntLinkClass, ExtLinkClass, RouterClass, InterfaceClass)
+
+def init_network(options, network, InterfaceClass):
+
+    if options.garnet_network is None:
+        network.setup_buffers()
+
+    if InterfaceClass != None:
+        netifs = [InterfaceClass(id=i) \
+                  for (i,n) in enumerate(network.ext_links)]
+        network.netifs = netifs
+
+    if options.network_fault_model:
+        assert(options.garnet_network == "fixed")
+        network.enable_fault_model = True
+        network.fault_model = FaultModel()
diff --git a/configs/ruby/Ruby.py b/configs/ruby/Ruby.py
index 1a8360f23..2670c678a 100644
--- a/configs/ruby/Ruby.py
+++ b/configs/ruby/Ruby.py
@@ -47,6 +47,9 @@ from m5.util import addToPath, fatal
 
 import MemConfig
 addToPath('../topologies')
+addToPath('../network')
+
+import Network
 
 def define_options(parser):
     # By default, ruby uses the simple timing cpu
@@ -64,15 +67,7 @@ def define_options(parser):
                       help="used of transitions per cycle which is a proxy \
                             for the number of ports.")
 
-    # ruby network options
-    parser.add_option("--topology", type="string", default="Crossbar",
-                      help="check configs/topologies for complete set")
-    parser.add_option("--mesh-rows", type="int", default=1,
-                      help="the number of rows in the mesh topology")
-    parser.add_option("--garnet-network", type="choice",
-                      choices=['fixed', 'flexible'], help="'fixed'|'flexible'")
-    parser.add_option("--network-fault-model", action="store_true", default=False,
-                      help="enable network fault model: see src/mem/ruby/network/fault_model/")
+    # network options are in network/Network.py
 
     # ruby mapping options
     parser.add_option("--numa-high-bit", type="int", default=0,
@@ -155,31 +150,9 @@ def create_system(options, full_system, system, piobus = None, dma_ports = []):
     system.ruby = RubySystem()
     ruby = system.ruby
 
-    # Set the network classes based on the command line options
-    if options.garnet_network == "fixed":
-        NetworkClass = GarnetNetwork_d
-        IntLinkClass = GarnetIntLink_d
-        ExtLinkClass = GarnetExtLink_d
-        RouterClass = GarnetRouter_d
-        InterfaceClass = GarnetNetworkInterface_d
-
-    elif options.garnet_network == "flexible":
-        NetworkClass = GarnetNetwork
-        IntLinkClass = GarnetIntLink
-        ExtLinkClass = GarnetExtLink
-        RouterClass = GarnetRouter
-        InterfaceClass = GarnetNetworkInterface
-
-    else:
-        NetworkClass = SimpleNetwork
-        IntLinkClass = SimpleIntLink
-        ExtLinkClass = SimpleExtLink
-        RouterClass = Switch
-        InterfaceClass = None
-
-    # Instantiate the network object so that the controllers can connect to it.
-    network = NetworkClass(ruby_system = ruby, topology = options.topology,
-            routers = [], ext_links = [], int_links = [], netifs = [])
+    # Create the network object
+    (network, IntLinkClass, ExtLinkClass, RouterClass, InterfaceClass) = \
+        Network.create_network(options, ruby)
     ruby.network = network
 
     protocol = buildEnv['PROTOCOL']
@@ -193,6 +166,13 @@ def create_system(options, full_system, system, piobus = None, dma_ports = []):
         print "Error: could not create sytem for ruby protocol %s" % protocol
         raise
 
+    # Create the network topology
+    topology.makeTopology(options, network, IntLinkClass, ExtLinkClass,
+            RouterClass)
+
+    # Initialize network based on topology
+    Network.init_network(options, network, InterfaceClass)
+
     # Create a port proxy for connecting the system port. This is
     # independent of the protocol and kept in the protocol-agnostic
     # part (i.e. here).
@@ -207,24 +187,6 @@ def create_system(options, full_system, system, piobus = None, dma_ports = []):
     # Connect the system port for loading of binaries etc
     system.system_port = system.sys_port_proxy.slave
 
-    # Create the network topology
-    topology.makeTopology(options, network, IntLinkClass, ExtLinkClass,
-            RouterClass)
-
-    if options.garnet_network is None:
-        assert(NetworkClass == SimpleNetwork)
-        assert(RouterClass == Switch)
-        network.setup_buffers()
-
-    if InterfaceClass != None:
-        netifs = [InterfaceClass(id=i) for (i,n) in enumerate(network.ext_links)]
-        network.netifs = netifs
-
-    if options.network_fault_model:
-        assert(options.garnet_network == "fixed")
-        network.enable_fault_model = True
-        network.fault_model = FaultModel()
-
     setup_memory_controllers(system, ruby, dir_cntrls, options)
 
     # Connect the cpu sequencers and the piobus