Ruby.py revision 12976
112598Snikos.nikoleris@arm.com# Copyright (c) 2012, 2017-2018 ARM Limited 28706Sandreas.hansson@arm.com# All rights reserved. 38706Sandreas.hansson@arm.com# 48706Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 58706Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 68706Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 78706Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 88706Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 98706Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 108706Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 118706Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 128706Sandreas.hansson@arm.com# 136892SBrad.Beckmann@amd.com# Copyright (c) 2006-2007 The Regents of The University of Michigan 146892SBrad.Beckmann@amd.com# Copyright (c) 2009 Advanced Micro Devices, Inc. 156892SBrad.Beckmann@amd.com# All rights reserved. 166892SBrad.Beckmann@amd.com# 176892SBrad.Beckmann@amd.com# Redistribution and use in source and binary forms, with or without 186892SBrad.Beckmann@amd.com# modification, are permitted provided that the following conditions are 196892SBrad.Beckmann@amd.com# met: redistributions of source code must retain the above copyright 206892SBrad.Beckmann@amd.com# notice, this list of conditions and the following disclaimer; 216892SBrad.Beckmann@amd.com# redistributions in binary form must reproduce the above copyright 226892SBrad.Beckmann@amd.com# notice, this list of conditions and the following disclaimer in the 236892SBrad.Beckmann@amd.com# documentation and/or other materials provided with the distribution; 246892SBrad.Beckmann@amd.com# neither the name of the copyright holders nor the names of its 256892SBrad.Beckmann@amd.com# contributors may be used to endorse or promote products derived from 266892SBrad.Beckmann@amd.com# this software without specific prior written permission. 276892SBrad.Beckmann@amd.com# 286892SBrad.Beckmann@amd.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 296892SBrad.Beckmann@amd.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 306892SBrad.Beckmann@amd.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 316892SBrad.Beckmann@amd.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 326892SBrad.Beckmann@amd.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 336892SBrad.Beckmann@amd.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 346892SBrad.Beckmann@amd.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 356892SBrad.Beckmann@amd.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 366892SBrad.Beckmann@amd.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 376892SBrad.Beckmann@amd.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 386892SBrad.Beckmann@amd.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 396892SBrad.Beckmann@amd.com# 406892SBrad.Beckmann@amd.com# Authors: Brad Beckmann 416892SBrad.Beckmann@amd.com 4212564Sgabeblack@google.comfrom __future__ import print_function 4312564Sgabeblack@google.com 447563SBrad.Beckmann@amd.comimport math 456892SBrad.Beckmann@amd.comimport m5 466892SBrad.Beckmann@amd.comfrom m5.objects import * 476892SBrad.Beckmann@amd.comfrom m5.defines import buildEnv 4810118Snilay@cs.wisc.edufrom m5.util import addToPath, fatal 4910118Snilay@cs.wisc.edu 5011682Sandreas.hansson@arm.comfrom common import MemConfig 5111662Stushar@ece.gatech.edu 5211670Sandreas.hansson@arm.comfrom topologies import * 5311670Sandreas.hansson@arm.comfrom network import Network 546892SBrad.Beckmann@amd.com 557538SBrad.Beckmann@amd.comdef define_options(parser): 568939SBrad.Beckmann@amd.com # By default, ruby uses the simple timing cpu 5712014Sgabeblack@google.com parser.set_defaults(cpu_type="TimingSimpleCPU") 588939SBrad.Beckmann@amd.com 599791Sakash.bagdia@arm.com parser.add_option("--ruby-clock", action="store", type="string", 609791Sakash.bagdia@arm.com default='2GHz', 619791Sakash.bagdia@arm.com help="Clock for blocks running at Ruby system's speed") 629791Sakash.bagdia@arm.com 6310525Snilay@cs.wisc.edu parser.add_option("--access-backing-store", action="store_true", default=False, 6410525Snilay@cs.wisc.edu help="Should ruby maintain a second copy of memory") 6510525Snilay@cs.wisc.edu 669841Snilay@cs.wisc.edu # Options related to cache structure 679841Snilay@cs.wisc.edu parser.add_option("--ports", action="store", type="int", default=4, 689841Snilay@cs.wisc.edu help="used of transitions per cycle which is a proxy \ 699841Snilay@cs.wisc.edu for the number of ports.") 709841Snilay@cs.wisc.edu 7111662Stushar@ece.gatech.edu # network options are in network/Network.py 727538SBrad.Beckmann@amd.com 737538SBrad.Beckmann@amd.com # ruby mapping options 747917SBrad.Beckmann@amd.com parser.add_option("--numa-high-bit", type="int", default=0, 757563SBrad.Beckmann@amd.com help="high order address bit to use for numa mapping. " \ 767563SBrad.Beckmann@amd.com "0 = highest bit, not specified = lowest bit") 777538SBrad.Beckmann@amd.com 787566SBrad.Beckmann@amd.com parser.add_option("--recycle-latency", type="int", default=10, 797566SBrad.Beckmann@amd.com help="Recycle latency for ruby controller input buffers") 807809Snilay@cs.wisc.edu 817538SBrad.Beckmann@amd.com protocol = buildEnv['PROTOCOL'] 827538SBrad.Beckmann@amd.com exec "import %s" % protocol 837538SBrad.Beckmann@amd.com eval("%s.define_options(parser)" % protocol) 8411670Sandreas.hansson@arm.com Network.define_options(parser) 857538SBrad.Beckmann@amd.com 8610524Snilay@cs.wisc.edudef setup_memory_controllers(system, ruby, dir_cntrls, options): 8710524Snilay@cs.wisc.edu ruby.block_size_bytes = options.cacheline_size 8810524Snilay@cs.wisc.edu ruby.memory_size_bits = 48 8910524Snilay@cs.wisc.edu 9010524Snilay@cs.wisc.edu index = 0 9110524Snilay@cs.wisc.edu mem_ctrls = [] 9210524Snilay@cs.wisc.edu crossbars = [] 9310524Snilay@cs.wisc.edu 9412976Snikos.nikoleris@arm.com if options.numa_high_bit: 9512976Snikos.nikoleris@arm.com dir_bits = int(math.log(options.num_dirs, 2)) 9612976Snikos.nikoleris@arm.com intlv_size = 2 ** (options.numa_high_bit - dir_bits + 1) 9712976Snikos.nikoleris@arm.com else: 9812976Snikos.nikoleris@arm.com # if the numa_bit is not specified, set the directory bits as the 9912976Snikos.nikoleris@arm.com # lowest bits above the block offset bits 10012976Snikos.nikoleris@arm.com intlv_size = options.cacheline_size 10112976Snikos.nikoleris@arm.com 10210524Snilay@cs.wisc.edu # Sets bits to be used for interleaving. Creates memory controllers 10310524Snilay@cs.wisc.edu # attached to a directory controller. A separate controller is created 10410524Snilay@cs.wisc.edu # for each address range as the abstract memory can handle only one 10510524Snilay@cs.wisc.edu # contiguous address range as of now. 10610524Snilay@cs.wisc.edu for dir_cntrl in dir_cntrls: 10710524Snilay@cs.wisc.edu crossbar = None 10810524Snilay@cs.wisc.edu if len(system.mem_ranges) > 1: 10910720Sandreas.hansson@arm.com crossbar = IOXBar() 11010524Snilay@cs.wisc.edu crossbars.append(crossbar) 11110524Snilay@cs.wisc.edu dir_cntrl.memory = crossbar.slave 11210524Snilay@cs.wisc.edu 11312976Snikos.nikoleris@arm.com dir_ranges = [] 11410524Snilay@cs.wisc.edu for r in system.mem_ranges: 11510524Snilay@cs.wisc.edu mem_ctrl = MemConfig.create_mem_ctrl( 11610524Snilay@cs.wisc.edu MemConfig.get(options.mem_type), r, index, options.num_dirs, 11712976Snikos.nikoleris@arm.com int(math.log(options.num_dirs, 2)), intlv_size) 11810524Snilay@cs.wisc.edu 11911616Sdavid.j.hashe@gmail.com if options.access_backing_store: 12011616Sdavid.j.hashe@gmail.com mem_ctrl.kvm_map=False 12111616Sdavid.j.hashe@gmail.com 12210524Snilay@cs.wisc.edu mem_ctrls.append(mem_ctrl) 12312976Snikos.nikoleris@arm.com dir_ranges.append(mem_ctrl.range) 12410524Snilay@cs.wisc.edu 12510524Snilay@cs.wisc.edu if crossbar != None: 12610524Snilay@cs.wisc.edu mem_ctrl.port = crossbar.master 12710524Snilay@cs.wisc.edu else: 12810524Snilay@cs.wisc.edu mem_ctrl.port = dir_cntrl.memory 12910524Snilay@cs.wisc.edu 13010524Snilay@cs.wisc.edu index += 1 13112976Snikos.nikoleris@arm.com dir_cntrl.addr_ranges = dir_ranges 13210524Snilay@cs.wisc.edu 13310524Snilay@cs.wisc.edu system.mem_ctrls = mem_ctrls 13410524Snilay@cs.wisc.edu 13510524Snilay@cs.wisc.edu if len(crossbars) > 0: 13610524Snilay@cs.wisc.edu ruby.crossbars = crossbars 13710524Snilay@cs.wisc.edu 13810524Snilay@cs.wisc.edu 1399100SBrad.Beckmann@amd.comdef create_topology(controllers, options): 1409100SBrad.Beckmann@amd.com """ Called from create_system in configs/ruby/<protocol>.py 1419100SBrad.Beckmann@amd.com Must return an object which is a subclass of BaseTopology 1429100SBrad.Beckmann@amd.com found in configs/topologies/BaseTopology.py 1439100SBrad.Beckmann@amd.com This is a wrapper for the legacy topologies. 1449100SBrad.Beckmann@amd.com """ 14511670Sandreas.hansson@arm.com exec "import topologies.%s as Topo" % options.topology 1469100SBrad.Beckmann@amd.com topology = eval("Topo.%s(controllers)" % options.topology) 1479100SBrad.Beckmann@amd.com return topology 1489100SBrad.Beckmann@amd.com 14912598Snikos.nikoleris@arm.comdef create_system(options, full_system, system, piobus = None, dma_ports = [], 15012598Snikos.nikoleris@arm.com bootmem=None): 1516892SBrad.Beckmann@amd.com 15210524Snilay@cs.wisc.edu system.ruby = RubySystem() 1538436SBrad.Beckmann@amd.com ruby = system.ruby 1548436SBrad.Beckmann@amd.com 15511662Stushar@ece.gatech.edu # Create the network object 15611662Stushar@ece.gatech.edu (network, IntLinkClass, ExtLinkClass, RouterClass, InterfaceClass) = \ 15711662Stushar@ece.gatech.edu Network.create_network(options, ruby) 15810311Snilay@cs.wisc.edu ruby.network = network 15910311Snilay@cs.wisc.edu 16010551Ssteve.reinhardt@amd.com protocol = buildEnv['PROTOCOL'] 16110551Ssteve.reinhardt@amd.com exec "import %s" % protocol 16210311Snilay@cs.wisc.edu try: 16310311Snilay@cs.wisc.edu (cpu_sequencers, dir_cntrls, topology) = \ 16410551Ssteve.reinhardt@amd.com eval("%s.create_system(options, full_system, system, dma_ports,\ 16512598Snikos.nikoleris@arm.com bootmem, ruby)" 16610551Ssteve.reinhardt@amd.com % protocol) 16710311Snilay@cs.wisc.edu except: 16812564Sgabeblack@google.com print("Error: could not create sytem for ruby protocol %s" % protocol) 16910311Snilay@cs.wisc.edu raise 17010311Snilay@cs.wisc.edu 17111662Stushar@ece.gatech.edu # Create the network topology 17211662Stushar@ece.gatech.edu topology.makeTopology(options, network, IntLinkClass, ExtLinkClass, 17311662Stushar@ece.gatech.edu RouterClass) 17411662Stushar@ece.gatech.edu 17511662Stushar@ece.gatech.edu # Initialize network based on topology 17611662Stushar@ece.gatech.edu Network.init_network(options, network, InterfaceClass) 17711662Stushar@ece.gatech.edu 17810311Snilay@cs.wisc.edu # Create a port proxy for connecting the system port. This is 17910311Snilay@cs.wisc.edu # independent of the protocol and kept in the protocol-agnostic 18010311Snilay@cs.wisc.edu # part (i.e. here). 18110311Snilay@cs.wisc.edu sys_port_proxy = RubyPortProxy(ruby_system = ruby) 18211596Sandreas.sandberg@arm.com if piobus is not None: 18311596Sandreas.sandberg@arm.com sys_port_proxy.pio_master_port = piobus.slave 18410311Snilay@cs.wisc.edu 18510311Snilay@cs.wisc.edu # Give the system port proxy a SimObject parent without creating a 18610311Snilay@cs.wisc.edu # full-fledged controller 18710311Snilay@cs.wisc.edu system.sys_port_proxy = sys_port_proxy 18810311Snilay@cs.wisc.edu 18910311Snilay@cs.wisc.edu # Connect the system port for loading of binaries etc 19010311Snilay@cs.wisc.edu system.system_port = system.sys_port_proxy.slave 1919148Spowerjg@cs.wisc.edu 19210524Snilay@cs.wisc.edu setup_memory_controllers(system, ruby, dir_cntrls, options) 19310116Snilay@cs.wisc.edu 19410116Snilay@cs.wisc.edu # Connect the cpu sequencers and the piobus 19510116Snilay@cs.wisc.edu if piobus != None: 19610116Snilay@cs.wisc.edu for cpu_seq in cpu_sequencers: 19710116Snilay@cs.wisc.edu cpu_seq.pio_master_port = piobus.slave 19810116Snilay@cs.wisc.edu cpu_seq.mem_master_port = piobus.slave 19910116Snilay@cs.wisc.edu 20010116Snilay@cs.wisc.edu if buildEnv['TARGET_ISA'] == "x86": 20110116Snilay@cs.wisc.edu cpu_seq.pio_slave_port = piobus.master 20210116Snilay@cs.wisc.edu 20311172Snilay@cs.wisc.edu ruby.number_of_virtual_networks = ruby.network.number_of_virtual_networks 20410120Snilay@cs.wisc.edu ruby._cpu_ports = cpu_sequencers 20510012Snilay@cs.wisc.edu ruby.num_of_sequencers = len(cpu_sequencers) 20610525Snilay@cs.wisc.edu 20710630Snilay@cs.wisc.edu # Create a backing copy of physical memory in case required 20810630Snilay@cs.wisc.edu if options.access_backing_store: 20910706Spower.jg@gmail.com ruby.access_backing_store = True 21010706Spower.jg@gmail.com ruby.phys_mem = SimpleMemory(range=system.mem_ranges[0], 21110630Snilay@cs.wisc.edu in_addr_map=False) 21210630Snilay@cs.wisc.edu 21312976Snikos.nikoleris@arm.comdef create_directories(options, bootmem, ruby_system, system): 21412065Snikos.nikoleris@arm.com dir_cntrl_nodes = [] 21512065Snikos.nikoleris@arm.com for i in xrange(options.num_dirs): 21612065Snikos.nikoleris@arm.com dir_cntrl = Directory_Controller() 21712065Snikos.nikoleris@arm.com dir_cntrl.version = i 21812065Snikos.nikoleris@arm.com dir_cntrl.directory = RubyDirectoryMemory() 21912065Snikos.nikoleris@arm.com dir_cntrl.ruby_system = ruby_system 22012065Snikos.nikoleris@arm.com 22112065Snikos.nikoleris@arm.com exec("ruby_system.dir_cntrl%d = dir_cntrl" % i) 22212065Snikos.nikoleris@arm.com dir_cntrl_nodes.append(dir_cntrl) 22312598Snikos.nikoleris@arm.com 22412598Snikos.nikoleris@arm.com if bootmem is not None: 22512598Snikos.nikoleris@arm.com rom_dir_cntrl = Directory_Controller() 22612598Snikos.nikoleris@arm.com rom_dir_cntrl.directory = RubyDirectoryMemory() 22712598Snikos.nikoleris@arm.com rom_dir_cntrl.ruby_system = ruby_system 22812598Snikos.nikoleris@arm.com rom_dir_cntrl.version = i + 1 22912598Snikos.nikoleris@arm.com rom_dir_cntrl.memory = bootmem.port 23012598Snikos.nikoleris@arm.com rom_dir_cntrl.addr_ranges = bootmem.range 23112598Snikos.nikoleris@arm.com return (dir_cntrl_nodes, rom_dir_cntrl) 23212598Snikos.nikoleris@arm.com 23312598Snikos.nikoleris@arm.com return (dir_cntrl_nodes, None) 23412065Snikos.nikoleris@arm.com 23510529Smorr@cs.wisc.edudef send_evicts(options): 23610529Smorr@cs.wisc.edu # currently, 2 scenarios warrant forwarding evictions to the CPU: 23710529Smorr@cs.wisc.edu # 1. The O3 model must keep the LSQ coherent with the caches 23810529Smorr@cs.wisc.edu # 2. The x86 mwait instruction is built on top of coherence invalidations 23912066Snikos.nikoleris@arm.com # 3. The local exclusive monitor in ARM systems 24012066Snikos.nikoleris@arm.com if options.cpu_type == "DerivO3CPU" or \ 24112066Snikos.nikoleris@arm.com buildEnv['TARGET_ISA'] in ('x86', 'arm'): 24210529Smorr@cs.wisc.edu return True 24310529Smorr@cs.wisc.edu return False 244