StateMachine.py revision 6882
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 286657Snate@binkert.orgfrom m5.util import code_formatter, 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", 356882SBrad.Beckmann@amd.com "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", 416882SBrad.Beckmann@amd.com } 426882SBrad.Beckmann@amd.com 436657Snate@binkert.orgclass StateMachine(Symbol): 446657Snate@binkert.org def __init__(self, symtab, ident, location, pairs, config_parameters): 456657Snate@binkert.org super(StateMachine, self).__init__(symtab, ident, location, pairs) 466657Snate@binkert.org self.table = None 476657Snate@binkert.org self.config_parameters = config_parameters 486657Snate@binkert.org for param in config_parameters: 496882SBrad.Beckmann@amd.com if param.pointer: 506882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 516882SBrad.Beckmann@amd.com "(*m_%s_ptr)" % param.name, {}, self) 526882SBrad.Beckmann@amd.com else: 536882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 546882SBrad.Beckmann@amd.com "m_%s" % param.name, {}, self) 556657Snate@binkert.org self.symtab.registerSym(param.name, var) 566657Snate@binkert.org 576657Snate@binkert.org self.states = orderdict() 586657Snate@binkert.org self.events = orderdict() 596657Snate@binkert.org self.actions = orderdict() 606657Snate@binkert.org self.transitions = [] 616657Snate@binkert.org self.in_ports = [] 626657Snate@binkert.org self.functions = [] 636657Snate@binkert.org self.objects = [] 646657Snate@binkert.org 656657Snate@binkert.org self.message_buffer_names = [] 666657Snate@binkert.org 676657Snate@binkert.org def __repr__(self): 686657Snate@binkert.org return "[StateMachine: %s]" % self.ident 696657Snate@binkert.org 706657Snate@binkert.org def addState(self, state): 716657Snate@binkert.org assert self.table is None 726657Snate@binkert.org self.states[state.ident] = state 736657Snate@binkert.org 746657Snate@binkert.org def addEvent(self, event): 756657Snate@binkert.org assert self.table is None 766657Snate@binkert.org self.events[event.ident] = event 776657Snate@binkert.org 786657Snate@binkert.org def addAction(self, action): 796657Snate@binkert.org assert self.table is None 806657Snate@binkert.org 816657Snate@binkert.org # Check for duplicate action 826657Snate@binkert.org for other in self.actions.itervalues(): 836657Snate@binkert.org if action.ident == other.ident: 846779SBrad.Beckmann@amd.com action.warning("Duplicate action definition: %s" % action.ident) 856657Snate@binkert.org action.error("Duplicate action definition: %s" % action.ident) 866657Snate@binkert.org if action.short == other.short: 876657Snate@binkert.org other.warning("Duplicate action shorthand: %s" % other.ident) 886657Snate@binkert.org other.warning(" shorthand = %s" % other.short) 896657Snate@binkert.org action.warning("Duplicate action shorthand: %s" % action.ident) 906657Snate@binkert.org action.error(" shorthand = %s" % action.short) 916657Snate@binkert.org 926657Snate@binkert.org self.actions[action.ident] = action 936657Snate@binkert.org 946657Snate@binkert.org def addTransition(self, trans): 956657Snate@binkert.org assert self.table is None 966657Snate@binkert.org self.transitions.append(trans) 976657Snate@binkert.org 986657Snate@binkert.org def addInPort(self, var): 996657Snate@binkert.org self.in_ports.append(var) 1006657Snate@binkert.org 1016657Snate@binkert.org def addFunc(self, func): 1026657Snate@binkert.org # register func in the symbol table 1036657Snate@binkert.org self.symtab.registerSym(str(func), func) 1046657Snate@binkert.org self.functions.append(func) 1056657Snate@binkert.org 1066657Snate@binkert.org def addObject(self, obj): 1076657Snate@binkert.org self.objects.append(obj) 1086657Snate@binkert.org 1096657Snate@binkert.org # Needs to be called before accessing the table 1106657Snate@binkert.org def buildTable(self): 1116657Snate@binkert.org assert self.table is None 1126657Snate@binkert.org 1136657Snate@binkert.org table = {} 1146657Snate@binkert.org 1156657Snate@binkert.org for trans in self.transitions: 1166657Snate@binkert.org # Track which actions we touch so we know if we use them 1176657Snate@binkert.org # all -- really this should be done for all symbols as 1186657Snate@binkert.org # part of the symbol table, then only trigger it for 1196657Snate@binkert.org # Actions, States, Events, etc. 1206657Snate@binkert.org 1216657Snate@binkert.org for action in trans.actions: 1226657Snate@binkert.org action.used = True 1236657Snate@binkert.org 1246657Snate@binkert.org index = (trans.state, trans.event) 1256657Snate@binkert.org if index in table: 1266657Snate@binkert.org table[index].warning("Duplicate transition: %s" % table[index]) 1276657Snate@binkert.org trans.error("Duplicate transition: %s" % trans) 1286657Snate@binkert.org table[index] = trans 1296657Snate@binkert.org 1306657Snate@binkert.org # Look at all actions to make sure we used them all 1316657Snate@binkert.org for action in self.actions.itervalues(): 1326657Snate@binkert.org if not action.used: 1336657Snate@binkert.org error_msg = "Unused action: %s" % action.ident 1346657Snate@binkert.org if "desc" in action: 1356657Snate@binkert.org error_msg += ", " + action.desc 1366657Snate@binkert.org action.warning(error_msg) 1376657Snate@binkert.org self.table = table 1386657Snate@binkert.org 1396657Snate@binkert.org def writeCodeFiles(self, path): 1406877Ssteve.reinhardt@amd.com self.printControllerPython(path) 1416657Snate@binkert.org self.printControllerHH(path) 1426657Snate@binkert.org self.printControllerCC(path) 1436657Snate@binkert.org self.printCSwitch(path) 1446657Snate@binkert.org self.printCWakeup(path) 1456657Snate@binkert.org self.printProfilerCC(path) 1466657Snate@binkert.org self.printProfilerHH(path) 1476657Snate@binkert.org 1486657Snate@binkert.org for func in self.functions: 1496657Snate@binkert.org func.writeCodeFiles(path) 1506657Snate@binkert.org 1516877Ssteve.reinhardt@amd.com def printControllerPython(self, path): 1526877Ssteve.reinhardt@amd.com code = code_formatter() 1536877Ssteve.reinhardt@amd.com ident = self.ident 1546877Ssteve.reinhardt@amd.com py_ident = "%s_Controller" % ident 1556877Ssteve.reinhardt@amd.com c_ident = "%s_Controller" % self.ident 1566877Ssteve.reinhardt@amd.com code(''' 1576877Ssteve.reinhardt@amd.comfrom m5.params import * 1586877Ssteve.reinhardt@amd.comfrom m5.SimObject import SimObject 1596877Ssteve.reinhardt@amd.comfrom Controller import RubyController 1606877Ssteve.reinhardt@amd.com 1616877Ssteve.reinhardt@amd.comclass $py_ident(RubyController): 1626877Ssteve.reinhardt@amd.com type = '$py_ident' 1636877Ssteve.reinhardt@amd.com''') 1646877Ssteve.reinhardt@amd.com code.indent() 1656877Ssteve.reinhardt@amd.com for param in self.config_parameters: 1666877Ssteve.reinhardt@amd.com dflt_str = '' 1676877Ssteve.reinhardt@amd.com if param.default is not None: 1686877Ssteve.reinhardt@amd.com dflt_str = str(param.default) + ', ' 1696882SBrad.Beckmann@amd.com if python_class_map.has_key(param.type_ast.type.c_ident): 1706882SBrad.Beckmann@amd.com python_type = python_class_map[param.type_ast.type.c_ident] 1716882SBrad.Beckmann@amd.com code('${{param.name}} = Param.${{python_type}}(${dflt_str}"")') 1726882SBrad.Beckmann@amd.com else: 1736882SBrad.Beckmann@amd.com self.error("Unknown c++ to python class conversion for c++ " \ 1746882SBrad.Beckmann@amd.com "type: '%s'. Please update the python_class_map " \ 1756882SBrad.Beckmann@amd.com "in StateMachine.py", param.type_ast.type.c_ident) 1766877Ssteve.reinhardt@amd.com code.dedent() 1776877Ssteve.reinhardt@amd.com code.write(path, '%s.py' % py_ident) 1786877Ssteve.reinhardt@amd.com 1796877Ssteve.reinhardt@amd.com 1806657Snate@binkert.org def printControllerHH(self, path): 1816657Snate@binkert.org '''Output the method declarations for the class declaration''' 1826657Snate@binkert.org code = code_formatter() 1836657Snate@binkert.org ident = self.ident 1846657Snate@binkert.org c_ident = "%s_Controller" % self.ident 1856657Snate@binkert.org 1866657Snate@binkert.org self.message_buffer_names = [] 1876657Snate@binkert.org 1886657Snate@binkert.org code(''' 1896657Snate@binkert.org/** \\file $ident.hh 1906657Snate@binkert.org * 1916657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 1926657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 1936657Snate@binkert.org */ 1946657Snate@binkert.org 1956657Snate@binkert.org#ifndef ${ident}_CONTROLLER_H 1966657Snate@binkert.org#define ${ident}_CONTROLLER_H 1976657Snate@binkert.org 1986877Ssteve.reinhardt@amd.com#include "params/$c_ident.hh" 1996877Ssteve.reinhardt@amd.com 2006657Snate@binkert.org#include "mem/ruby/common/Global.hh" 2016657Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 2026657Snate@binkert.org#include "mem/ruby/slicc_interface/AbstractController.hh" 2036657Snate@binkert.org#include "mem/protocol/TransitionResult.hh" 2046657Snate@binkert.org#include "mem/protocol/Types.hh" 2056657Snate@binkert.org#include "mem/protocol/${ident}_Profiler.hh" 2066657Snate@binkert.org''') 2076657Snate@binkert.org 2086657Snate@binkert.org seen_types = set() 2096657Snate@binkert.org for var in self.objects: 2106793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 2116657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 2126657Snate@binkert.org seen_types.add(var.type.ident) 2136657Snate@binkert.org 2146657Snate@binkert.org # for adding information to the protocol debug trace 2156657Snate@binkert.org code(''' 2166657Snate@binkert.orgextern stringstream ${ident}_transitionComment; 2176657Snate@binkert.org 2186657Snate@binkert.orgclass $c_ident : public AbstractController { 2196657Snate@binkert.org#ifdef CHECK_COHERENCE 2206657Snate@binkert.org#endif /* CHECK_COHERENCE */ 2216657Snate@binkert.orgpublic: 2226877Ssteve.reinhardt@amd.com typedef ${c_ident}Params Params; 2236877Ssteve.reinhardt@amd.com $c_ident(const Params *p); 2246657Snate@binkert.org static int getNumControllers(); 2256877Ssteve.reinhardt@amd.com void init(); 2266657Snate@binkert.org MessageBuffer* getMandatoryQueue() const; 2276657Snate@binkert.org const int & getVersion() const; 2286657Snate@binkert.org const string toString() const; 2296657Snate@binkert.org const string getName() const; 2306657Snate@binkert.org const MachineType getMachineType() const; 2316881SBrad.Beckmann@amd.com void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 2326657Snate@binkert.org void print(ostream& out) const; 2336657Snate@binkert.org void printConfig(ostream& out) const; 2346657Snate@binkert.org void wakeup(); 2356657Snate@binkert.org void printStats(ostream& out) const { s_profiler.dumpStats(out); } 2366657Snate@binkert.org void clearStats() { s_profiler.clearStats(); } 2376863Sdrh5@cs.wisc.edu void blockOnQueue(Address addr, MessageBuffer* port); 2386863Sdrh5@cs.wisc.edu void unblock(Address addr); 2396657Snate@binkert.orgprivate: 2406657Snate@binkert.org''') 2416657Snate@binkert.org 2426657Snate@binkert.org code.indent() 2436657Snate@binkert.org # added by SS 2446657Snate@binkert.org for param in self.config_parameters: 2456882SBrad.Beckmann@amd.com if param.pointer: 2466882SBrad.Beckmann@amd.com code('${{param.type_ast.type}}* m_${{param.ident}}_ptr;') 2476882SBrad.Beckmann@amd.com else: 2486882SBrad.Beckmann@amd.com code('${{param.type_ast.type}} m_${{param.ident}};') 2496657Snate@binkert.org 2506657Snate@binkert.org code(''' 2516657Snate@binkert.orgint m_number_of_TBEs; 2526657Snate@binkert.org 2536657Snate@binkert.orgTransitionResult doTransition(${ident}_Event event, ${ident}_State state, const Address& addr); // in ${ident}_Transitions.cc 2546657Snate@binkert.orgTransitionResult doTransitionWorker(${ident}_Event event, ${ident}_State state, ${ident}_State& next_state, const Address& addr); // in ${ident}_Transitions.cc 2556657Snate@binkert.orgstring m_name; 2566657Snate@binkert.orgint m_transitions_per_cycle; 2576657Snate@binkert.orgint m_buffer_size; 2586657Snate@binkert.orgint m_recycle_latency; 2596657Snate@binkert.orgmap< string, string > m_cfg; 2606657Snate@binkert.orgNodeID m_version; 2616657Snate@binkert.orgNetwork* m_net_ptr; 2626657Snate@binkert.orgMachineID m_machineID; 2636863Sdrh5@cs.wisc.edubool m_is_blocking; 2646863Sdrh5@cs.wisc.edumap< Address, MessageBuffer* > m_block_map; 2656657Snate@binkert.org${ident}_Profiler s_profiler; 2666657Snate@binkert.orgstatic int m_num_controllers; 2676657Snate@binkert.org// Internal functions 2686657Snate@binkert.org''') 2696657Snate@binkert.org 2706657Snate@binkert.org for func in self.functions: 2716657Snate@binkert.org proto = func.prototype 2726657Snate@binkert.org if proto: 2736657Snate@binkert.org code('$proto') 2746657Snate@binkert.org 2756657Snate@binkert.org code(''' 2766657Snate@binkert.org 2776657Snate@binkert.org// Actions 2786657Snate@binkert.org''') 2796657Snate@binkert.org for action in self.actions.itervalues(): 2806657Snate@binkert.org code('/** \\brief ${{action.desc}} */') 2816657Snate@binkert.org code('void ${{action.ident}}(const Address& addr);') 2826657Snate@binkert.org 2836657Snate@binkert.org # the controller internal variables 2846657Snate@binkert.org code(''' 2856657Snate@binkert.org 2866657Snate@binkert.org// Object 2876657Snate@binkert.org''') 2886657Snate@binkert.org for var in self.objects: 2896657Snate@binkert.org th = var.get("template_hack", "") 2906657Snate@binkert.org code('${{var.type.c_ident}}$th* m_${{var.c_ident}}_ptr;') 2916657Snate@binkert.org 2926657Snate@binkert.org if var.type.ident == "MessageBuffer": 2936657Snate@binkert.org self.message_buffer_names.append("m_%s_ptr" % var.c_ident) 2946657Snate@binkert.org 2956657Snate@binkert.org code.dedent() 2966657Snate@binkert.org code('};') 2976657Snate@binkert.org code('#endif // ${ident}_CONTROLLER_H') 2986657Snate@binkert.org code.write(path, '%s.hh' % c_ident) 2996657Snate@binkert.org 3006657Snate@binkert.org def printControllerCC(self, path): 3016657Snate@binkert.org '''Output the actions for performing the actions''' 3026657Snate@binkert.org 3036657Snate@binkert.org code = code_formatter() 3046657Snate@binkert.org ident = self.ident 3056657Snate@binkert.org c_ident = "%s_Controller" % self.ident 3066657Snate@binkert.org 3076657Snate@binkert.org code(''' 3086657Snate@binkert.org/** \\file $ident.cc 3096657Snate@binkert.org * 3106657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 3116657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 3126657Snate@binkert.org */ 3136657Snate@binkert.org 3146657Snate@binkert.org#include "mem/ruby/common/Global.hh" 3156657Snate@binkert.org#include "mem/ruby/slicc_interface/RubySlicc_includes.hh" 3166657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 3176657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 3186657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 3196657Snate@binkert.org#include "mem/protocol/Types.hh" 3206657Snate@binkert.org#include "mem/ruby/system/System.hh" 3216657Snate@binkert.org''') 3226657Snate@binkert.org 3236657Snate@binkert.org # include object classes 3246657Snate@binkert.org seen_types = set() 3256657Snate@binkert.org for var in self.objects: 3266793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 3276657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 3286657Snate@binkert.org seen_types.add(var.type.ident) 3296657Snate@binkert.org 3306657Snate@binkert.org code(''' 3316877Ssteve.reinhardt@amd.com$c_ident * 3326877Ssteve.reinhardt@amd.com${c_ident}Params::create() 3336877Ssteve.reinhardt@amd.com{ 3346877Ssteve.reinhardt@amd.com return new $c_ident(this); 3356877Ssteve.reinhardt@amd.com} 3366877Ssteve.reinhardt@amd.com 3376877Ssteve.reinhardt@amd.com 3386657Snate@binkert.orgint $c_ident::m_num_controllers = 0; 3396657Snate@binkert.org 3406657Snate@binkert.orgstringstream ${ident}_transitionComment; 3416657Snate@binkert.org#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str) 3426657Snate@binkert.org/** \\brief constructor */ 3436877Ssteve.reinhardt@amd.com$c_ident::$c_ident(const Params *p) 3446877Ssteve.reinhardt@amd.com : AbstractController(p) 3456657Snate@binkert.org{ 3466877Ssteve.reinhardt@amd.com m_version = p->version; 3476877Ssteve.reinhardt@amd.com m_transitions_per_cycle = p->transitions_per_cycle; 3486877Ssteve.reinhardt@amd.com m_buffer_size = p->buffer_size; 3496877Ssteve.reinhardt@amd.com m_recycle_latency = p->recycle_latency; 3506877Ssteve.reinhardt@amd.com m_number_of_TBEs = p->number_of_TBEs; 3516657Snate@binkert.org''') 3526657Snate@binkert.org code.indent() 3536882SBrad.Beckmann@amd.com 3546882SBrad.Beckmann@amd.com # 3556882SBrad.Beckmann@amd.com # After initializing the universal machine parameters, initialize the 3566882SBrad.Beckmann@amd.com # this machines config parameters. Also detemine if these configuration 3576882SBrad.Beckmann@amd.com # params include a sequencer. This information will be used later for 3586882SBrad.Beckmann@amd.com # contecting the sequencer back to the L1 cache controller. 3596882SBrad.Beckmann@amd.com # 3606882SBrad.Beckmann@amd.com contains_sequencer = False 3616877Ssteve.reinhardt@amd.com for param in self.config_parameters: 3626882SBrad.Beckmann@amd.com if param.name == "sequencer": 3636882SBrad.Beckmann@amd.com contains_sequencer = True 3646882SBrad.Beckmann@amd.com if param.pointer: 3656882SBrad.Beckmann@amd.com code('m_${{param.name}}_ptr = p->${{param.name}};') 3666882SBrad.Beckmann@amd.com else: 3676882SBrad.Beckmann@amd.com code('m_${{param.name}} = p->${{param.name}};') 3686882SBrad.Beckmann@amd.com 3696882SBrad.Beckmann@amd.com # 3706882SBrad.Beckmann@amd.com # For the l1 cache controller, add the special atomic support which 3716882SBrad.Beckmann@amd.com # includes passing the sequencer a pointer to the controller. 3726882SBrad.Beckmann@amd.com # 3736882SBrad.Beckmann@amd.com if self.ident == "L1Cache": 3746882SBrad.Beckmann@amd.com if not contains_sequencer: 3756882SBrad.Beckmann@amd.com self.error("The L1Cache controller must include the sequencer " \ 3766882SBrad.Beckmann@amd.com "configuration parameter") 3776882SBrad.Beckmann@amd.com 3786882SBrad.Beckmann@amd.com code(''' 3796882SBrad.Beckmann@amd.comm_sequencer_ptr->setController(this); 3806882SBrad.Beckmann@amd.com''') 3816657Snate@binkert.org 3826657Snate@binkert.org code('m_num_controllers++;') 3836657Snate@binkert.org for var in self.objects: 3846657Snate@binkert.org if var.ident.find("mandatoryQueue") >= 0: 3856657Snate@binkert.org code('m_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}();') 3866657Snate@binkert.org 3876657Snate@binkert.org code.dedent() 3886657Snate@binkert.org code(''' 3896657Snate@binkert.org} 3906657Snate@binkert.org 3916877Ssteve.reinhardt@amd.comvoid $c_ident::init() 3926657Snate@binkert.org{ 3936657Snate@binkert.org m_machineID.type = MachineType_${ident}; 3946657Snate@binkert.org m_machineID.num = m_version; 3956657Snate@binkert.org 3966657Snate@binkert.org // Objects 3976657Snate@binkert.org s_profiler.setVersion(m_version); 3986657Snate@binkert.org''') 3996657Snate@binkert.org 4006657Snate@binkert.org code.indent() 4016657Snate@binkert.org for var in self.objects: 4026657Snate@binkert.org vtype = var.type 4036657Snate@binkert.org vid = "m_%s_ptr" % var.c_ident 4046657Snate@binkert.org if "network" not in var: 4056657Snate@binkert.org # Not a network port object 4066657Snate@binkert.org if "primitive" in vtype: 4076657Snate@binkert.org code('$vid = new ${{vtype.c_ident}};') 4086657Snate@binkert.org if "default" in var: 4096657Snate@binkert.org code('(*$vid) = ${{var["default"]}};') 4106657Snate@binkert.org else: 4116657Snate@binkert.org # Normal Object 4126657Snate@binkert.org # added by SS 4136657Snate@binkert.org if "factory" in var: 4146657Snate@binkert.org code('$vid = ${{var["factory"]}};') 4156657Snate@binkert.org elif var.ident.find("mandatoryQueue") < 0: 4166657Snate@binkert.org th = var.get("template_hack", "") 4176657Snate@binkert.org expr = "%s = new %s%s" % (vid, vtype.c_ident, th) 4186657Snate@binkert.org 4196657Snate@binkert.org args = "" 4206657Snate@binkert.org if "non_obj" not in vtype and not vtype.isEnumeration: 4216657Snate@binkert.org if expr.find("TBETable") >= 0: 4226657Snate@binkert.org args = "m_number_of_TBEs" 4236657Snate@binkert.org else: 4246657Snate@binkert.org args = var.get("constructor_hack", "") 4256657Snate@binkert.org args = "(%s)" % args 4266657Snate@binkert.org 4276657Snate@binkert.org code('$expr$args;') 4286657Snate@binkert.org else: 4296657Snate@binkert.org code(';') 4306657Snate@binkert.org 4316657Snate@binkert.org code('assert($vid != NULL);') 4326657Snate@binkert.org 4336657Snate@binkert.org if "default" in var: 4346657Snate@binkert.org code('(*$vid) = ${{var["default"]}}; // Object default') 4356657Snate@binkert.org elif "default" in vtype: 4366657Snate@binkert.org code('(*$vid) = ${{vtype["default"]}}; // Type ${{vtype.ident}} default') 4376657Snate@binkert.org 4386657Snate@binkert.org # Set ordering 4396657Snate@binkert.org if "ordered" in var and "trigger_queue" not in var: 4406657Snate@binkert.org # A buffer 4416657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 4426657Snate@binkert.org 4436657Snate@binkert.org # Set randomization 4446657Snate@binkert.org if "random" in var: 4456657Snate@binkert.org # A buffer 4466657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}});') 4476657Snate@binkert.org 4486657Snate@binkert.org # Set Priority 4496657Snate@binkert.org if vtype.isBuffer and \ 4506657Snate@binkert.org "rank" in var and "trigger_queue" not in var: 4516657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}});') 4526657Snate@binkert.org else: 4536657Snate@binkert.org # Network port object 4546657Snate@binkert.org network = var["network"] 4556657Snate@binkert.org ordered = var["ordered"] 4566657Snate@binkert.org vnet = var["virtual_network"] 4576657Snate@binkert.org 4586657Snate@binkert.org assert var.machine is not None 4596657Snate@binkert.org code(''' 4606657Snate@binkert.org$vid = m_net_ptr->get${network}NetQueue(m_version+MachineType_base_number(string_to_MachineType("${{var.machine.ident}}")), $ordered, $vnet); 4616657Snate@binkert.org''') 4626657Snate@binkert.org 4636657Snate@binkert.org code('assert($vid != NULL);') 4646657Snate@binkert.org 4656657Snate@binkert.org # Set ordering 4666657Snate@binkert.org if "ordered" in var: 4676657Snate@binkert.org # A buffer 4686657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 4696657Snate@binkert.org 4706657Snate@binkert.org # Set randomization 4716657Snate@binkert.org if "random" in var: 4726657Snate@binkert.org # A buffer 4736657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}})') 4746657Snate@binkert.org 4756657Snate@binkert.org # Set Priority 4766657Snate@binkert.org if "rank" in var: 4776657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}})') 4786657Snate@binkert.org 4796657Snate@binkert.org # Set buffer size 4806657Snate@binkert.org if vtype.isBuffer: 4816657Snate@binkert.org code(''' 4826657Snate@binkert.orgif (m_buffer_size > 0) { 4836657Snate@binkert.org $vid->setSize(m_buffer_size); 4846657Snate@binkert.org} 4856657Snate@binkert.org''') 4866657Snate@binkert.org 4876657Snate@binkert.org # set description (may be overriden later by port def) 4886657Snate@binkert.org code('$vid->setDescription("[Version " + int_to_string(m_version) + ", ${ident}, name=${{var.c_ident}}]");') 4896657Snate@binkert.org 4906657Snate@binkert.org # Set the queue consumers 4916657Snate@binkert.org code.insert_newline() 4926657Snate@binkert.org for port in self.in_ports: 4936657Snate@binkert.org code('${{port.code}}.setConsumer(this);') 4946657Snate@binkert.org 4956657Snate@binkert.org # Set the queue descriptions 4966657Snate@binkert.org code.insert_newline() 4976657Snate@binkert.org for port in self.in_ports: 4986657Snate@binkert.org code('${{port.code}}.setDescription("[Version " + int_to_string(m_version) + ", $ident, $port]");') 4996657Snate@binkert.org 5006657Snate@binkert.org # Initialize the transition profiling 5016657Snate@binkert.org code.insert_newline() 5026657Snate@binkert.org for trans in self.transitions: 5036657Snate@binkert.org # Figure out if we stall 5046657Snate@binkert.org stall = False 5056657Snate@binkert.org for action in trans.actions: 5066657Snate@binkert.org if action.ident == "z_stall": 5076657Snate@binkert.org stall = True 5086657Snate@binkert.org 5096657Snate@binkert.org # Only possible if it is not a 'z' case 5106657Snate@binkert.org if not stall: 5116657Snate@binkert.org state = "%s_State_%s" % (self.ident, trans.state.ident) 5126657Snate@binkert.org event = "%s_Event_%s" % (self.ident, trans.event.ident) 5136657Snate@binkert.org code('s_profiler.possibleTransition($state, $event);') 5146657Snate@binkert.org 5156657Snate@binkert.org # added by SS to initialize recycle_latency of message buffers 5166657Snate@binkert.org for buf in self.message_buffer_names: 5176657Snate@binkert.org code("$buf->setRecycleLatency(m_recycle_latency);") 5186657Snate@binkert.org 5196657Snate@binkert.org code.dedent() 5206657Snate@binkert.org code('}') 5216657Snate@binkert.org 5226657Snate@binkert.org has_mandatory_q = False 5236657Snate@binkert.org for port in self.in_ports: 5246657Snate@binkert.org if port.code.find("mandatoryQueue_ptr") >= 0: 5256657Snate@binkert.org has_mandatory_q = True 5266657Snate@binkert.org 5276657Snate@binkert.org if has_mandatory_q: 5286657Snate@binkert.org mq_ident = "m_%s_mandatoryQueue_ptr" % self.ident 5296657Snate@binkert.org else: 5306657Snate@binkert.org mq_ident = "NULL" 5316657Snate@binkert.org 5326657Snate@binkert.org code(''' 5336657Snate@binkert.orgint $c_ident::getNumControllers() { 5346657Snate@binkert.org return m_num_controllers; 5356657Snate@binkert.org} 5366657Snate@binkert.org 5376657Snate@binkert.orgMessageBuffer* $c_ident::getMandatoryQueue() const { 5386657Snate@binkert.org return $mq_ident; 5396657Snate@binkert.org} 5406657Snate@binkert.org 5416657Snate@binkert.orgconst int & $c_ident::getVersion() const{ 5426657Snate@binkert.org return m_version; 5436657Snate@binkert.org} 5446657Snate@binkert.org 5456657Snate@binkert.orgconst string $c_ident::toString() const{ 5466657Snate@binkert.org return "$c_ident"; 5476657Snate@binkert.org} 5486657Snate@binkert.org 5496657Snate@binkert.orgconst string $c_ident::getName() const{ 5506657Snate@binkert.org return m_name; 5516657Snate@binkert.org} 5526657Snate@binkert.orgconst MachineType $c_ident::getMachineType() const{ 5536657Snate@binkert.org return MachineType_${ident}; 5546657Snate@binkert.org} 5556657Snate@binkert.org 5566863Sdrh5@cs.wisc.eduvoid $c_ident::blockOnQueue(Address addr, MessageBuffer* port) { 5576863Sdrh5@cs.wisc.edu m_is_blocking = true; 5586863Sdrh5@cs.wisc.edu m_block_map[addr] = port; 5596863Sdrh5@cs.wisc.edu} 5606863Sdrh5@cs.wisc.eduvoid $c_ident::unblock(Address addr) { 5616863Sdrh5@cs.wisc.edu m_block_map.erase(addr); 5626863Sdrh5@cs.wisc.edu if (m_block_map.size() == 0) { 5636863Sdrh5@cs.wisc.edu m_is_blocking = false; 5646863Sdrh5@cs.wisc.edu } 5656863Sdrh5@cs.wisc.edu} 5666863Sdrh5@cs.wisc.edu 5676657Snate@binkert.orgvoid $c_ident::print(ostream& out) const { out << "[$c_ident " << m_version << "]"; } 5686657Snate@binkert.org 5696657Snate@binkert.orgvoid $c_ident::printConfig(ostream& out) const { 5706657Snate@binkert.org out << "$c_ident config: " << m_name << endl; 5716657Snate@binkert.org out << " version: " << m_version << endl; 5726657Snate@binkert.org for (map<string, string>::const_iterator it = m_cfg.begin(); it != m_cfg.end(); it++) { 5736657Snate@binkert.org out << " " << (*it).first << ": " << (*it).second << endl; 5746657Snate@binkert.org } 5756657Snate@binkert.org} 5766657Snate@binkert.org 5776657Snate@binkert.org// Actions 5786657Snate@binkert.org''') 5796657Snate@binkert.org 5806657Snate@binkert.org for action in self.actions.itervalues(): 5816657Snate@binkert.org if "c_code" not in action: 5826657Snate@binkert.org continue 5836657Snate@binkert.org 5846657Snate@binkert.org code(''' 5856657Snate@binkert.org/** \\brief ${{action.desc}} */ 5866657Snate@binkert.orgvoid $c_ident::${{action.ident}}(const Address& addr) 5876657Snate@binkert.org{ 5886657Snate@binkert.org DEBUG_MSG(GENERATED_COMP, HighPrio, "executing"); 5896657Snate@binkert.org ${{action["c_code"]}} 5906657Snate@binkert.org} 5916657Snate@binkert.org 5926657Snate@binkert.org''') 5936657Snate@binkert.org code.write(path, "%s.cc" % c_ident) 5946657Snate@binkert.org 5956657Snate@binkert.org def printCWakeup(self, path): 5966657Snate@binkert.org '''Output the wakeup loop for the events''' 5976657Snate@binkert.org 5986657Snate@binkert.org code = code_formatter() 5996657Snate@binkert.org ident = self.ident 6006657Snate@binkert.org 6016657Snate@binkert.org code(''' 6026657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 6036657Snate@binkert.org// ${ident}: ${{self.short}} 6046657Snate@binkert.org 6056657Snate@binkert.org#include "mem/ruby/common/Global.hh" 6066657Snate@binkert.org#include "mem/ruby/slicc_interface/RubySlicc_includes.hh" 6076657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 6086657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 6096657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 6106657Snate@binkert.org#include "mem/protocol/Types.hh" 6116657Snate@binkert.org#include "mem/ruby/system/System.hh" 6126657Snate@binkert.org 6136657Snate@binkert.orgvoid ${ident}_Controller::wakeup() 6146657Snate@binkert.org{ 6156657Snate@binkert.org 6166657Snate@binkert.org int counter = 0; 6176657Snate@binkert.org while (true) { 6186657Snate@binkert.org // Some cases will put us into an infinite loop without this limit 6196657Snate@binkert.org assert(counter <= m_transitions_per_cycle); 6206657Snate@binkert.org if (counter == m_transitions_per_cycle) { 6216657Snate@binkert.org g_system_ptr->getProfiler()->controllerBusy(m_machineID); // Count how often we\'re fully utilized 6226657Snate@binkert.org g_eventQueue_ptr->scheduleEvent(this, 1); // Wakeup in another cycle and try again 6236657Snate@binkert.org break; 6246657Snate@binkert.org } 6256657Snate@binkert.org''') 6266657Snate@binkert.org 6276657Snate@binkert.org code.indent() 6286657Snate@binkert.org code.indent() 6296657Snate@binkert.org 6306657Snate@binkert.org # InPorts 6316657Snate@binkert.org # 6326657Snate@binkert.org for port in self.in_ports: 6336657Snate@binkert.org code.indent() 6346657Snate@binkert.org code('// ${ident}InPort $port') 6356657Snate@binkert.org code('${{port["c_code_in_port"]}}') 6366657Snate@binkert.org code.dedent() 6376657Snate@binkert.org 6386657Snate@binkert.org code('') 6396657Snate@binkert.org 6406657Snate@binkert.org code.dedent() 6416657Snate@binkert.org code.dedent() 6426657Snate@binkert.org code(''' 6436657Snate@binkert.org break; // If we got this far, we have nothing left todo 6446657Snate@binkert.org } 6456657Snate@binkert.org} 6466657Snate@binkert.org''') 6476657Snate@binkert.org 6486657Snate@binkert.org code.write(path, "%s_Wakeup.cc" % self.ident) 6496657Snate@binkert.org 6506657Snate@binkert.org def printCSwitch(self, path): 6516657Snate@binkert.org '''Output switch statement for transition table''' 6526657Snate@binkert.org 6536657Snate@binkert.org code = code_formatter() 6546657Snate@binkert.org ident = self.ident 6556657Snate@binkert.org 6566657Snate@binkert.org code(''' 6576657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 6586657Snate@binkert.org// ${ident}: ${{self.short}} 6596657Snate@binkert.org 6606657Snate@binkert.org#include "mem/ruby/common/Global.hh" 6616657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 6626657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 6636657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 6646657Snate@binkert.org#include "mem/protocol/Types.hh" 6656657Snate@binkert.org#include "mem/ruby/system/System.hh" 6666657Snate@binkert.org 6676657Snate@binkert.org#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event)) 6686657Snate@binkert.org 6696657Snate@binkert.org#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str()) 6706657Snate@binkert.org#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str("")) 6716657Snate@binkert.org 6726657Snate@binkert.orgTransitionResult ${ident}_Controller::doTransition(${ident}_Event event, ${ident}_State state, const Address& addr 6736657Snate@binkert.org) 6746657Snate@binkert.org{ 6756657Snate@binkert.org ${ident}_State next_state = state; 6766657Snate@binkert.org 6776657Snate@binkert.org DEBUG_NEWLINE(GENERATED_COMP, MedPrio); 6786657Snate@binkert.org DEBUG_MSG(GENERATED_COMP, MedPrio, *this); 6796657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio, g_eventQueue_ptr->getTime()); 6806657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio,state); 6816657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio,event); 6826657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio,addr); 6836657Snate@binkert.org 6846657Snate@binkert.org TransitionResult result = doTransitionWorker(event, state, next_state, addr); 6856657Snate@binkert.org 6866657Snate@binkert.org if (result == TransitionResult_Valid) { 6876657Snate@binkert.org DEBUG_EXPR(GENERATED_COMP, MedPrio, next_state); 6886657Snate@binkert.org DEBUG_NEWLINE(GENERATED_COMP, MedPrio); 6896657Snate@binkert.org s_profiler.countTransition(state, event); 6906657Snate@binkert.org if (Debug::getProtocolTrace()) { 6916657Snate@binkert.org g_system_ptr->getProfiler()->profileTransition("${ident}", m_version, addr, 6926657Snate@binkert.org ${ident}_State_to_string(state), 6936657Snate@binkert.org ${ident}_Event_to_string(event), 6946657Snate@binkert.org ${ident}_State_to_string(next_state), GET_TRANSITION_COMMENT()); 6956657Snate@binkert.org } 6966657Snate@binkert.org CLEAR_TRANSITION_COMMENT(); 6976657Snate@binkert.org ${ident}_setState(addr, next_state); 6986657Snate@binkert.org 6996657Snate@binkert.org } else if (result == TransitionResult_ResourceStall) { 7006657Snate@binkert.org if (Debug::getProtocolTrace()) { 7016657Snate@binkert.org g_system_ptr->getProfiler()->profileTransition("${ident}", m_version, addr, 7026657Snate@binkert.org ${ident}_State_to_string(state), 7036657Snate@binkert.org ${ident}_Event_to_string(event), 7046657Snate@binkert.org ${ident}_State_to_string(next_state), 7056657Snate@binkert.org "Resource Stall"); 7066657Snate@binkert.org } 7076657Snate@binkert.org } else if (result == TransitionResult_ProtocolStall) { 7086657Snate@binkert.org DEBUG_MSG(GENERATED_COMP, HighPrio, "stalling"); 7096657Snate@binkert.org DEBUG_NEWLINE(GENERATED_COMP, MedPrio); 7106657Snate@binkert.org if (Debug::getProtocolTrace()) { 7116657Snate@binkert.org g_system_ptr->getProfiler()->profileTransition("${ident}", m_version, addr, 7126657Snate@binkert.org ${ident}_State_to_string(state), 7136657Snate@binkert.org ${ident}_Event_to_string(event), 7146657Snate@binkert.org ${ident}_State_to_string(next_state), 7156657Snate@binkert.org "Protocol Stall"); 7166657Snate@binkert.org } 7176657Snate@binkert.org } 7186657Snate@binkert.org 7196657Snate@binkert.org return result; 7206657Snate@binkert.org} 7216657Snate@binkert.org 7226657Snate@binkert.orgTransitionResult ${ident}_Controller::doTransitionWorker(${ident}_Event event, ${ident}_State state, ${ident}_State& next_state, const Address& addr 7236657Snate@binkert.org) 7246657Snate@binkert.org{ 7256657Snate@binkert.org switch(HASH_FUN(state, event)) { 7266657Snate@binkert.org''') 7276657Snate@binkert.org 7286657Snate@binkert.org # This map will allow suppress generating duplicate code 7296657Snate@binkert.org cases = orderdict() 7306657Snate@binkert.org 7316657Snate@binkert.org for trans in self.transitions: 7326657Snate@binkert.org case_string = "%s_State_%s, %s_Event_%s" % \ 7336657Snate@binkert.org (self.ident, trans.state.ident, self.ident, trans.event.ident) 7346657Snate@binkert.org 7356657Snate@binkert.org case = code_formatter() 7366657Snate@binkert.org # Only set next_state if it changes 7376657Snate@binkert.org if trans.state != trans.nextState: 7386657Snate@binkert.org ns_ident = trans.nextState.ident 7396657Snate@binkert.org case('next_state = ${ident}_State_${ns_ident};') 7406657Snate@binkert.org 7416657Snate@binkert.org actions = trans.actions 7426657Snate@binkert.org 7436657Snate@binkert.org # Check for resources 7446657Snate@binkert.org case_sorter = [] 7456657Snate@binkert.org res = trans.resources 7466657Snate@binkert.org for key,val in res.iteritems(): 7476657Snate@binkert.org if key.type.ident != "DNUCAStopTable": 7486657Snate@binkert.org val = ''' 7496657Snate@binkert.orgif (!%s.areNSlotsAvailable(%s)) { 7506657Snate@binkert.org return TransitionResult_ResourceStall; 7516657Snate@binkert.org} 7526657Snate@binkert.org''' % (key.code, val) 7536657Snate@binkert.org case_sorter.append(val) 7546657Snate@binkert.org 7556657Snate@binkert.org 7566657Snate@binkert.org # Emit the code sequences in a sorted order. This makes the 7576657Snate@binkert.org # output deterministic (without this the output order can vary 7586657Snate@binkert.org # since Map's keys() on a vector of pointers is not deterministic 7596657Snate@binkert.org for c in sorted(case_sorter): 7606657Snate@binkert.org case("$c") 7616657Snate@binkert.org 7626657Snate@binkert.org # Figure out if we stall 7636657Snate@binkert.org stall = False 7646657Snate@binkert.org for action in actions: 7656657Snate@binkert.org if action.ident == "z_stall": 7666657Snate@binkert.org stall = True 7676657Snate@binkert.org break 7686657Snate@binkert.org 7696657Snate@binkert.org if stall: 7706657Snate@binkert.org case('return TransitionResult_ProtocolStall;') 7716657Snate@binkert.org else: 7726657Snate@binkert.org for action in actions: 7736657Snate@binkert.org case('${{action.ident}}(addr);') 7746657Snate@binkert.org case('return TransitionResult_Valid;') 7756657Snate@binkert.org 7766657Snate@binkert.org case = str(case) 7776657Snate@binkert.org 7786657Snate@binkert.org # Look to see if this transition code is unique. 7796657Snate@binkert.org if case not in cases: 7806657Snate@binkert.org cases[case] = [] 7816657Snate@binkert.org 7826657Snate@binkert.org cases[case].append(case_string) 7836657Snate@binkert.org 7846657Snate@binkert.org # Walk through all of the unique code blocks and spit out the 7856657Snate@binkert.org # corresponding case statement elements 7866657Snate@binkert.org for case,transitions in cases.iteritems(): 7876657Snate@binkert.org # Iterative over all the multiple transitions that share 7886657Snate@binkert.org # the same code 7896657Snate@binkert.org for trans in transitions: 7906657Snate@binkert.org code(' case HASH_FUN($trans):') 7916657Snate@binkert.org code(' {') 7926657Snate@binkert.org code(' $case') 7936657Snate@binkert.org code(' }') 7946657Snate@binkert.org 7956657Snate@binkert.org code(''' 7966657Snate@binkert.org default: 7976657Snate@binkert.org WARN_EXPR(m_version); 7986657Snate@binkert.org WARN_EXPR(g_eventQueue_ptr->getTime()); 7996657Snate@binkert.org WARN_EXPR(addr); 8006657Snate@binkert.org WARN_EXPR(event); 8016657Snate@binkert.org WARN_EXPR(state); 8026657Snate@binkert.org ERROR_MSG(\"Invalid transition\"); 8036657Snate@binkert.org } 8046657Snate@binkert.org return TransitionResult_Valid; 8056657Snate@binkert.org} 8066657Snate@binkert.org''') 8076657Snate@binkert.org code.write(path, "%s_Transitions.cc" % self.ident) 8086657Snate@binkert.org 8096657Snate@binkert.org def printProfilerHH(self, path): 8106657Snate@binkert.org code = code_formatter() 8116657Snate@binkert.org ident = self.ident 8126657Snate@binkert.org 8136657Snate@binkert.org code(''' 8146657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 8156657Snate@binkert.org// ${ident}: ${{self.short}} 8166657Snate@binkert.org 8176657Snate@binkert.org#ifndef ${ident}_PROFILER_H 8186657Snate@binkert.org#define ${ident}_PROFILER_H 8196657Snate@binkert.org 8206657Snate@binkert.org#include "mem/ruby/common/Global.hh" 8216657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 8226657Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 8236657Snate@binkert.org 8246657Snate@binkert.orgclass ${ident}_Profiler { 8256657Snate@binkert.org public: 8266657Snate@binkert.org ${ident}_Profiler(); 8276657Snate@binkert.org void setVersion(int version); 8286657Snate@binkert.org void countTransition(${ident}_State state, ${ident}_Event event); 8296657Snate@binkert.org void possibleTransition(${ident}_State state, ${ident}_Event event); 8306657Snate@binkert.org void dumpStats(ostream& out) const; 8316657Snate@binkert.org void clearStats(); 8326657Snate@binkert.org 8336657Snate@binkert.org private: 8346657Snate@binkert.org int m_counters[${ident}_State_NUM][${ident}_Event_NUM]; 8356657Snate@binkert.org int m_event_counters[${ident}_Event_NUM]; 8366657Snate@binkert.org bool m_possible[${ident}_State_NUM][${ident}_Event_NUM]; 8376657Snate@binkert.org int m_version; 8386657Snate@binkert.org}; 8396657Snate@binkert.org 8406657Snate@binkert.org#endif // ${ident}_PROFILER_H 8416657Snate@binkert.org''') 8426657Snate@binkert.org code.write(path, "%s_Profiler.hh" % self.ident) 8436657Snate@binkert.org 8446657Snate@binkert.org def printProfilerCC(self, path): 8456657Snate@binkert.org code = code_formatter() 8466657Snate@binkert.org ident = self.ident 8476657Snate@binkert.org 8486657Snate@binkert.org code(''' 8496657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 8506657Snate@binkert.org// ${ident}: ${{self.short}} 8516657Snate@binkert.org 8526657Snate@binkert.org#include "mem/protocol/${ident}_Profiler.hh" 8536657Snate@binkert.org 8546657Snate@binkert.org${ident}_Profiler::${ident}_Profiler() 8556657Snate@binkert.org{ 8566657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 8576657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 8586657Snate@binkert.org m_possible[state][event] = false; 8596657Snate@binkert.org m_counters[state][event] = 0; 8606657Snate@binkert.org } 8616657Snate@binkert.org } 8626657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 8636657Snate@binkert.org m_event_counters[event] = 0; 8646657Snate@binkert.org } 8656657Snate@binkert.org} 8666657Snate@binkert.orgvoid ${ident}_Profiler::setVersion(int version) 8676657Snate@binkert.org{ 8686657Snate@binkert.org m_version = version; 8696657Snate@binkert.org} 8706657Snate@binkert.orgvoid ${ident}_Profiler::clearStats() 8716657Snate@binkert.org{ 8726657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 8736657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 8746657Snate@binkert.org m_counters[state][event] = 0; 8756657Snate@binkert.org } 8766657Snate@binkert.org } 8776657Snate@binkert.org 8786657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 8796657Snate@binkert.org m_event_counters[event] = 0; 8806657Snate@binkert.org } 8816657Snate@binkert.org} 8826657Snate@binkert.orgvoid ${ident}_Profiler::countTransition(${ident}_State state, ${ident}_Event event) 8836657Snate@binkert.org{ 8846657Snate@binkert.org assert(m_possible[state][event]); 8856657Snate@binkert.org m_counters[state][event]++; 8866657Snate@binkert.org m_event_counters[event]++; 8876657Snate@binkert.org} 8886657Snate@binkert.orgvoid ${ident}_Profiler::possibleTransition(${ident}_State state, ${ident}_Event event) 8896657Snate@binkert.org{ 8906657Snate@binkert.org m_possible[state][event] = true; 8916657Snate@binkert.org} 8926657Snate@binkert.orgvoid ${ident}_Profiler::dumpStats(ostream& out) const 8936657Snate@binkert.org{ 8946657Snate@binkert.org out << " --- ${ident} " << m_version << " ---" << endl; 8956657Snate@binkert.org out << " - Event Counts -" << endl; 8966657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 8976657Snate@binkert.org int count = m_event_counters[event]; 8986657Snate@binkert.org out << (${ident}_Event) event << " " << count << endl; 8996657Snate@binkert.org } 9006657Snate@binkert.org out << endl; 9016657Snate@binkert.org out << " - Transitions -" << endl; 9026657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 9036657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 9046657Snate@binkert.org if (m_possible[state][event]) { 9056657Snate@binkert.org int count = m_counters[state][event]; 9066657Snate@binkert.org out << (${ident}_State) state << " " << (${ident}_Event) event << " " << count; 9076657Snate@binkert.org if (count == 0) { 9086657Snate@binkert.org out << " <-- "; 9096657Snate@binkert.org } 9106657Snate@binkert.org out << endl; 9116657Snate@binkert.org } 9126657Snate@binkert.org } 9136657Snate@binkert.org out << endl; 9146657Snate@binkert.org } 9156657Snate@binkert.org} 9166657Snate@binkert.org''') 9176657Snate@binkert.org code.write(path, "%s_Profiler.cc" % self.ident) 9186657Snate@binkert.org 9196657Snate@binkert.org # ************************** 9206657Snate@binkert.org # ******* HTML Files ******* 9216657Snate@binkert.org # ************************** 9226657Snate@binkert.org def frameRef(self, click_href, click_target, over_href, over_target_num, 9236657Snate@binkert.org text): 9246657Snate@binkert.org code = code_formatter(fix_newlines=False) 9256657Snate@binkert.org code("""<A href=\"$click_href\" target=\"$click_target\" onMouseOver=\"if (parent.frames[$over_target_num].location != parent.location + '$over_href') { parent.frames[$over_target_num].location='$over_href' }\" >${{html.formatShorthand(text)}}</A>""") 9266657Snate@binkert.org return str(code) 9276657Snate@binkert.org 9286657Snate@binkert.org def writeHTMLFiles(self, path): 9296657Snate@binkert.org # Create table with no row hilighted 9306657Snate@binkert.org self.printHTMLTransitions(path, None) 9316657Snate@binkert.org 9326657Snate@binkert.org # Generate transition tables 9336657Snate@binkert.org for state in self.states.itervalues(): 9346657Snate@binkert.org self.printHTMLTransitions(path, state) 9356657Snate@binkert.org 9366657Snate@binkert.org # Generate action descriptions 9376657Snate@binkert.org for action in self.actions.itervalues(): 9386657Snate@binkert.org name = "%s_action_%s.html" % (self.ident, action.ident) 9396657Snate@binkert.org code = html.createSymbol(action, "Action") 9406657Snate@binkert.org code.write(path, name) 9416657Snate@binkert.org 9426657Snate@binkert.org # Generate state descriptions 9436657Snate@binkert.org for state in self.states.itervalues(): 9446657Snate@binkert.org name = "%s_State_%s.html" % (self.ident, state.ident) 9456657Snate@binkert.org code = html.createSymbol(state, "State") 9466657Snate@binkert.org code.write(path, name) 9476657Snate@binkert.org 9486657Snate@binkert.org # Generate event descriptions 9496657Snate@binkert.org for event in self.events.itervalues(): 9506657Snate@binkert.org name = "%s_Event_%s.html" % (self.ident, event.ident) 9516657Snate@binkert.org code = html.createSymbol(event, "Event") 9526657Snate@binkert.org code.write(path, name) 9536657Snate@binkert.org 9546657Snate@binkert.org def printHTMLTransitions(self, path, active_state): 9556657Snate@binkert.org code = code_formatter() 9566657Snate@binkert.org 9576657Snate@binkert.org code(''' 9586657Snate@binkert.org<HTML><BODY link="blue" vlink="blue"> 9596657Snate@binkert.org 9606657Snate@binkert.org<H1 align="center">${{html.formatShorthand(self.short)}}: 9616657Snate@binkert.org''') 9626657Snate@binkert.org code.indent() 9636657Snate@binkert.org for i,machine in enumerate(self.symtab.getAllType(StateMachine)): 9646657Snate@binkert.org mid = machine.ident 9656657Snate@binkert.org if i != 0: 9666657Snate@binkert.org extra = " - " 9676657Snate@binkert.org else: 9686657Snate@binkert.org extra = "" 9696657Snate@binkert.org if machine == self: 9706657Snate@binkert.org code('$extra$mid') 9716657Snate@binkert.org else: 9726657Snate@binkert.org code('$extra<A target="Table" href="${mid}_table.html">$mid</A>') 9736657Snate@binkert.org code.dedent() 9746657Snate@binkert.org 9756657Snate@binkert.org code(""" 9766657Snate@binkert.org</H1> 9776657Snate@binkert.org 9786657Snate@binkert.org<TABLE border=1> 9796657Snate@binkert.org<TR> 9806657Snate@binkert.org <TH> </TH> 9816657Snate@binkert.org""") 9826657Snate@binkert.org 9836657Snate@binkert.org for event in self.events.itervalues(): 9846657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 9856657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 9866657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 9876657Snate@binkert.org 9886657Snate@binkert.org code('</TR>') 9896657Snate@binkert.org # -- Body of table 9906657Snate@binkert.org for state in self.states.itervalues(): 9916657Snate@binkert.org # -- Each row 9926657Snate@binkert.org if state == active_state: 9936657Snate@binkert.org color = "yellow" 9946657Snate@binkert.org else: 9956657Snate@binkert.org color = "white" 9966657Snate@binkert.org 9976657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 9986657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 9996657Snate@binkert.org text = html.formatShorthand(state.short) 10006657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 10016657Snate@binkert.org code(''' 10026657Snate@binkert.org<TR> 10036657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 10046657Snate@binkert.org''') 10056657Snate@binkert.org 10066657Snate@binkert.org # -- One column for each event 10076657Snate@binkert.org for event in self.events.itervalues(): 10086657Snate@binkert.org trans = self.table.get((state,event), None) 10096657Snate@binkert.org if trans is None: 10106657Snate@binkert.org # This is the no transition case 10116657Snate@binkert.org if state == active_state: 10126657Snate@binkert.org color = "#C0C000" 10136657Snate@binkert.org else: 10146657Snate@binkert.org color = "lightgrey" 10156657Snate@binkert.org 10166657Snate@binkert.org code('<TD bgcolor=$color> </TD>') 10176657Snate@binkert.org continue 10186657Snate@binkert.org 10196657Snate@binkert.org next = trans.nextState 10206657Snate@binkert.org stall_action = False 10216657Snate@binkert.org 10226657Snate@binkert.org # -- Get the actions 10236657Snate@binkert.org for action in trans.actions: 10246657Snate@binkert.org if action.ident == "z_stall" or \ 10256657Snate@binkert.org action.ident == "zz_recycleMandatoryQueue": 10266657Snate@binkert.org stall_action = True 10276657Snate@binkert.org 10286657Snate@binkert.org # -- Print out "actions/next-state" 10296657Snate@binkert.org if stall_action: 10306657Snate@binkert.org if state == active_state: 10316657Snate@binkert.org color = "#C0C000" 10326657Snate@binkert.org else: 10336657Snate@binkert.org color = "lightgrey" 10346657Snate@binkert.org 10356657Snate@binkert.org elif active_state and next.ident == active_state.ident: 10366657Snate@binkert.org color = "aqua" 10376657Snate@binkert.org elif state == active_state: 10386657Snate@binkert.org color = "yellow" 10396657Snate@binkert.org else: 10406657Snate@binkert.org color = "white" 10416657Snate@binkert.org 10426657Snate@binkert.org fix = code.nofix() 10436657Snate@binkert.org code('<TD bgcolor=$color>') 10446657Snate@binkert.org for action in trans.actions: 10456657Snate@binkert.org href = "%s_action_%s.html" % (self.ident, action.ident) 10466657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", 10476657Snate@binkert.org action.short) 10486657Snate@binkert.org code(' $ref\n') 10496657Snate@binkert.org if next != state: 10506657Snate@binkert.org if trans.actions: 10516657Snate@binkert.org code('/') 10526657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, next.ident) 10536657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, next.ident) 10546657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", next.short) 10556657Snate@binkert.org code("$ref") 10566657Snate@binkert.org code("</TD>\n") 10576657Snate@binkert.org code.fix(fix) 10586657Snate@binkert.org 10596657Snate@binkert.org # -- Each row 10606657Snate@binkert.org if state == active_state: 10616657Snate@binkert.org color = "yellow" 10626657Snate@binkert.org else: 10636657Snate@binkert.org color = "white" 10646657Snate@binkert.org 10656657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 10666657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 10676657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 10686657Snate@binkert.org code(''' 10696657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 10706657Snate@binkert.org</TR> 10716657Snate@binkert.org''') 10726657Snate@binkert.org code(''' 10736657Snate@binkert.org<TR> 10746657Snate@binkert.org <TH> </TH> 10756657Snate@binkert.org''') 10766657Snate@binkert.org 10776657Snate@binkert.org for event in self.events.itervalues(): 10786657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 10796657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 10806657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 10816657Snate@binkert.org code(''' 10826657Snate@binkert.org</TR> 10836657Snate@binkert.org</TABLE> 10846657Snate@binkert.org</BODY></HTML> 10856657Snate@binkert.org''') 10866657Snate@binkert.org 10876657Snate@binkert.org 10886657Snate@binkert.org if active_state: 10896657Snate@binkert.org name = "%s_table_%s.html" % (self.ident, active_state.ident) 10906657Snate@binkert.org else: 10916657Snate@binkert.org name = "%s_table.html" % self.ident 10926657Snate@binkert.org code.write(path, name) 10936657Snate@binkert.org 10946657Snate@binkert.org__all__ = [ "StateMachine" ] 1095