ruby: Fix regressions and make Ruby configs Python packages

This patch moves the addition of network options into the Ruby module
to avoid the regressions all having to add it explicitly. Doing this
exposes an issue in our current config system though, namely the fact
that addtoPath is relative to the Python script being executed. Since
both example and regression scripts use the Ruby module we would end
up with two different (relative) paths being added. Instead we take a
first step at turning the config modules into Python packages, simply
by adding a __init__.py in the configs/ruby, configs/topologies and
configs/network subdirectories.

As a result, we can now add the top-level configs directory to the
Python search path, and then use the package names in the various
modules. The example scripts are also updated, and the messy
path-deducing variations in the scripts are unified.

configs/example/apu_se.py

@@ -42,14 +42,12 @@ import m5
 from m5.objects import *
 from m5.util import addToPath
 
-addToPath('../ruby')
+addToPath('../')
-addToPath('../network')
 addToPath('../common')
-addToPath('../topologies')
+
+from ruby import Ruby
 
 import Options
-import Ruby
-import Network
 import Simulation
 import GPUTLBOptions, GPUTLBConfig
 
@@ -159,7 +157,6 @@ 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)

configs/example/fs.py

@@ -49,12 +49,10 @@ from m5.defines import buildEnv
 from m5.objects import *
 from m5.util import addToPath, fatal
 
+addToPath('../')
 addToPath('../common')
-addToPath('../ruby')
-addToPath('../network')
 
-import Ruby
+from ruby import Ruby
-import Network
 
 from FSConfig import *
 from SysPaths import *
@@ -308,7 +306,6 @@ 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()
 

configs/example/garnet_synth_traffic.py

@@ -32,13 +32,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
-addToPath('../ruby')
+addToPath('../')
-addToPath('../network')
-addToPath('../topologies')
 
 import Options
-import Ruby
+from ruby 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__))
@@ -87,7 +84,6 @@ 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"))
 

configs/example/ruby_direct_test.py

@@ -34,13 +34,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
-addToPath('../ruby')
+addToPath('../')
-addToPath('../network')
-addToPath('../topologies')
 
 import Options
-import Ruby
+from ruby 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__))
@@ -65,7 +62,6 @@ 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:

configs/example/ruby_gpu_random_test.py

@@ -39,13 +39,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
-addToPath('../ruby')
+addToPath('../')
-addToPath('../network')
-addToPath('../topologies')
 
 import Options
-import Ruby
+from ruby import Ruby
-import Network
 
 # Get paths we might need.
 config_path = os.path.dirname(os.path.abspath(__file__))
@@ -78,7 +75,6 @@ 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"))
 

configs/example/ruby_mem_test.py

@@ -34,13 +34,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
-addToPath('../ruby')
+addToPath('../')
-addToPath('../network')
-addToPath('../topologies')
 
 import Options
-import Ruby
+from ruby 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__))
@@ -65,7 +62,6 @@ 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"))
 

configs/example/ruby_random_test.py

@@ -34,13 +34,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 addToPath('../common')
-addToPath('../ruby')
+addToPath('../')
-addToPath('../network')
-addToPath('../topologies')
 
 import Options
-import Ruby
+from ruby 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__))
@@ -59,7 +56,6 @@ 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"))
 

configs/example/se.py

@@ -51,13 +51,12 @@ from m5.defines import buildEnv
 from m5.objects import *
 from m5.util import addToPath, fatal
 
+addToPath('../')
 addToPath('../common')
-addToPath('../ruby')
+
-addToPath('../network')
+from ruby import Ruby
 
 import Options
-import Ruby
-import Network
 import Simulation
 import CacheConfig
 import CpuConfig
@@ -129,7 +128,6 @@ Options.addSEOptions(parser)
 
 if '--ruby' in sys.argv:
     Ruby.define_options(parser)
-    Network.define_options(parser)
 
 (options, args) = parser.parse_args()
 

configs/network/__init__.py

@@ -0,0 +1,36 @@
+# Copyright (c) 2016 ARM Limited
+# All rights reserved.
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# 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: Andreas Hansson

configs/ruby/AMD_Base_Constructor.py

@@ -39,7 +39,7 @@ from m5.objects import *
 from m5.defines import buildEnv
 from m5.util import convert
 from CntrlBase import *
-from Cluster import Cluster
+from topologies.Cluster import Cluster
 
 #
 # Note: the L1 Cache latency is only used by the sequencer on fast path hits

configs/ruby/GPU_RfO.py

@@ -40,8 +40,8 @@ from m5.defines import buildEnv
 from Ruby import create_topology
 from Ruby import send_evicts
 
-from Cluster import Cluster
+from topologies.Cluster import Cluster
-from Crossbar import Crossbar
+from topologies.Crossbar import Crossbar
 
 class CntrlBase:
     _seqs = 0

configs/ruby/GPU_VIPER.py

@@ -40,8 +40,8 @@ from m5.defines import buildEnv
 from Ruby import create_topology
 from Ruby import send_evicts
 
-from Cluster import Cluster
+from topologies.Cluster import Cluster
-from Crossbar import Crossbar
+from topologies.Crossbar import Crossbar
 
 class CntrlBase:
     _seqs = 0

configs/ruby/GPU_VIPER_Baseline.py

@@ -40,8 +40,8 @@ from m5.defines import buildEnv
 from Ruby import create_topology
 from Ruby import send_evicts
 
-from Cluster import Cluster
+from topologies.Cluster import Cluster
-from Crossbar import Crossbar
+from topologies.Crossbar import Crossbar
 
 class CntrlBase:
     _seqs = 0

configs/ruby/GPU_VIPER_Region.py

@@ -39,7 +39,7 @@ from m5.objects import *
 from m5.defines import buildEnv
 from Ruby import send_evicts
 
-from Cluster import Cluster
+from topologies.Cluster import Cluster
 
 class CntrlBase:
     _seqs = 0

configs/ruby/MOESI_AMD_Base.py

@@ -40,8 +40,8 @@ from m5.defines import buildEnv
 from Ruby import create_topology
 from Ruby import send_evicts
 
-from Cluster import Cluster
+from topologies.Cluster import Cluster
-from Crossbar import Crossbar
+from topologies.Crossbar import Crossbar
 
 class CntrlBase:
     _seqs = 0

configs/ruby/Ruby.py

@@ -46,10 +46,9 @@ from m5.defines import buildEnv
 from m5.util import addToPath, fatal
 
 import MemConfig
-addToPath('../topologies')
-addToPath('../network')
 
-import Network
+from topologies import *
+from network import Network
 
 def define_options(parser):
     # By default, ruby uses the simple timing cpu
@@ -80,6 +79,7 @@ def define_options(parser):
     protocol = buildEnv['PROTOCOL']
     exec "import %s" % protocol
     eval("%s.define_options(parser)" % protocol)
+    Network.define_options(parser)
 
 def setup_memory_controllers(system, ruby, dir_cntrls, options):
     ruby.block_size_bytes = options.cacheline_size
@@ -141,7 +141,7 @@ def create_topology(controllers, options):
         found in configs/topologies/BaseTopology.py
         This is a wrapper for the legacy topologies.
     """
-    exec "import %s as Topo" % options.topology
+    exec "import topologies.%s as Topo" % options.topology
     topology = eval("Topo.%s(controllers)" % options.topology)
     return topology
 

configs/ruby/__init__.py

@@ -0,0 +1,36 @@
+# Copyright (c) 2016 ARM Limited
+# All rights reserved.
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# 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: Andreas Hansson

configs/topologies/__init__.py

@@ -0,0 +1,36 @@
+# Copyright (c) 2016 ARM Limited
+# All rights reserved.
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# 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: Andreas Hansson

tests/configs/gpu-randomtest-ruby.py

@@ -39,15 +39,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 
-# Get paths we might need.  It's expected this file is in m5/configs/example.
+m5.util.addToPath('../configs/common')
-config_path = os.path.dirname(os.path.abspath(__file__))
+m5.util.addToPath('../configs/')
-config_root = os.path.dirname(config_path)
-m5_root = os.path.dirname(config_root)
-addToPath(config_root+'/configs/common')
-addToPath(config_root+'/configs/ruby')
-addToPath(config_root+'/configs/topologies')
 
-import Ruby
+from ruby import Ruby
 import Options
 
 parser = optparse.OptionParser()

tests/configs/gpu-ruby.py

@@ -39,14 +39,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys, math, glob
 
-# Get paths we might need
+m5.util.addToPath('../configs/common')
-config_path = os.path.dirname(os.path.abspath(__file__))
+m5.util.addToPath('../configs/')
-config_root = os.path.dirname(config_path)
-addToPath(config_root+'/configs/common')
-addToPath(config_root+'/configs/ruby')
-addToPath(config_root+'/configs/topologies')
 
-import Ruby
+from ruby import Ruby
 import Options
 import GPUTLBOptions, GPUTLBConfig
 

tests/configs/memtest-ruby.py

@@ -33,15 +33,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 
-# Get paths we might need
+m5.util.addToPath('../configs/common')
-config_path = os.path.dirname(os.path.abspath(__file__))
+m5.util.addToPath('../configs/')
-config_root = os.path.dirname(config_path)
-m5_root = os.path.dirname(config_root)
-addToPath(config_root+'/configs/common')
-addToPath(config_root+'/configs/ruby')
-addToPath(config_root+'/configs/topologies')
 
-import Ruby
+from ruby import Ruby
 import Options
 
 parser = optparse.OptionParser()

tests/configs/o3-timing-mp-ruby.py

@@ -29,7 +29,6 @@
 import m5
 from m5.objects import *
 m5.util.addToPath('../configs/common')
-m5.util.addToPath('../configs/topologies')
 
 nb_cores = 4
 cpus = [ DerivO3CPU(cpu_id=i) for i in xrange(nb_cores) ]

tests/configs/o3-timing-ruby.py

@@ -29,7 +29,6 @@
 import m5
 from m5.objects import *
 m5.util.addToPath('../configs/common')
-m5.util.addToPath('../configs/topologies')
 
 
 import ruby_config

tests/configs/pc-simple-timing-ruby.py

@@ -32,9 +32,8 @@ m5.util.addToPath('../configs/common')
 from Benchmarks import SysConfig
 import FSConfig
 
-m5.util.addToPath('../configs/ruby')
+m5.util.addToPath('../configs/')
-m5.util.addToPath('../configs/topologies')
+from ruby import Ruby
-import Ruby
 import Options
 
 # Add the ruby specific and protocol specific options

tests/configs/rubytest-ruby.py

@@ -34,15 +34,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 
-# Get paths we might need.  It's expected this file is in m5/configs/example.
+m5.util.addToPath('../configs/common')
-config_path = os.path.dirname(os.path.abspath(__file__))
+m5.util.addToPath('../configs/')
-config_root = os.path.dirname(config_path)
-m5_root = os.path.dirname(config_root)
-addToPath(config_root+'/configs/common')
-addToPath(config_root+'/configs/ruby')
-addToPath(config_root+'/configs/topologies')
 
-import Ruby
+from ruby import Ruby
 import Options
 
 parser = optparse.OptionParser()

tests/configs/simple-atomic-mp-ruby.py

@@ -28,8 +28,6 @@
 
 import m5
 from m5.objects import *
-m5.util.addToPath('../configs/topologies')
-
 
 nb_cores = 4
 cpus = [ AtomicSimpleCPU(cpu_id=i) for i in xrange(nb_cores) ]

tests/configs/simple-timing-mp-ruby.py

@@ -32,16 +32,11 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 
-# Get paths we might need
+m5.util.addToPath('../configs/common')
-config_path = os.path.dirname(os.path.abspath(__file__))
+m5.util.addToPath('../configs/')
-config_root = os.path.dirname(config_path)
-m5_root = os.path.dirname(config_root)
-addToPath(config_root+'/configs/common')
-addToPath(config_root+'/configs/ruby')
-addToPath(config_root+'/configs/topologies')
 
 import Options
-import Ruby
+from ruby import Ruby
 
 parser = optparse.OptionParser()
 Options.addCommonOptions(parser)

tests/configs/simple-timing-ruby.py

@@ -32,14 +32,10 @@ from m5.defines import buildEnv
 from m5.util import addToPath
 import os, optparse, sys
 
-# Get paths we might need
+m5.util.addToPath('../configs/common')
-config_path = os.path.dirname(os.path.abspath(__file__))
+m5.util.addToPath('../configs/')
-config_root = os.path.dirname(config_path)
-addToPath(config_root+'/configs/common')
-addToPath(config_root+'/configs/ruby')
-addToPath(config_root+'/configs/topologies')
 
-import Ruby
+from ruby import Ruby
 import Options
 
 parser = optparse.OptionParser()