StateMachine.py revision 7055
16657Snate@binkert.org# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 26657Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company 36657Snate@binkert.org# All rights reserved. 46657Snate@binkert.org# 56657Snate@binkert.org# Redistribution and use in source and binary forms, with or without 66657Snate@binkert.org# modification, are permitted provided that the following conditions are 76657Snate@binkert.org# met: redistributions of source code must retain the above copyright 86657Snate@binkert.org# notice, this list of conditions and the following disclaimer; 96657Snate@binkert.org# redistributions in binary form must reproduce the above copyright 106657Snate@binkert.org# notice, this list of conditions and the following disclaimer in the 116657Snate@binkert.org# documentation and/or other materials provided with the distribution; 126657Snate@binkert.org# neither the name of the copyright holders nor the names of its 136657Snate@binkert.org# contributors may be used to endorse or promote products derived from 146657Snate@binkert.org# this software without specific prior written permission. 156657Snate@binkert.org# 166657Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 176657Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 186657Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 196657Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 206657Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 216657Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 226657Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 236657Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 246657Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 256657Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 266657Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 276657Snate@binkert.org 286999Snate@binkert.orgfrom m5.util import orderdict 296657Snate@binkert.org 306657Snate@binkert.orgfrom slicc.symbols.Symbol import Symbol 316657Snate@binkert.orgfrom slicc.symbols.Var import Var 326657Snate@binkert.orgimport slicc.generate.html as html 336657Snate@binkert.org 346882SBrad.Beckmann@amd.compython_class_map = {"int": "Int", 357055Snate@binkert.org "std::string": "String", 366882SBrad.Beckmann@amd.com "bool": "Bool", 376882SBrad.Beckmann@amd.com "CacheMemory": "RubyCache", 386882SBrad.Beckmann@amd.com "Sequencer": "RubySequencer", 396882SBrad.Beckmann@amd.com "DirectoryMemory": "RubyDirectoryMemory", 406882SBrad.Beckmann@amd.com "MemoryControl": "RubyMemoryControl", 416888SBrad.Beckmann@amd.com "DMASequencer": "DMASequencer" 426882SBrad.Beckmann@amd.com } 436882SBrad.Beckmann@amd.com 446657Snate@binkert.orgclass StateMachine(Symbol): 456657Snate@binkert.org def __init__(self, symtab, ident, location, pairs, config_parameters): 466657Snate@binkert.org super(StateMachine, self).__init__(symtab, ident, location, pairs) 476657Snate@binkert.org self.table = None 486657Snate@binkert.org self.config_parameters = config_parameters 496657Snate@binkert.org for param in config_parameters: 506882SBrad.Beckmann@amd.com if param.pointer: 516882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 526882SBrad.Beckmann@amd.com "(*m_%s_ptr)" % param.name, {}, self) 536882SBrad.Beckmann@amd.com else: 546882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 556882SBrad.Beckmann@amd.com "m_%s" % param.name, {}, self) 566657Snate@binkert.org self.symtab.registerSym(param.name, var) 576657Snate@binkert.org 586657Snate@binkert.org self.states = orderdict() 596657Snate@binkert.org self.events = orderdict() 606657Snate@binkert.org self.actions = orderdict() 616657Snate@binkert.org self.transitions = [] 626657Snate@binkert.org self.in_ports = [] 636657Snate@binkert.org self.functions = [] 646657Snate@binkert.org self.objects = [] 656657Snate@binkert.org 666657Snate@binkert.org self.message_buffer_names = [] 676657Snate@binkert.org 686657Snate@binkert.org def __repr__(self): 696657Snate@binkert.org return "[StateMachine: %s]" % self.ident 706657Snate@binkert.org 716657Snate@binkert.org def addState(self, state): 726657Snate@binkert.org assert self.table is None 736657Snate@binkert.org self.states[state.ident] = state 746657Snate@binkert.org 756657Snate@binkert.org def addEvent(self, event): 766657Snate@binkert.org assert self.table is None 776657Snate@binkert.org self.events[event.ident] = event 786657Snate@binkert.org 796657Snate@binkert.org def addAction(self, action): 806657Snate@binkert.org assert self.table is None 816657Snate@binkert.org 826657Snate@binkert.org # Check for duplicate action 836657Snate@binkert.org for other in self.actions.itervalues(): 846657Snate@binkert.org if action.ident == other.ident: 856779SBrad.Beckmann@amd.com action.warning("Duplicate action definition: %s" % action.ident) 866657Snate@binkert.org action.error("Duplicate action definition: %s" % action.ident) 876657Snate@binkert.org if action.short == other.short: 886657Snate@binkert.org other.warning("Duplicate action shorthand: %s" % other.ident) 896657Snate@binkert.org other.warning(" shorthand = %s" % other.short) 906657Snate@binkert.org action.warning("Duplicate action shorthand: %s" % action.ident) 916657Snate@binkert.org action.error(" shorthand = %s" % action.short) 926657Snate@binkert.org 936657Snate@binkert.org self.actions[action.ident] = action 946657Snate@binkert.org 956657Snate@binkert.org def addTransition(self, trans): 966657Snate@binkert.org assert self.table is None 976657Snate@binkert.org self.transitions.append(trans) 986657Snate@binkert.org 996657Snate@binkert.org def addInPort(self, var): 1006657Snate@binkert.org self.in_ports.append(var) 1016657Snate@binkert.org 1026657Snate@binkert.org def addFunc(self, func): 1036657Snate@binkert.org # register func in the symbol table 1046657Snate@binkert.org self.symtab.registerSym(str(func), func) 1056657Snate@binkert.org self.functions.append(func) 1066657Snate@binkert.org 1076657Snate@binkert.org def addObject(self, obj): 1086657Snate@binkert.org self.objects.append(obj) 1096657Snate@binkert.org 1106657Snate@binkert.org # Needs to be called before accessing the table 1116657Snate@binkert.org def buildTable(self): 1126657Snate@binkert.org assert self.table is None 1136657Snate@binkert.org 1146657Snate@binkert.org table = {} 1156657Snate@binkert.org 1166657Snate@binkert.org for trans in self.transitions: 1176657Snate@binkert.org # Track which actions we touch so we know if we use them 1186657Snate@binkert.org # all -- really this should be done for all symbols as 1196657Snate@binkert.org # part of the symbol table, then only trigger it for 1206657Snate@binkert.org # Actions, States, Events, etc. 1216657Snate@binkert.org 1226657Snate@binkert.org for action in trans.actions: 1236657Snate@binkert.org action.used = True 1246657Snate@binkert.org 1256657Snate@binkert.org index = (trans.state, trans.event) 1266657Snate@binkert.org if index in table: 1276657Snate@binkert.org table[index].warning("Duplicate transition: %s" % table[index]) 1286657Snate@binkert.org trans.error("Duplicate transition: %s" % trans) 1296657Snate@binkert.org table[index] = trans 1306657Snate@binkert.org 1316657Snate@binkert.org # Look at all actions to make sure we used them all 1326657Snate@binkert.org for action in self.actions.itervalues(): 1336657Snate@binkert.org if not action.used: 1346657Snate@binkert.org error_msg = "Unused action: %s" % action.ident 1356657Snate@binkert.org if "desc" in action: 1366657Snate@binkert.org error_msg += ", " + action.desc 1376657Snate@binkert.org action.warning(error_msg) 1386657Snate@binkert.org self.table = table 1396657Snate@binkert.org 1406657Snate@binkert.org def writeCodeFiles(self, path): 1416877Ssteve.reinhardt@amd.com self.printControllerPython(path) 1426657Snate@binkert.org self.printControllerHH(path) 1436657Snate@binkert.org self.printControllerCC(path) 1446657Snate@binkert.org self.printCSwitch(path) 1456657Snate@binkert.org self.printCWakeup(path) 1466657Snate@binkert.org self.printProfilerCC(path) 1476657Snate@binkert.org self.printProfilerHH(path) 1486657Snate@binkert.org 1496657Snate@binkert.org for func in self.functions: 1506657Snate@binkert.org func.writeCodeFiles(path) 1516657Snate@binkert.org 1526877Ssteve.reinhardt@amd.com def printControllerPython(self, path): 1536999Snate@binkert.org code = self.symtab.codeFormatter() 1546877Ssteve.reinhardt@amd.com ident = self.ident 1556877Ssteve.reinhardt@amd.com py_ident = "%s_Controller" % ident 1566877Ssteve.reinhardt@amd.com c_ident = "%s_Controller" % self.ident 1576877Ssteve.reinhardt@amd.com code(''' 1586877Ssteve.reinhardt@amd.comfrom m5.params import * 1596877Ssteve.reinhardt@amd.comfrom m5.SimObject import SimObject 1606877Ssteve.reinhardt@amd.comfrom Controller import RubyController 1616877Ssteve.reinhardt@amd.com 1626877Ssteve.reinhardt@amd.comclass $py_ident(RubyController): 1636877Ssteve.reinhardt@amd.com type = '$py_ident' 1646877Ssteve.reinhardt@amd.com''') 1656877Ssteve.reinhardt@amd.com code.indent() 1666877Ssteve.reinhardt@amd.com for param in self.config_parameters: 1676877Ssteve.reinhardt@amd.com dflt_str = '' 1686877Ssteve.reinhardt@amd.com if param.default is not None: 1696877Ssteve.reinhardt@amd.com dflt_str = str(param.default) + ', ' 1706882SBrad.Beckmann@amd.com if python_class_map.has_key(param.type_ast.type.c_ident): 1716882SBrad.Beckmann@amd.com python_type = python_class_map[param.type_ast.type.c_ident] 1726882SBrad.Beckmann@amd.com code('${{param.name}} = Param.${{python_type}}(${dflt_str}"")') 1736882SBrad.Beckmann@amd.com else: 1746882SBrad.Beckmann@amd.com self.error("Unknown c++ to python class conversion for c++ " \ 1756882SBrad.Beckmann@amd.com "type: '%s'. Please update the python_class_map " \ 1766882SBrad.Beckmann@amd.com "in StateMachine.py", param.type_ast.type.c_ident) 1776877Ssteve.reinhardt@amd.com code.dedent() 1786877Ssteve.reinhardt@amd.com code.write(path, '%s.py' % py_ident) 1796877Ssteve.reinhardt@amd.com 1806877Ssteve.reinhardt@amd.com 1816657Snate@binkert.org def printControllerHH(self, path): 1826657Snate@binkert.org '''Output the method declarations for the class declaration''' 1836999Snate@binkert.org code = self.symtab.codeFormatter() 1846657Snate@binkert.org ident = self.ident 1856657Snate@binkert.org c_ident = "%s_Controller" % self.ident 1866657Snate@binkert.org 1876657Snate@binkert.org self.message_buffer_names = [] 1886657Snate@binkert.org 1896657Snate@binkert.org code(''' 1907007Snate@binkert.org/** \\file $c_ident.hh 1916657Snate@binkert.org * 1926657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 1936657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 1946657Snate@binkert.org */ 1956657Snate@binkert.org 1967007Snate@binkert.org#ifndef __${ident}_CONTROLLER_HH__ 1977007Snate@binkert.org#define __${ident}_CONTROLLER_HH__ 1986657Snate@binkert.org 1997002Snate@binkert.org#include <iostream> 2007002Snate@binkert.org#include <sstream> 2017002Snate@binkert.org#include <string> 2027002Snate@binkert.org 2036877Ssteve.reinhardt@amd.com#include "params/$c_ident.hh" 2046877Ssteve.reinhardt@amd.com 2056657Snate@binkert.org#include "mem/ruby/common/Global.hh" 2066657Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 2076657Snate@binkert.org#include "mem/ruby/slicc_interface/AbstractController.hh" 2086657Snate@binkert.org#include "mem/protocol/TransitionResult.hh" 2096657Snate@binkert.org#include "mem/protocol/Types.hh" 2106657Snate@binkert.org#include "mem/protocol/${ident}_Profiler.hh" 2116657Snate@binkert.org''') 2126657Snate@binkert.org 2136657Snate@binkert.org seen_types = set() 2146657Snate@binkert.org for var in self.objects: 2156793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 2166657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 2176657Snate@binkert.org seen_types.add(var.type.ident) 2186657Snate@binkert.org 2196657Snate@binkert.org # for adding information to the protocol debug trace 2206657Snate@binkert.org code(''' 2217002Snate@binkert.orgextern std::stringstream ${ident}_transitionComment; 2226657Snate@binkert.org 2237007Snate@binkert.orgclass $c_ident : public AbstractController 2247007Snate@binkert.org{ 2257007Snate@binkert.org// the coherence checker needs to call isBlockExclusive() and isBlockShared() 2267007Snate@binkert.org// making the Chip a friend class is an easy way to do this for now 2277007Snate@binkert.org 2286657Snate@binkert.orgpublic: 2296877Ssteve.reinhardt@amd.com typedef ${c_ident}Params Params; 2306877Ssteve.reinhardt@amd.com $c_ident(const Params *p); 2316657Snate@binkert.org static int getNumControllers(); 2326877Ssteve.reinhardt@amd.com void init(); 2336657Snate@binkert.org MessageBuffer* getMandatoryQueue() const; 2346657Snate@binkert.org const int & getVersion() const; 2357002Snate@binkert.org const std::string toString() const; 2367002Snate@binkert.org const std::string getName() const; 2376657Snate@binkert.org const MachineType getMachineType() const; 2386881SBrad.Beckmann@amd.com void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 2397002Snate@binkert.org void print(std::ostream& out) const; 2407002Snate@binkert.org void printConfig(std::ostream& out) const; 2416657Snate@binkert.org void wakeup(); 2427002Snate@binkert.org void printStats(std::ostream& out) const; 2436902SBrad.Beckmann@amd.com void clearStats(); 2446863Sdrh5@cs.wisc.edu void blockOnQueue(Address addr, MessageBuffer* port); 2456863Sdrh5@cs.wisc.edu void unblock(Address addr); 2467007Snate@binkert.org 2476657Snate@binkert.orgprivate: 2486657Snate@binkert.org''') 2496657Snate@binkert.org 2506657Snate@binkert.org code.indent() 2516657Snate@binkert.org # added by SS 2526657Snate@binkert.org for param in self.config_parameters: 2536882SBrad.Beckmann@amd.com if param.pointer: 2546882SBrad.Beckmann@amd.com code('${{param.type_ast.type}}* m_${{param.ident}}_ptr;') 2556882SBrad.Beckmann@amd.com else: 2566882SBrad.Beckmann@amd.com code('${{param.type_ast.type}} m_${{param.ident}};') 2576657Snate@binkert.org 2586657Snate@binkert.org code(''' 2596657Snate@binkert.orgint m_number_of_TBEs; 2606657Snate@binkert.org 2617007Snate@binkert.orgTransitionResult doTransition(${ident}_Event event, 2627007Snate@binkert.org ${ident}_State state, 2637007Snate@binkert.org const Address& addr); 2647007Snate@binkert.org 2657007Snate@binkert.orgTransitionResult doTransitionWorker(${ident}_Event event, 2667007Snate@binkert.org ${ident}_State state, 2677007Snate@binkert.org ${ident}_State& next_state, 2687007Snate@binkert.org const Address& addr); 2697007Snate@binkert.org 2707002Snate@binkert.orgstd::string m_name; 2716657Snate@binkert.orgint m_transitions_per_cycle; 2726657Snate@binkert.orgint m_buffer_size; 2736657Snate@binkert.orgint m_recycle_latency; 2747055Snate@binkert.orgstd::map<std::string, std::string> m_cfg; 2756657Snate@binkert.orgNodeID m_version; 2766657Snate@binkert.orgNetwork* m_net_ptr; 2776657Snate@binkert.orgMachineID m_machineID; 2786863Sdrh5@cs.wisc.edubool m_is_blocking; 2797055Snate@binkert.orgstd::map<Address, MessageBuffer*> m_block_map; 2806657Snate@binkert.org${ident}_Profiler s_profiler; 2816657Snate@binkert.orgstatic int m_num_controllers; 2827007Snate@binkert.org 2836657Snate@binkert.org// Internal functions 2846657Snate@binkert.org''') 2856657Snate@binkert.org 2866657Snate@binkert.org for func in self.functions: 2876657Snate@binkert.org proto = func.prototype 2886657Snate@binkert.org if proto: 2896657Snate@binkert.org code('$proto') 2906657Snate@binkert.org 2916657Snate@binkert.org code(''' 2926657Snate@binkert.org 2936657Snate@binkert.org// Actions 2946657Snate@binkert.org''') 2956657Snate@binkert.org for action in self.actions.itervalues(): 2966657Snate@binkert.org code('/** \\brief ${{action.desc}} */') 2976657Snate@binkert.org code('void ${{action.ident}}(const Address& addr);') 2986657Snate@binkert.org 2996657Snate@binkert.org # the controller internal variables 3006657Snate@binkert.org code(''' 3016657Snate@binkert.org 3027007Snate@binkert.org// Objects 3036657Snate@binkert.org''') 3046657Snate@binkert.org for var in self.objects: 3056657Snate@binkert.org th = var.get("template_hack", "") 3066657Snate@binkert.org code('${{var.type.c_ident}}$th* m_${{var.c_ident}}_ptr;') 3076657Snate@binkert.org 3086657Snate@binkert.org if var.type.ident == "MessageBuffer": 3096657Snate@binkert.org self.message_buffer_names.append("m_%s_ptr" % var.c_ident) 3106657Snate@binkert.org 3116657Snate@binkert.org code.dedent() 3126657Snate@binkert.org code('};') 3137007Snate@binkert.org code('#endif // __${ident}_CONTROLLER_H__') 3146657Snate@binkert.org code.write(path, '%s.hh' % c_ident) 3156657Snate@binkert.org 3166657Snate@binkert.org def printControllerCC(self, path): 3176657Snate@binkert.org '''Output the actions for performing the actions''' 3186657Snate@binkert.org 3196999Snate@binkert.org code = self.symtab.codeFormatter() 3206657Snate@binkert.org ident = self.ident 3216657Snate@binkert.org c_ident = "%s_Controller" % self.ident 3226657Snate@binkert.org 3236657Snate@binkert.org code(''' 3247007Snate@binkert.org/** \\file $c_ident.cc 3256657Snate@binkert.org * 3266657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 3276657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 3286657Snate@binkert.org */ 3296657Snate@binkert.org 3307002Snate@binkert.org#include <sstream> 3317002Snate@binkert.org#include <string> 3327002Snate@binkert.org 3336657Snate@binkert.org#include "mem/ruby/common/Global.hh" 3346657Snate@binkert.org#include "mem/ruby/slicc_interface/RubySlicc_includes.hh" 3356657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 3366657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 3376657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 3386657Snate@binkert.org#include "mem/protocol/Types.hh" 3396657Snate@binkert.org#include "mem/ruby/system/System.hh" 3407002Snate@binkert.org 3417002Snate@binkert.orgusing namespace std; 3426657Snate@binkert.org''') 3436657Snate@binkert.org 3446657Snate@binkert.org # include object classes 3456657Snate@binkert.org seen_types = set() 3466657Snate@binkert.org for var in self.objects: 3476793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 3486657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 3496657Snate@binkert.org seen_types.add(var.type.ident) 3506657Snate@binkert.org 3516657Snate@binkert.org code(''' 3526877Ssteve.reinhardt@amd.com$c_ident * 3536877Ssteve.reinhardt@amd.com${c_ident}Params::create() 3546877Ssteve.reinhardt@amd.com{ 3556877Ssteve.reinhardt@amd.com return new $c_ident(this); 3566877Ssteve.reinhardt@amd.com} 3576877Ssteve.reinhardt@amd.com 3586657Snate@binkert.orgint $c_ident::m_num_controllers = 0; 3596657Snate@binkert.org 3607007Snate@binkert.org// for adding information to the protocol debug trace 3616657Snate@binkert.orgstringstream ${ident}_transitionComment; 3626657Snate@binkert.org#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str) 3637007Snate@binkert.org 3646657Snate@binkert.org/** \\brief constructor */ 3656877Ssteve.reinhardt@amd.com$c_ident::$c_ident(const Params *p) 3666877Ssteve.reinhardt@amd.com : AbstractController(p) 3676657Snate@binkert.org{ 3686877Ssteve.reinhardt@amd.com m_version = p->version; 3696877Ssteve.reinhardt@amd.com m_transitions_per_cycle = p->transitions_per_cycle; 3706877Ssteve.reinhardt@amd.com m_buffer_size = p->buffer_size; 3716877Ssteve.reinhardt@amd.com m_recycle_latency = p->recycle_latency; 3726877Ssteve.reinhardt@amd.com m_number_of_TBEs = p->number_of_TBEs; 3736969SBrad.Beckmann@amd.com m_is_blocking = false; 3746657Snate@binkert.org''') 3756657Snate@binkert.org code.indent() 3766882SBrad.Beckmann@amd.com 3776882SBrad.Beckmann@amd.com # 3786882SBrad.Beckmann@amd.com # After initializing the universal machine parameters, initialize the 3796882SBrad.Beckmann@amd.com # this machines config parameters. Also detemine if these configuration 3806882SBrad.Beckmann@amd.com # params include a sequencer. This information will be used later for 3816882SBrad.Beckmann@amd.com # contecting the sequencer back to the L1 cache controller. 3826882SBrad.Beckmann@amd.com # 3836882SBrad.Beckmann@amd.com contains_sequencer = False 3846877Ssteve.reinhardt@amd.com for param in self.config_parameters: 3856888SBrad.Beckmann@amd.com if param.name == "sequencer" or param.name == "dma_sequencer": 3866882SBrad.Beckmann@amd.com contains_sequencer = True 3876882SBrad.Beckmann@amd.com if param.pointer: 3886882SBrad.Beckmann@amd.com code('m_${{param.name}}_ptr = p->${{param.name}};') 3896882SBrad.Beckmann@amd.com else: 3906882SBrad.Beckmann@amd.com code('m_${{param.name}} = p->${{param.name}};') 3916882SBrad.Beckmann@amd.com 3926882SBrad.Beckmann@amd.com # 3936882SBrad.Beckmann@amd.com # For the l1 cache controller, add the special atomic support which 3946882SBrad.Beckmann@amd.com # includes passing the sequencer a pointer to the controller. 3956882SBrad.Beckmann@amd.com # 3966882SBrad.Beckmann@amd.com if self.ident == "L1Cache": 3976882SBrad.Beckmann@amd.com if not contains_sequencer: 3986882SBrad.Beckmann@amd.com self.error("The L1Cache controller must include the sequencer " \ 3996882SBrad.Beckmann@amd.com "configuration parameter") 4006882SBrad.Beckmann@amd.com 4016882SBrad.Beckmann@amd.com code(''' 4026882SBrad.Beckmann@amd.comm_sequencer_ptr->setController(this); 4036882SBrad.Beckmann@amd.com''') 4046888SBrad.Beckmann@amd.com # 4056888SBrad.Beckmann@amd.com # For the DMA controller, pass the sequencer a pointer to the 4066888SBrad.Beckmann@amd.com # controller. 4076888SBrad.Beckmann@amd.com # 4086888SBrad.Beckmann@amd.com if self.ident == "DMA": 4096888SBrad.Beckmann@amd.com if not contains_sequencer: 4106888SBrad.Beckmann@amd.com self.error("The DMA controller must include the sequencer " \ 4116888SBrad.Beckmann@amd.com "configuration parameter") 4126657Snate@binkert.org 4136888SBrad.Beckmann@amd.com code(''' 4146888SBrad.Beckmann@amd.comm_dma_sequencer_ptr->setController(this); 4156888SBrad.Beckmann@amd.com''') 4166888SBrad.Beckmann@amd.com 4176657Snate@binkert.org code('m_num_controllers++;') 4186657Snate@binkert.org for var in self.objects: 4196657Snate@binkert.org if var.ident.find("mandatoryQueue") >= 0: 4206657Snate@binkert.org code('m_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}();') 4216657Snate@binkert.org 4226657Snate@binkert.org code.dedent() 4236657Snate@binkert.org code(''' 4246657Snate@binkert.org} 4256657Snate@binkert.org 4267007Snate@binkert.orgvoid 4277007Snate@binkert.org$c_ident::init() 4286657Snate@binkert.org{ 4297007Snate@binkert.org MachineType machine_type; 4307007Snate@binkert.org int base; 4317007Snate@binkert.org 4326657Snate@binkert.org m_machineID.type = MachineType_${ident}; 4336657Snate@binkert.org m_machineID.num = m_version; 4346657Snate@binkert.org 4357007Snate@binkert.org // initialize objects 4366657Snate@binkert.org s_profiler.setVersion(m_version); 4377007Snate@binkert.org 4386657Snate@binkert.org''') 4396657Snate@binkert.org 4406657Snate@binkert.org code.indent() 4416657Snate@binkert.org for var in self.objects: 4426657Snate@binkert.org vtype = var.type 4436657Snate@binkert.org vid = "m_%s_ptr" % var.c_ident 4446657Snate@binkert.org if "network" not in var: 4456657Snate@binkert.org # Not a network port object 4466657Snate@binkert.org if "primitive" in vtype: 4476657Snate@binkert.org code('$vid = new ${{vtype.c_ident}};') 4486657Snate@binkert.org if "default" in var: 4496657Snate@binkert.org code('(*$vid) = ${{var["default"]}};') 4506657Snate@binkert.org else: 4516657Snate@binkert.org # Normal Object 4526657Snate@binkert.org # added by SS 4536657Snate@binkert.org if "factory" in var: 4546657Snate@binkert.org code('$vid = ${{var["factory"]}};') 4556657Snate@binkert.org elif var.ident.find("mandatoryQueue") < 0: 4566657Snate@binkert.org th = var.get("template_hack", "") 4576657Snate@binkert.org expr = "%s = new %s%s" % (vid, vtype.c_ident, th) 4586657Snate@binkert.org 4596657Snate@binkert.org args = "" 4606657Snate@binkert.org if "non_obj" not in vtype and not vtype.isEnumeration: 4616657Snate@binkert.org if expr.find("TBETable") >= 0: 4626657Snate@binkert.org args = "m_number_of_TBEs" 4636657Snate@binkert.org else: 4646657Snate@binkert.org args = var.get("constructor_hack", "") 4656657Snate@binkert.org 4667007Snate@binkert.org code('$expr($args);') 4676657Snate@binkert.org 4686657Snate@binkert.org code('assert($vid != NULL);') 4696657Snate@binkert.org 4706657Snate@binkert.org if "default" in var: 4717007Snate@binkert.org code('*$vid = ${{var["default"]}}; // Object default') 4726657Snate@binkert.org elif "default" in vtype: 4737007Snate@binkert.org comment = "Type %s default" % vtype.ident 4747007Snate@binkert.org code('*$vid = ${{vtype["default"]}}; // $comment') 4756657Snate@binkert.org 4766657Snate@binkert.org # Set ordering 4776657Snate@binkert.org if "ordered" in var and "trigger_queue" not in var: 4786657Snate@binkert.org # A buffer 4796657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 4806657Snate@binkert.org 4816657Snate@binkert.org # Set randomization 4826657Snate@binkert.org if "random" in var: 4836657Snate@binkert.org # A buffer 4846657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}});') 4856657Snate@binkert.org 4866657Snate@binkert.org # Set Priority 4876657Snate@binkert.org if vtype.isBuffer and \ 4886657Snate@binkert.org "rank" in var and "trigger_queue" not in var: 4896657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}});') 4906657Snate@binkert.org else: 4916657Snate@binkert.org # Network port object 4926657Snate@binkert.org network = var["network"] 4936657Snate@binkert.org ordered = var["ordered"] 4946657Snate@binkert.org vnet = var["virtual_network"] 4956657Snate@binkert.org 4966657Snate@binkert.org assert var.machine is not None 4976657Snate@binkert.org code(''' 4987007Snate@binkert.orgmachine_type = string_to_MachineType("${{var.machine.ident}}"); 4997007Snate@binkert.orgbase = MachineType_base_number(machine_type); 5007007Snate@binkert.org$vid = m_net_ptr->get${network}NetQueue(m_version + base, $ordered, $vnet); 5016657Snate@binkert.org''') 5026657Snate@binkert.org 5036657Snate@binkert.org code('assert($vid != NULL);') 5046657Snate@binkert.org 5056657Snate@binkert.org # Set ordering 5066657Snate@binkert.org if "ordered" in var: 5076657Snate@binkert.org # A buffer 5086657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 5096657Snate@binkert.org 5106657Snate@binkert.org # Set randomization 5116657Snate@binkert.org if "random" in var: 5126657Snate@binkert.org # A buffer 5136657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}})') 5146657Snate@binkert.org 5156657Snate@binkert.org # Set Priority 5166657Snate@binkert.org if "rank" in var: 5176657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}})') 5186657Snate@binkert.org 5196657Snate@binkert.org # Set buffer size 5206657Snate@binkert.org if vtype.isBuffer: 5216657Snate@binkert.org code(''' 5226657Snate@binkert.orgif (m_buffer_size > 0) { 5236657Snate@binkert.org $vid->setSize(m_buffer_size); 5246657Snate@binkert.org} 5256657Snate@binkert.org''') 5266657Snate@binkert.org 5276657Snate@binkert.org # set description (may be overriden later by port def) 5287007Snate@binkert.org code(''' 5297007Snate@binkert.org$vid->setDescription("[Version " + int_to_string(m_version) + ", ${ident}, name=${{var.c_ident}}]"); 5307007Snate@binkert.org 5317007Snate@binkert.org''') 5326657Snate@binkert.org 5336657Snate@binkert.org # Set the queue consumers 5346657Snate@binkert.org code.insert_newline() 5356657Snate@binkert.org for port in self.in_ports: 5366657Snate@binkert.org code('${{port.code}}.setConsumer(this);') 5376657Snate@binkert.org 5386657Snate@binkert.org # Set the queue descriptions 5396657Snate@binkert.org code.insert_newline() 5406657Snate@binkert.org for port in self.in_ports: 5416657Snate@binkert.org code('${{port.code}}.setDescription("[Version " + int_to_string(m_version) + ", $ident, $port]");') 5426657Snate@binkert.org 5436657Snate@binkert.org # Initialize the transition profiling 5446657Snate@binkert.org code.insert_newline() 5456657Snate@binkert.org for trans in self.transitions: 5466657Snate@binkert.org # Figure out if we stall 5476657Snate@binkert.org stall = False 5486657Snate@binkert.org for action in trans.actions: 5496657Snate@binkert.org if action.ident == "z_stall": 5506657Snate@binkert.org stall = True 5516657Snate@binkert.org 5526657Snate@binkert.org # Only possible if it is not a 'z' case 5536657Snate@binkert.org if not stall: 5546657Snate@binkert.org state = "%s_State_%s" % (self.ident, trans.state.ident) 5556657Snate@binkert.org event = "%s_Event_%s" % (self.ident, trans.event.ident) 5566657Snate@binkert.org code('s_profiler.possibleTransition($state, $event);') 5576657Snate@binkert.org 5586657Snate@binkert.org # added by SS to initialize recycle_latency of message buffers 5596657Snate@binkert.org for buf in self.message_buffer_names: 5606657Snate@binkert.org code("$buf->setRecycleLatency(m_recycle_latency);") 5616657Snate@binkert.org 5626657Snate@binkert.org code.dedent() 5636657Snate@binkert.org code('}') 5646657Snate@binkert.org 5656657Snate@binkert.org has_mandatory_q = False 5666657Snate@binkert.org for port in self.in_ports: 5676657Snate@binkert.org if port.code.find("mandatoryQueue_ptr") >= 0: 5686657Snate@binkert.org has_mandatory_q = True 5696657Snate@binkert.org 5706657Snate@binkert.org if has_mandatory_q: 5716657Snate@binkert.org mq_ident = "m_%s_mandatoryQueue_ptr" % self.ident 5726657Snate@binkert.org else: 5736657Snate@binkert.org mq_ident = "NULL" 5746657Snate@binkert.org 5756657Snate@binkert.org code(''' 5767007Snate@binkert.orgint 5777007Snate@binkert.org$c_ident::getNumControllers() 5787007Snate@binkert.org{ 5796657Snate@binkert.org return m_num_controllers; 5806657Snate@binkert.org} 5816657Snate@binkert.org 5827007Snate@binkert.orgMessageBuffer* 5837007Snate@binkert.org$c_ident::getMandatoryQueue() const 5847007Snate@binkert.org{ 5856657Snate@binkert.org return $mq_ident; 5866657Snate@binkert.org} 5876657Snate@binkert.org 5887007Snate@binkert.orgconst int & 5897007Snate@binkert.org$c_ident::getVersion() const 5907007Snate@binkert.org{ 5916657Snate@binkert.org return m_version; 5926657Snate@binkert.org} 5936657Snate@binkert.org 5947007Snate@binkert.orgconst string 5957007Snate@binkert.org$c_ident::toString() const 5967007Snate@binkert.org{ 5976657Snate@binkert.org return "$c_ident"; 5986657Snate@binkert.org} 5996657Snate@binkert.org 6007007Snate@binkert.orgconst string 6017007Snate@binkert.org$c_ident::getName() const 6027007Snate@binkert.org{ 6036657Snate@binkert.org return m_name; 6046657Snate@binkert.org} 6057007Snate@binkert.org 6067007Snate@binkert.orgconst MachineType 6077007Snate@binkert.org$c_ident::getMachineType() const 6087007Snate@binkert.org{ 6096657Snate@binkert.org return MachineType_${ident}; 6106657Snate@binkert.org} 6116657Snate@binkert.org 6127007Snate@binkert.orgvoid 6137007Snate@binkert.org$c_ident::blockOnQueue(Address addr, MessageBuffer* port) 6147007Snate@binkert.org{ 6156863Sdrh5@cs.wisc.edu m_is_blocking = true; 6166863Sdrh5@cs.wisc.edu m_block_map[addr] = port; 6176863Sdrh5@cs.wisc.edu} 6187007Snate@binkert.org 6197007Snate@binkert.orgvoid 6207007Snate@binkert.org$c_ident::unblock(Address addr) 6217007Snate@binkert.org{ 6226863Sdrh5@cs.wisc.edu m_block_map.erase(addr); 6236863Sdrh5@cs.wisc.edu if (m_block_map.size() == 0) { 6246863Sdrh5@cs.wisc.edu m_is_blocking = false; 6256863Sdrh5@cs.wisc.edu } 6266863Sdrh5@cs.wisc.edu} 6276863Sdrh5@cs.wisc.edu 6287007Snate@binkert.orgvoid 6297007Snate@binkert.org$c_ident::print(ostream& out) const 6307007Snate@binkert.org{ 6317007Snate@binkert.org out << "[$c_ident " << m_version << "]"; 6327007Snate@binkert.org} 6336657Snate@binkert.org 6347007Snate@binkert.orgvoid 6357007Snate@binkert.org$c_ident::printConfig(ostream& out) const 6367007Snate@binkert.org{ 6376657Snate@binkert.org out << "$c_ident config: " << m_name << endl; 6386657Snate@binkert.org out << " version: " << m_version << endl; 6397007Snate@binkert.org map<string, string>::const_iterator it; 6407007Snate@binkert.org for (it = m_cfg.begin(); it != m_cfg.end(); it++) 6417007Snate@binkert.org out << " " << it->first << ": " << it->second << endl; 6426657Snate@binkert.org} 6436657Snate@binkert.org 6447007Snate@binkert.orgvoid 6457007Snate@binkert.org$c_ident::printStats(ostream& out) const 6467007Snate@binkert.org{ 6476902SBrad.Beckmann@amd.com''') 6486902SBrad.Beckmann@amd.com # 6496902SBrad.Beckmann@amd.com # Cache and Memory Controllers have specific profilers associated with 6506902SBrad.Beckmann@amd.com # them. Print out these stats before dumping state transition stats. 6516902SBrad.Beckmann@amd.com # 6526902SBrad.Beckmann@amd.com for param in self.config_parameters: 6536902SBrad.Beckmann@amd.com if param.type_ast.type.ident == "CacheMemory" or \ 6547025SBrad.Beckmann@amd.com param.type_ast.type.ident == "DirectoryMemory" or \ 6556902SBrad.Beckmann@amd.com param.type_ast.type.ident == "MemoryControl": 6566902SBrad.Beckmann@amd.com assert(param.pointer) 6576902SBrad.Beckmann@amd.com code(' m_${{param.ident}}_ptr->printStats(out);') 6586902SBrad.Beckmann@amd.com 6596902SBrad.Beckmann@amd.com code(''' 6606902SBrad.Beckmann@amd.com s_profiler.dumpStats(out); 6616902SBrad.Beckmann@amd.com} 6626902SBrad.Beckmann@amd.com 6636902SBrad.Beckmann@amd.comvoid $c_ident::clearStats() { 6646902SBrad.Beckmann@amd.com''') 6656902SBrad.Beckmann@amd.com # 6666902SBrad.Beckmann@amd.com # Cache and Memory Controllers have specific profilers associated with 6676902SBrad.Beckmann@amd.com # them. These stats must be cleared too. 6686902SBrad.Beckmann@amd.com # 6696902SBrad.Beckmann@amd.com for param in self.config_parameters: 6706902SBrad.Beckmann@amd.com if param.type_ast.type.ident == "CacheMemory" or \ 6716902SBrad.Beckmann@amd.com param.type_ast.type.ident == "MemoryControl": 6726902SBrad.Beckmann@amd.com assert(param.pointer) 6736902SBrad.Beckmann@amd.com code(' m_${{param.ident}}_ptr->clearStats();') 6746902SBrad.Beckmann@amd.com 6756902SBrad.Beckmann@amd.com code(''' 6766902SBrad.Beckmann@amd.com s_profiler.clearStats(); 6776902SBrad.Beckmann@amd.com} 6786902SBrad.Beckmann@amd.com 6796657Snate@binkert.org// Actions 6806657Snate@binkert.org''') 6816657Snate@binkert.org 6826657Snate@binkert.org for action in self.actions.itervalues(): 6836657Snate@binkert.org if "c_code" not in action: 6846657Snate@binkert.org continue 6856657Snate@binkert.org 6866657Snate@binkert.org code(''' 6876657Snate@binkert.org/** \\brief ${{action.desc}} */ 6887007Snate@binkert.orgvoid 6897007Snate@binkert.org$c_ident::${{action.ident}}(const Address& addr) 6906657Snate@binkert.org{ 6916657Snate@binkert.org DEBUG_MSG(GENERATED_COMP, HighPrio, "executing"); 6926657Snate@binkert.org ${{action["c_code"]}} 6936657Snate@binkert.org} 6946657Snate@binkert.org 6956657Snate@binkert.org''') 6966657Snate@binkert.org code.write(path, "%s.cc" % c_ident) 6976657Snate@binkert.org 6986657Snate@binkert.org def printCWakeup(self, path): 6996657Snate@binkert.org '''Output the wakeup loop for the events''' 7006657Snate@binkert.org 7016999Snate@binkert.org code = self.symtab.codeFormatter() 7026657Snate@binkert.org ident = self.ident 7036657Snate@binkert.org 7046657Snate@binkert.org code(''' 7056657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 7066657Snate@binkert.org// ${ident}: ${{self.short}} 7076657Snate@binkert.org 7087007Snate@binkert.org#include "base/misc.hh" 7096657Snate@binkert.org#include "mem/ruby/common/Global.hh" 7106657Snate@binkert.org#include "mem/ruby/slicc_interface/RubySlicc_includes.hh" 7116657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 7126657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 7136657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 7146657Snate@binkert.org#include "mem/protocol/Types.hh" 7156657Snate@binkert.org#include "mem/ruby/system/System.hh" 7166657Snate@binkert.org 7177055Snate@binkert.orgusing namespace std; 7187055Snate@binkert.org 7197007Snate@binkert.orgvoid 7207007Snate@binkert.org${ident}_Controller::wakeup() 7216657Snate@binkert.org{ 7227007Snate@binkert.org // DEBUG_EXPR(GENERATED_COMP, MedPrio, *this); 7237007Snate@binkert.org // DEBUG_EXPR(GENERATED_COMP, MedPrio, g_eventQueue_ptr->getTime()); 7246657Snate@binkert.org 7256657Snate@binkert.org int counter = 0; 7266657Snate@binkert.org while (true) { 7276657Snate@binkert.org // Some cases will put us into an infinite loop without this limit 7286657Snate@binkert.org assert(counter <= m_transitions_per_cycle); 7296657Snate@binkert.org if (counter == m_transitions_per_cycle) { 7307007Snate@binkert.org // Count how often we are fully utilized 7317007Snate@binkert.org g_system_ptr->getProfiler()->controllerBusy(m_machineID); 7327007Snate@binkert.org 7337007Snate@binkert.org // Wakeup in another cycle and try again 7347007Snate@binkert.org g_eventQueue_ptr->scheduleEvent(this, 1); 7356657Snate@binkert.org break; 7366657Snate@binkert.org } 7376657Snate@binkert.org''') 7386657Snate@binkert.org 7396657Snate@binkert.org code.indent() 7406657Snate@binkert.org code.indent() 7416657Snate@binkert.org 7426657Snate@binkert.org # InPorts 7436657Snate@binkert.org # 7446657Snate@binkert.org for port in self.in_ports: 7456657Snate@binkert.org code.indent() 7466657Snate@binkert.org code('// ${ident}InPort $port') 7476657Snate@binkert.org code('${{port["c_code_in_port"]}}') 7486657Snate@binkert.org code.dedent() 7496657Snate@binkert.org 7506657Snate@binkert.org code('') 7516657Snate@binkert.org 7526657Snate@binkert.org code.dedent() 7536657Snate@binkert.org code.dedent() 7546657Snate@binkert.org code(''' 7556657Snate@binkert.org break; // If we got this far, we have nothing left todo 7566657Snate@binkert.org } 7577007Snate@binkert.org // g_eventQueue_ptr->scheduleEvent(this, 1); 7587007Snate@binkert.org // DEBUG_NEWLINE(GENERATED_COMP, MedPrio); 7596657Snate@binkert.org} 7606657Snate@binkert.org''') 7616657Snate@binkert.org 7626657Snate@binkert.org code.write(path, "%s_Wakeup.cc" % self.ident) 7636657Snate@binkert.org 7646657Snate@binkert.org def printCSwitch(self, path): 7656657Snate@binkert.org '''Output switch statement for transition table''' 7666657Snate@binkert.org 7676999Snate@binkert.org code = self.symtab.codeFormatter() 7686657Snate@binkert.org ident = self.ident 7696657Snate@binkert.org 7706657Snate@binkert.org code(''' 7716657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 7726657Snate@binkert.org// ${ident}: ${{self.short}} 7736657Snate@binkert.org 7746657Snate@binkert.org#include "mem/ruby/common/Global.hh" 7756657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 7766657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 7776657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 7786657Snate@binkert.org#include "mem/protocol/Types.hh" 7796657Snate@binkert.org#include "mem/ruby/system/System.hh" 7806657Snate@binkert.org 7816657Snate@binkert.org#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event)) 7826657Snate@binkert.org 7836657Snate@binkert.org#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str()) 7846657Snate@binkert.org#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str("")) 7856657Snate@binkert.org 7867007Snate@binkert.orgTransitionResult 7877007Snate@binkert.org${ident}_Controller::doTransition(${ident}_Event event, 7887007Snate@binkert.org ${ident}_State state, 7897007Snate@binkert.org const Address &addr) 7906657Snate@binkert.org{ 7916657Snate@binkert.org ${ident}_State next_state = state; 7926657Snate@binkert.org 7936657Snate@binkert.org DEBUG_NEWLINE(GENERATED_COMP, MedPrio); 7946657Snate@binkert.org DEBUG_MSG(GENERATED_COMP, MedPrio, *this); 7956657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio, g_eventQueue_ptr->getTime()); 7966657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio,state); 7976657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio,event); 7986657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio,addr); 7996657Snate@binkert.org 8007007Snate@binkert.org TransitionResult result = 8017007Snate@binkert.org doTransitionWorker(event, state, next_state, addr); 8026657Snate@binkert.org 8036657Snate@binkert.org if (result == TransitionResult_Valid) { 8046657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio, next_state); 8056657Snate@binkert.org DEBUG_NEWLINE(GENERATED_COMP, MedPrio); 8066657Snate@binkert.org s_profiler.countTransition(state, event); 8076657Snate@binkert.org if (Debug::getProtocolTrace()) { 8087007Snate@binkert.org g_system_ptr->getProfiler()->profileTransition("${ident}", 8097007Snate@binkert.org m_version, addr, 8106657Snate@binkert.org ${ident}_State_to_string(state), 8116657Snate@binkert.org ${ident}_Event_to_string(event), 8127007Snate@binkert.org ${ident}_State_to_string(next_state), 8137007Snate@binkert.org GET_TRANSITION_COMMENT()); 8146657Snate@binkert.org } 8156657Snate@binkert.org CLEAR_TRANSITION_COMMENT(); 8166657Snate@binkert.org ${ident}_setState(addr, next_state); 8176657Snate@binkert.org 8186657Snate@binkert.org } else if (result == TransitionResult_ResourceStall) { 8196657Snate@binkert.org if (Debug::getProtocolTrace()) { 8207007Snate@binkert.org g_system_ptr->getProfiler()->profileTransition("${ident}", 8217007Snate@binkert.org m_version, addr, 8226657Snate@binkert.org ${ident}_State_to_string(state), 8236657Snate@binkert.org ${ident}_Event_to_string(event), 8246657Snate@binkert.org ${ident}_State_to_string(next_state), 8256657Snate@binkert.org "Resource Stall"); 8266657Snate@binkert.org } 8276657Snate@binkert.org } else if (result == TransitionResult_ProtocolStall) { 8286657Snate@binkert.org DEBUG_MSG(GENERATED_COMP, HighPrio, "stalling"); 8296657Snate@binkert.org DEBUG_NEWLINE(GENERATED_COMP, MedPrio); 8306657Snate@binkert.org if (Debug::getProtocolTrace()) { 8317007Snate@binkert.org g_system_ptr->getProfiler()->profileTransition("${ident}", 8327007Snate@binkert.org m_version, addr, 8336657Snate@binkert.org ${ident}_State_to_string(state), 8346657Snate@binkert.org ${ident}_Event_to_string(event), 8356657Snate@binkert.org ${ident}_State_to_string(next_state), 8366657Snate@binkert.org "Protocol Stall"); 8376657Snate@binkert.org } 8386657Snate@binkert.org } 8396657Snate@binkert.org 8406657Snate@binkert.org return result; 8416657Snate@binkert.org} 8426657Snate@binkert.org 8437007Snate@binkert.orgTransitionResult 8447007Snate@binkert.org${ident}_Controller::doTransitionWorker(${ident}_Event event, 8457007Snate@binkert.org ${ident}_State state, 8467007Snate@binkert.org ${ident}_State& next_state, 8477007Snate@binkert.org const Address& addr) 8486657Snate@binkert.org{ 8496657Snate@binkert.org switch(HASH_FUN(state, event)) { 8506657Snate@binkert.org''') 8516657Snate@binkert.org 8526657Snate@binkert.org # This map will allow suppress generating duplicate code 8536657Snate@binkert.org cases = orderdict() 8546657Snate@binkert.org 8556657Snate@binkert.org for trans in self.transitions: 8566657Snate@binkert.org case_string = "%s_State_%s, %s_Event_%s" % \ 8576657Snate@binkert.org (self.ident, trans.state.ident, self.ident, trans.event.ident) 8586657Snate@binkert.org 8596999Snate@binkert.org case = self.symtab.codeFormatter() 8606657Snate@binkert.org # Only set next_state if it changes 8616657Snate@binkert.org if trans.state != trans.nextState: 8626657Snate@binkert.org ns_ident = trans.nextState.ident 8636657Snate@binkert.org case('next_state = ${ident}_State_${ns_ident};') 8646657Snate@binkert.org 8656657Snate@binkert.org actions = trans.actions 8666657Snate@binkert.org 8676657Snate@binkert.org # Check for resources 8686657Snate@binkert.org case_sorter = [] 8696657Snate@binkert.org res = trans.resources 8706657Snate@binkert.org for key,val in res.iteritems(): 8716657Snate@binkert.org if key.type.ident != "DNUCAStopTable": 8726657Snate@binkert.org val = ''' 8737007Snate@binkert.orgif (!%s.areNSlotsAvailable(%s)) 8746657Snate@binkert.org return TransitionResult_ResourceStall; 8756657Snate@binkert.org''' % (key.code, val) 8766657Snate@binkert.org case_sorter.append(val) 8776657Snate@binkert.org 8786657Snate@binkert.org 8796657Snate@binkert.org # Emit the code sequences in a sorted order. This makes the 8806657Snate@binkert.org # output deterministic (without this the output order can vary 8816657Snate@binkert.org # since Map's keys() on a vector of pointers is not deterministic 8826657Snate@binkert.org for c in sorted(case_sorter): 8836657Snate@binkert.org case("$c") 8846657Snate@binkert.org 8856657Snate@binkert.org # Figure out if we stall 8866657Snate@binkert.org stall = False 8876657Snate@binkert.org for action in actions: 8886657Snate@binkert.org if action.ident == "z_stall": 8896657Snate@binkert.org stall = True 8906657Snate@binkert.org break 8916657Snate@binkert.org 8926657Snate@binkert.org if stall: 8936657Snate@binkert.org case('return TransitionResult_ProtocolStall;') 8946657Snate@binkert.org else: 8956657Snate@binkert.org for action in actions: 8966657Snate@binkert.org case('${{action.ident}}(addr);') 8976657Snate@binkert.org case('return TransitionResult_Valid;') 8986657Snate@binkert.org 8996657Snate@binkert.org case = str(case) 9006657Snate@binkert.org 9016657Snate@binkert.org # Look to see if this transition code is unique. 9026657Snate@binkert.org if case not in cases: 9036657Snate@binkert.org cases[case] = [] 9046657Snate@binkert.org 9056657Snate@binkert.org cases[case].append(case_string) 9066657Snate@binkert.org 9076657Snate@binkert.org # Walk through all of the unique code blocks and spit out the 9086657Snate@binkert.org # corresponding case statement elements 9096657Snate@binkert.org for case,transitions in cases.iteritems(): 9106657Snate@binkert.org # Iterative over all the multiple transitions that share 9116657Snate@binkert.org # the same code 9126657Snate@binkert.org for trans in transitions: 9136657Snate@binkert.org code(' case HASH_FUN($trans):') 9146657Snate@binkert.org code(' $case') 9156657Snate@binkert.org 9166657Snate@binkert.org code(''' 9176657Snate@binkert.org default: 9186657Snate@binkert.org WARN_EXPR(m_version); 9196657Snate@binkert.org WARN_EXPR(g_eventQueue_ptr->getTime()); 9206657Snate@binkert.org WARN_EXPR(addr); 9216657Snate@binkert.org WARN_EXPR(event); 9226657Snate@binkert.org WARN_EXPR(state); 9236657Snate@binkert.org ERROR_MSG(\"Invalid transition\"); 9246657Snate@binkert.org } 9256657Snate@binkert.org return TransitionResult_Valid; 9266657Snate@binkert.org} 9276657Snate@binkert.org''') 9286657Snate@binkert.org code.write(path, "%s_Transitions.cc" % self.ident) 9296657Snate@binkert.org 9306657Snate@binkert.org def printProfilerHH(self, path): 9316999Snate@binkert.org code = self.symtab.codeFormatter() 9326657Snate@binkert.org ident = self.ident 9336657Snate@binkert.org 9346657Snate@binkert.org code(''' 9356657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 9366657Snate@binkert.org// ${ident}: ${{self.short}} 9376657Snate@binkert.org 9387007Snate@binkert.org#ifndef __${ident}_PROFILER_HH_ 9397007Snate@binkert.org#define __${ident}_PROFILER_HH_ 9406657Snate@binkert.org 9417002Snate@binkert.org#include <iostream> 9427002Snate@binkert.org 9436657Snate@binkert.org#include "mem/ruby/common/Global.hh" 9446657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 9456657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 9466657Snate@binkert.org 9477007Snate@binkert.orgclass ${ident}_Profiler 9487007Snate@binkert.org{ 9496657Snate@binkert.org public: 9506657Snate@binkert.org ${ident}_Profiler(); 9516657Snate@binkert.org void setVersion(int version); 9526657Snate@binkert.org void countTransition(${ident}_State state, ${ident}_Event event); 9536657Snate@binkert.org void possibleTransition(${ident}_State state, ${ident}_Event event); 9547002Snate@binkert.org void dumpStats(std::ostream& out) const; 9556657Snate@binkert.org void clearStats(); 9566657Snate@binkert.org 9576657Snate@binkert.org private: 9586657Snate@binkert.org int m_counters[${ident}_State_NUM][${ident}_Event_NUM]; 9596657Snate@binkert.org int m_event_counters[${ident}_Event_NUM]; 9606657Snate@binkert.org bool m_possible[${ident}_State_NUM][${ident}_Event_NUM]; 9616657Snate@binkert.org int m_version; 9626657Snate@binkert.org}; 9636657Snate@binkert.org 9647007Snate@binkert.org#endif // __${ident}_PROFILER_HH__ 9656657Snate@binkert.org''') 9666657Snate@binkert.org code.write(path, "%s_Profiler.hh" % self.ident) 9676657Snate@binkert.org 9686657Snate@binkert.org def printProfilerCC(self, path): 9696999Snate@binkert.org code = self.symtab.codeFormatter() 9706657Snate@binkert.org ident = self.ident 9716657Snate@binkert.org 9726657Snate@binkert.org code(''' 9736657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 9746657Snate@binkert.org// ${ident}: ${{self.short}} 9756657Snate@binkert.org 9766657Snate@binkert.org#include "mem/protocol/${ident}_Profiler.hh" 9776657Snate@binkert.org 9786657Snate@binkert.org${ident}_Profiler::${ident}_Profiler() 9796657Snate@binkert.org{ 9806657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 9816657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 9826657Snate@binkert.org m_possible[state][event] = false; 9836657Snate@binkert.org m_counters[state][event] = 0; 9846657Snate@binkert.org } 9856657Snate@binkert.org } 9866657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 9876657Snate@binkert.org m_event_counters[event] = 0; 9886657Snate@binkert.org } 9896657Snate@binkert.org} 9907007Snate@binkert.org 9917007Snate@binkert.orgvoid 9927007Snate@binkert.org${ident}_Profiler::setVersion(int version) 9936657Snate@binkert.org{ 9946657Snate@binkert.org m_version = version; 9956657Snate@binkert.org} 9967007Snate@binkert.org 9977007Snate@binkert.orgvoid 9987007Snate@binkert.org${ident}_Profiler::clearStats() 9996657Snate@binkert.org{ 10006657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 10016657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 10026657Snate@binkert.org m_counters[state][event] = 0; 10036657Snate@binkert.org } 10046657Snate@binkert.org } 10056657Snate@binkert.org 10066657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 10076657Snate@binkert.org m_event_counters[event] = 0; 10086657Snate@binkert.org } 10096657Snate@binkert.org} 10107007Snate@binkert.orgvoid 10117007Snate@binkert.org${ident}_Profiler::countTransition(${ident}_State state, ${ident}_Event event) 10126657Snate@binkert.org{ 10136657Snate@binkert.org assert(m_possible[state][event]); 10146657Snate@binkert.org m_counters[state][event]++; 10156657Snate@binkert.org m_event_counters[event]++; 10166657Snate@binkert.org} 10177007Snate@binkert.orgvoid 10187007Snate@binkert.org${ident}_Profiler::possibleTransition(${ident}_State state, 10197007Snate@binkert.org ${ident}_Event event) 10206657Snate@binkert.org{ 10216657Snate@binkert.org m_possible[state][event] = true; 10226657Snate@binkert.org} 10237007Snate@binkert.org 10247007Snate@binkert.orgvoid 10257007Snate@binkert.org${ident}_Profiler::dumpStats(std::ostream& out) const 10266657Snate@binkert.org{ 10277002Snate@binkert.org using namespace std; 10287002Snate@binkert.org 10296657Snate@binkert.org out << " --- ${ident} " << m_version << " ---" << endl; 10306657Snate@binkert.org out << " - Event Counts -" << endl; 10316657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 10326657Snate@binkert.org int count = m_event_counters[event]; 10336657Snate@binkert.org out << (${ident}_Event) event << " " << count << endl; 10346657Snate@binkert.org } 10356657Snate@binkert.org out << endl; 10366657Snate@binkert.org out << " - Transitions -" << endl; 10376657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 10386657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 10396657Snate@binkert.org if (m_possible[state][event]) { 10406657Snate@binkert.org int count = m_counters[state][event]; 10417007Snate@binkert.org out << (${ident}_State) state << " " 10427007Snate@binkert.org << (${ident}_Event) event << " " << count; 10436657Snate@binkert.org if (count == 0) { 10446657Snate@binkert.org out << " <-- "; 10456657Snate@binkert.org } 10466657Snate@binkert.org out << endl; 10476657Snate@binkert.org } 10486657Snate@binkert.org } 10496657Snate@binkert.org out << endl; 10506657Snate@binkert.org } 10516657Snate@binkert.org} 10526657Snate@binkert.org''') 10536657Snate@binkert.org code.write(path, "%s_Profiler.cc" % self.ident) 10546657Snate@binkert.org 10556657Snate@binkert.org # ************************** 10566657Snate@binkert.org # ******* HTML Files ******* 10576657Snate@binkert.org # ************************** 10587007Snate@binkert.org def frameRef(self, click_href, click_target, over_href, over_num, text): 10596999Snate@binkert.org code = self.symtab.codeFormatter(fix_newlines=False) 10607007Snate@binkert.org code("""<A href=\"$click_href\" target=\"$click_target\" onmouseover=\" 10617007Snate@binkert.org if (parent.frames[$over_num].location != parent.location + '$over_href') { 10627007Snate@binkert.org parent.frames[$over_num].location='$over_href' 10637007Snate@binkert.org }\"> 10647007Snate@binkert.org ${{html.formatShorthand(text)}} 10657007Snate@binkert.org </A>""") 10666657Snate@binkert.org return str(code) 10676657Snate@binkert.org 10686657Snate@binkert.org def writeHTMLFiles(self, path): 10696657Snate@binkert.org # Create table with no row hilighted 10706657Snate@binkert.org self.printHTMLTransitions(path, None) 10716657Snate@binkert.org 10726657Snate@binkert.org # Generate transition tables 10736657Snate@binkert.org for state in self.states.itervalues(): 10746657Snate@binkert.org self.printHTMLTransitions(path, state) 10756657Snate@binkert.org 10766657Snate@binkert.org # Generate action descriptions 10776657Snate@binkert.org for action in self.actions.itervalues(): 10786657Snate@binkert.org name = "%s_action_%s.html" % (self.ident, action.ident) 10796657Snate@binkert.org code = html.createSymbol(action, "Action") 10806657Snate@binkert.org code.write(path, name) 10816657Snate@binkert.org 10826657Snate@binkert.org # Generate state descriptions 10836657Snate@binkert.org for state in self.states.itervalues(): 10846657Snate@binkert.org name = "%s_State_%s.html" % (self.ident, state.ident) 10856657Snate@binkert.org code = html.createSymbol(state, "State") 10866657Snate@binkert.org code.write(path, name) 10876657Snate@binkert.org 10886657Snate@binkert.org # Generate event descriptions 10896657Snate@binkert.org for event in self.events.itervalues(): 10906657Snate@binkert.org name = "%s_Event_%s.html" % (self.ident, event.ident) 10916657Snate@binkert.org code = html.createSymbol(event, "Event") 10926657Snate@binkert.org code.write(path, name) 10936657Snate@binkert.org 10946657Snate@binkert.org def printHTMLTransitions(self, path, active_state): 10956999Snate@binkert.org code = self.symtab.codeFormatter() 10966657Snate@binkert.org 10976657Snate@binkert.org code(''' 10987007Snate@binkert.org<HTML> 10997007Snate@binkert.org<BODY link="blue" vlink="blue"> 11006657Snate@binkert.org 11016657Snate@binkert.org<H1 align="center">${{html.formatShorthand(self.short)}}: 11026657Snate@binkert.org''') 11036657Snate@binkert.org code.indent() 11046657Snate@binkert.org for i,machine in enumerate(self.symtab.getAllType(StateMachine)): 11056657Snate@binkert.org mid = machine.ident 11066657Snate@binkert.org if i != 0: 11076657Snate@binkert.org extra = " - " 11086657Snate@binkert.org else: 11096657Snate@binkert.org extra = "" 11106657Snate@binkert.org if machine == self: 11116657Snate@binkert.org code('$extra$mid') 11126657Snate@binkert.org else: 11136657Snate@binkert.org code('$extra<A target="Table" href="${mid}_table.html">$mid</A>') 11146657Snate@binkert.org code.dedent() 11156657Snate@binkert.org 11166657Snate@binkert.org code(""" 11176657Snate@binkert.org</H1> 11186657Snate@binkert.org 11196657Snate@binkert.org<TABLE border=1> 11206657Snate@binkert.org<TR> 11216657Snate@binkert.org <TH> </TH> 11226657Snate@binkert.org""") 11236657Snate@binkert.org 11246657Snate@binkert.org for event in self.events.itervalues(): 11256657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 11266657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 11276657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 11286657Snate@binkert.org 11296657Snate@binkert.org code('</TR>') 11306657Snate@binkert.org # -- Body of table 11316657Snate@binkert.org for state in self.states.itervalues(): 11326657Snate@binkert.org # -- Each row 11336657Snate@binkert.org if state == active_state: 11346657Snate@binkert.org color = "yellow" 11356657Snate@binkert.org else: 11366657Snate@binkert.org color = "white" 11376657Snate@binkert.org 11386657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 11396657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 11406657Snate@binkert.org text = html.formatShorthand(state.short) 11416657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 11426657Snate@binkert.org code(''' 11436657Snate@binkert.org<TR> 11446657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 11456657Snate@binkert.org''') 11466657Snate@binkert.org 11476657Snate@binkert.org # -- One column for each event 11486657Snate@binkert.org for event in self.events.itervalues(): 11496657Snate@binkert.org trans = self.table.get((state,event), None) 11506657Snate@binkert.org if trans is None: 11516657Snate@binkert.org # This is the no transition case 11526657Snate@binkert.org if state == active_state: 11536657Snate@binkert.org color = "#C0C000" 11546657Snate@binkert.org else: 11556657Snate@binkert.org color = "lightgrey" 11566657Snate@binkert.org 11576657Snate@binkert.org code('<TD bgcolor=$color> </TD>') 11586657Snate@binkert.org continue 11596657Snate@binkert.org 11606657Snate@binkert.org next = trans.nextState 11616657Snate@binkert.org stall_action = False 11626657Snate@binkert.org 11636657Snate@binkert.org # -- Get the actions 11646657Snate@binkert.org for action in trans.actions: 11656657Snate@binkert.org if action.ident == "z_stall" or \ 11666657Snate@binkert.org action.ident == "zz_recycleMandatoryQueue": 11676657Snate@binkert.org stall_action = True 11686657Snate@binkert.org 11696657Snate@binkert.org # -- Print out "actions/next-state" 11706657Snate@binkert.org if stall_action: 11716657Snate@binkert.org if state == active_state: 11726657Snate@binkert.org color = "#C0C000" 11736657Snate@binkert.org else: 11746657Snate@binkert.org color = "lightgrey" 11756657Snate@binkert.org 11766657Snate@binkert.org elif active_state and next.ident == active_state.ident: 11776657Snate@binkert.org color = "aqua" 11786657Snate@binkert.org elif state == active_state: 11796657Snate@binkert.org color = "yellow" 11806657Snate@binkert.org else: 11816657Snate@binkert.org color = "white" 11826657Snate@binkert.org 11836657Snate@binkert.org code('<TD bgcolor=$color>') 11846657Snate@binkert.org for action in trans.actions: 11856657Snate@binkert.org href = "%s_action_%s.html" % (self.ident, action.ident) 11866657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", 11876657Snate@binkert.org action.short) 11887007Snate@binkert.org code(' $ref') 11896657Snate@binkert.org if next != state: 11906657Snate@binkert.org if trans.actions: 11916657Snate@binkert.org code('/') 11926657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, next.ident) 11936657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, next.ident) 11946657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", next.short) 11956657Snate@binkert.org code("$ref") 11967007Snate@binkert.org code("</TD>") 11976657Snate@binkert.org 11986657Snate@binkert.org # -- Each row 11996657Snate@binkert.org if state == active_state: 12006657Snate@binkert.org color = "yellow" 12016657Snate@binkert.org else: 12026657Snate@binkert.org color = "white" 12036657Snate@binkert.org 12046657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 12056657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 12066657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 12076657Snate@binkert.org code(''' 12086657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 12096657Snate@binkert.org</TR> 12106657Snate@binkert.org''') 12116657Snate@binkert.org code(''' 12127007Snate@binkert.org<!- Column footer-> 12136657Snate@binkert.org<TR> 12146657Snate@binkert.org <TH> </TH> 12156657Snate@binkert.org''') 12166657Snate@binkert.org 12176657Snate@binkert.org for event in self.events.itervalues(): 12186657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 12196657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 12206657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 12216657Snate@binkert.org code(''' 12226657Snate@binkert.org</TR> 12236657Snate@binkert.org</TABLE> 12246657Snate@binkert.org</BODY></HTML> 12256657Snate@binkert.org''') 12266657Snate@binkert.org 12276657Snate@binkert.org 12286657Snate@binkert.org if active_state: 12296657Snate@binkert.org name = "%s_table_%s.html" % (self.ident, active_state.ident) 12306657Snate@binkert.org else: 12316657Snate@binkert.org name = "%s_table.html" % self.ident 12326657Snate@binkert.org code.write(path, name) 12336657Snate@binkert.org 12346657Snate@binkert.org__all__ = [ "StateMachine" ] 1235