configs/ruby/Ruby.py - arm/gem5 - Git at Google

 # Copyright (c) 2012 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.
 #
 # Copyright (c) 2006-2007 The Regents of The University of Michigan
 # Copyright (c) 2009 Advanced Micro Devices, Inc.
 # 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: Brad Beckmann

 import math
 import m5
 from m5.objects import *
 from m5.defines import buildEnv

 def define_options(parser):
     # By default, ruby uses the simple timing cpu
     parser.set_defaults(cpu_type="timing")

     parser.add_option("--ruby-clock", action="store", type="string",
                       default='2GHz',
                       help="Clock for blocks running at Ruby system's speed")

     # ruby network options
     parser.add_option("--topology", type="string", default="Crossbar",
                  help="check src/mem/ruby/network/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/")

     # ruby mapping options
     parser.add_option("--numa-high-bit", type="int", default=0,
                       help="high order address bit to use for numa mapping. " \
                            "0 = highest bit, not specified = lowest bit")

     # ruby sparse memory options
     parser.add_option("--use-map", action="store_true", default=False)
     parser.add_option("--map-levels", type="int", default=4)

     parser.add_option("--recycle-latency", type="int", default=10,
                       help="Recycle latency for ruby controller input buffers")

     parser.add_option("--random_seed", type="int", default=1234,
                       help="Used for seeding the random number generator")

     parser.add_option("--ruby_stats", type="string", default="ruby.stats")

     protocol = buildEnv['PROTOCOL']
     exec "import %s" % protocol
     eval("%s.define_options(parser)" % protocol)

 def create_topology(controllers, options):
     """ Called from create_system in configs/ruby/<protocol>.py
         Must return an object which is a subclass of BaseTopology
         found in configs/topologies/BaseTopology.py
         This is a wrapper for the legacy topologies.
     """
     exec "import %s as Topo" % options.topology
     topology = eval("Topo.%s(controllers)" % options.topology)
     return topology

 def create_system(options, system, piobus = None, dma_ports = []):

     system.ruby = RubySystem(stats_filename = options.ruby_stats,
                              no_mem_vec = options.use_map)
     ruby = system.ruby

     protocol = buildEnv['PROTOCOL']
     exec "import %s" % protocol
     try:
         (cpu_sequencers, dir_cntrls, topology) = \
              eval("%s.create_system(options, system, piobus, dma_ports, ruby)"
                   % protocol)
     except:
         print "Error: could not create sytem for ruby protocol %s" % protocol
         raise

     # 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).
     sys_port_proxy = RubyPortProxy(ruby_system = ruby)
     # Give the system port proxy a SimObject parent without creating a
     # full-fledged controller
     system.sys_port_proxy = sys_port_proxy

     # Connect the system port for loading of binaries etc
     system.system_port = system.sys_port_proxy.slave


     #
     # Set the network classes based on the command line options
     #
     if options.garnet_network == "fixed":
         class NetworkClass(GarnetNetwork_d): pass
         class IntLinkClass(GarnetIntLink_d): pass
         class ExtLinkClass(GarnetExtLink_d): pass
         class RouterClass(GarnetRouter_d): pass
     elif options.garnet_network == "flexible":
         class NetworkClass(GarnetNetwork): pass
         class IntLinkClass(GarnetIntLink): pass
         class ExtLinkClass(GarnetExtLink): pass
         class RouterClass(GarnetRouter): pass
     else:
         class NetworkClass(SimpleNetwork): pass
         class IntLinkClass(SimpleIntLink): pass
         class ExtLinkClass(SimpleExtLink): pass
         class RouterClass(Switch): pass

     #
     # Important: the topology must be instantiated before the network and after
     # the controllers. Hence the separation between topology definition and
     # instantiation.
     #

     routers, int_links, ext_links = topology.makeTopology(options,
                                     IntLinkClass, ExtLinkClass, RouterClass)
     network = NetworkClass(ruby_system = ruby, routers = routers,
                            int_links = int_links, ext_links = ext_links,
                            topology = topology.description)

     if options.network_fault_model:
         assert(options.garnet_network == "fixed")
         network.enable_fault_model = True
         network.fault_model = FaultModel()

     #
     # Loop through the directory controlers.
     # Determine the total memory size of the ruby system and verify it is equal
     # to physmem.  However, if Ruby memory is using sparse memory in SE
     # mode, then the system should not back-up the memory state with
     # the Memory Vector and thus the memory size bytes should stay at 0.
     # Also set the numa bits to the appropriate values.
     #
     total_mem_size = MemorySize('0B')

     dir_bits = int(math.log(options.num_dirs, 2))
     ruby.block_size_bytes = options.cacheline_size
     block_size_bits = int(math.log(options.cacheline_size, 2))

     if options.numa_high_bit:
         numa_bit = options.numa_high_bit
     else:
         # if the numa_bit is not specified, set the directory bits as the
         # lowest bits above the block offset bits, and the numa_bit as the
         # highest of those directory bits
         numa_bit = block_size_bits + dir_bits - 1

     for dir_cntrl in dir_cntrls:
         total_mem_size.value += dir_cntrl.directory.size.value
         dir_cntrl.directory.numa_high_bit = numa_bit

     phys_mem_size = sum(map(lambda mem: mem.range.size(),
                             system.memories.unproxy(system)))
     assert(total_mem_size.value == phys_mem_size)

     ruby_profiler = RubyProfiler(ruby_system = ruby,
                                  num_of_sequencers = len(cpu_sequencers))
     ruby.network = network
     ruby.profiler = ruby_profiler
     ruby.mem_size = total_mem_size
     ruby._cpu_ruby_ports = cpu_sequencers
     ruby.random_seed    = options.random_seed
	# Copyright (c) 2012 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.
	#
	# Copyright (c) 2006-2007 The Regents of The University of Michigan
	# Copyright (c) 2009 Advanced Micro Devices, Inc.
	# 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: Brad Beckmann

	import math
	import m5
	from m5.objects import *
	from m5.defines import buildEnv

	def define_options(parser):
	# By default, ruby uses the simple timing cpu
	parser.set_defaults(cpu_type="timing")

	parser.add_option("--ruby-clock", action="store", type="string",
	default='2GHz',
	help="Clock for blocks running at Ruby system's speed")

	# ruby network options
	parser.add_option("--topology", type="string", default="Crossbar",
	help="check src/mem/ruby/network/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/")

	# ruby mapping options
	parser.add_option("--numa-high-bit", type="int", default=0,
	help="high order address bit to use for numa mapping. " \
	"0 = highest bit, not specified = lowest bit")

	# ruby sparse memory options
	parser.add_option("--use-map", action="store_true", default=False)
	parser.add_option("--map-levels", type="int", default=4)

	parser.add_option("--recycle-latency", type="int", default=10,
	help="Recycle latency for ruby controller input buffers")

	parser.add_option("--random_seed", type="int", default=1234,
	help="Used for seeding the random number generator")

	parser.add_option("--ruby_stats", type="string", default="ruby.stats")

	protocol = buildEnv['PROTOCOL']
	exec "import %s" % protocol
	eval("%s.define_options(parser)" % protocol)

	def create_topology(controllers, options):
	""" Called from create_system in configs/ruby/<protocol>.py
	Must return an object which is a subclass of BaseTopology
	found in configs/topologies/BaseTopology.py
	This is a wrapper for the legacy topologies.
	"""
	exec "import %s as Topo" % options.topology
	topology = eval("Topo.%s(controllers)" % options.topology)
	return topology

	def create_system(options, system, piobus = None, dma_ports = []):

	system.ruby = RubySystem(stats_filename = options.ruby_stats,
	no_mem_vec = options.use_map)
	ruby = system.ruby

	protocol = buildEnv['PROTOCOL']
	exec "import %s" % protocol
	try:
	(cpu_sequencers, dir_cntrls, topology) = \
	eval("%s.create_system(options, system, piobus, dma_ports, ruby)"
	% protocol)
	except:
	print "Error: could not create sytem for ruby protocol %s" % protocol
	raise

	# 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).
	sys_port_proxy = RubyPortProxy(ruby_system = ruby)
	# Give the system port proxy a SimObject parent without creating a
	# full-fledged controller
	system.sys_port_proxy = sys_port_proxy

	# Connect the system port for loading of binaries etc
	system.system_port = system.sys_port_proxy.slave


	#
	# Set the network classes based on the command line options
	#
	if options.garnet_network == "fixed":
	class NetworkClass(GarnetNetwork_d): pass
	class IntLinkClass(GarnetIntLink_d): pass
	class ExtLinkClass(GarnetExtLink_d): pass
	class RouterClass(GarnetRouter_d): pass
	elif options.garnet_network == "flexible":
	class NetworkClass(GarnetNetwork): pass
	class IntLinkClass(GarnetIntLink): pass
	class ExtLinkClass(GarnetExtLink): pass
	class RouterClass(GarnetRouter): pass
	else:
	class NetworkClass(SimpleNetwork): pass
	class IntLinkClass(SimpleIntLink): pass
	class ExtLinkClass(SimpleExtLink): pass
	class RouterClass(Switch): pass

	#
	# Important: the topology must be instantiated before the network and after
	# the controllers. Hence the separation between topology definition and
	# instantiation.
	#

	routers, int_links, ext_links = topology.makeTopology(options,
	IntLinkClass, ExtLinkClass, RouterClass)
	network = NetworkClass(ruby_system = ruby, routers = routers,
	int_links = int_links, ext_links = ext_links,
	topology = topology.description)

	if options.network_fault_model:
	assert(options.garnet_network == "fixed")
	network.enable_fault_model = True
	network.fault_model = FaultModel()

	#
	# Loop through the directory controlers.
	# Determine the total memory size of the ruby system and verify it is equal
	# to physmem. However, if Ruby memory is using sparse memory in SE
	# mode, then the system should not back-up the memory state with
	# the Memory Vector and thus the memory size bytes should stay at 0.
	# Also set the numa bits to the appropriate values.
	#
	total_mem_size = MemorySize('0B')

	dir_bits = int(math.log(options.num_dirs, 2))
	ruby.block_size_bytes = options.cacheline_size
	block_size_bits = int(math.log(options.cacheline_size, 2))

	if options.numa_high_bit:
	numa_bit = options.numa_high_bit
	else:
	# if the numa_bit is not specified, set the directory bits as the
	# lowest bits above the block offset bits, and the numa_bit as the
	# highest of those directory bits
	numa_bit = block_size_bits + dir_bits - 1

	for dir_cntrl in dir_cntrls:
	total_mem_size.value += dir_cntrl.directory.size.value
	dir_cntrl.directory.numa_high_bit = numa_bit

	phys_mem_size = sum(map(lambda mem: mem.range.size(),
	system.memories.unproxy(system)))
	assert(total_mem_size.value == phys_mem_size)

	ruby_profiler = RubyProfiler(ruby_system = ruby,
	num_of_sequencers = len(cpu_sequencers))
	ruby.network = network
	ruby.profiler = ruby_profiler
	ruby.mem_size = total_mem_size
	ruby._cpu_ruby_ports = cpu_sequencers
	ruby.random_seed = options.random_seed