StateMachine.py revision 9496
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 338189SLisa.Hsu@amd.comimport re 346657Snate@binkert.org 356882SBrad.Beckmann@amd.compython_class_map = {"int": "Int", 369364Snilay@cs.wisc.edu "uint32_t" : "UInt32", 377055Snate@binkert.org "std::string": "String", 386882SBrad.Beckmann@amd.com "bool": "Bool", 396882SBrad.Beckmann@amd.com "CacheMemory": "RubyCache", 408191SLisa.Hsu@amd.com "WireBuffer": "RubyWireBuffer", 416882SBrad.Beckmann@amd.com "Sequencer": "RubySequencer", 426882SBrad.Beckmann@amd.com "DirectoryMemory": "RubyDirectoryMemory", 439102SNuwan.Jayasena@amd.com "MemoryControl": "MemoryControl", 449366Snilay@cs.wisc.edu "DMASequencer": "DMASequencer", 459366Snilay@cs.wisc.edu "Prefetcher":"Prefetcher" 466882SBrad.Beckmann@amd.com } 476882SBrad.Beckmann@amd.com 486657Snate@binkert.orgclass StateMachine(Symbol): 496657Snate@binkert.org def __init__(self, symtab, ident, location, pairs, config_parameters): 506657Snate@binkert.org super(StateMachine, self).__init__(symtab, ident, location, pairs) 516657Snate@binkert.org self.table = None 526657Snate@binkert.org self.config_parameters = config_parameters 539366Snilay@cs.wisc.edu self.prefetchers = [] 547839Snilay@cs.wisc.edu 556657Snate@binkert.org for param in config_parameters: 566882SBrad.Beckmann@amd.com if param.pointer: 576882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 586882SBrad.Beckmann@amd.com "(*m_%s_ptr)" % param.name, {}, self) 596882SBrad.Beckmann@amd.com else: 606882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 616882SBrad.Beckmann@amd.com "m_%s" % param.name, {}, self) 626657Snate@binkert.org self.symtab.registerSym(param.name, var) 639366Snilay@cs.wisc.edu if str(param.type_ast.type) == "Prefetcher": 649366Snilay@cs.wisc.edu self.prefetchers.append(var) 656657Snate@binkert.org 666657Snate@binkert.org self.states = orderdict() 676657Snate@binkert.org self.events = orderdict() 686657Snate@binkert.org self.actions = orderdict() 699104Shestness@cs.utexas.edu self.request_types = orderdict() 706657Snate@binkert.org self.transitions = [] 716657Snate@binkert.org self.in_ports = [] 726657Snate@binkert.org self.functions = [] 736657Snate@binkert.org self.objects = [] 747839Snilay@cs.wisc.edu self.TBEType = None 757839Snilay@cs.wisc.edu self.EntryType = None 769366Snilay@cs.wisc.edu self.message_buffer_names = [] 776657Snate@binkert.org 786657Snate@binkert.org 796657Snate@binkert.org def __repr__(self): 806657Snate@binkert.org return "[StateMachine: %s]" % self.ident 816657Snate@binkert.org 826657Snate@binkert.org def addState(self, state): 836657Snate@binkert.org assert self.table is None 846657Snate@binkert.org self.states[state.ident] = state 856657Snate@binkert.org 866657Snate@binkert.org def addEvent(self, event): 876657Snate@binkert.org assert self.table is None 886657Snate@binkert.org self.events[event.ident] = event 896657Snate@binkert.org 906657Snate@binkert.org def addAction(self, action): 916657Snate@binkert.org assert self.table is None 926657Snate@binkert.org 936657Snate@binkert.org # Check for duplicate action 946657Snate@binkert.org for other in self.actions.itervalues(): 956657Snate@binkert.org if action.ident == other.ident: 966779SBrad.Beckmann@amd.com action.warning("Duplicate action definition: %s" % action.ident) 976657Snate@binkert.org action.error("Duplicate action definition: %s" % action.ident) 986657Snate@binkert.org if action.short == other.short: 996657Snate@binkert.org other.warning("Duplicate action shorthand: %s" % other.ident) 1006657Snate@binkert.org other.warning(" shorthand = %s" % other.short) 1016657Snate@binkert.org action.warning("Duplicate action shorthand: %s" % action.ident) 1026657Snate@binkert.org action.error(" shorthand = %s" % action.short) 1036657Snate@binkert.org 1046657Snate@binkert.org self.actions[action.ident] = action 1056657Snate@binkert.org 1069104Shestness@cs.utexas.edu def addRequestType(self, request_type): 1079104Shestness@cs.utexas.edu assert self.table is None 1089104Shestness@cs.utexas.edu self.request_types[request_type.ident] = request_type 1099104Shestness@cs.utexas.edu 1106657Snate@binkert.org def addTransition(self, trans): 1116657Snate@binkert.org assert self.table is None 1126657Snate@binkert.org self.transitions.append(trans) 1136657Snate@binkert.org 1146657Snate@binkert.org def addInPort(self, var): 1156657Snate@binkert.org self.in_ports.append(var) 1166657Snate@binkert.org 1176657Snate@binkert.org def addFunc(self, func): 1186657Snate@binkert.org # register func in the symbol table 1196657Snate@binkert.org self.symtab.registerSym(str(func), func) 1206657Snate@binkert.org self.functions.append(func) 1216657Snate@binkert.org 1226657Snate@binkert.org def addObject(self, obj): 1236657Snate@binkert.org self.objects.append(obj) 1246657Snate@binkert.org 1257839Snilay@cs.wisc.edu def addType(self, type): 1267839Snilay@cs.wisc.edu type_ident = '%s' % type.c_ident 1277839Snilay@cs.wisc.edu 1287839Snilay@cs.wisc.edu if type_ident == "%s_TBE" %self.ident: 1297839Snilay@cs.wisc.edu if self.TBEType != None: 1307839Snilay@cs.wisc.edu self.error("Multiple Transaction Buffer types in a " \ 1317839Snilay@cs.wisc.edu "single machine."); 1327839Snilay@cs.wisc.edu self.TBEType = type 1337839Snilay@cs.wisc.edu 1347839Snilay@cs.wisc.edu elif "interface" in type and "AbstractCacheEntry" == type["interface"]: 1357839Snilay@cs.wisc.edu if self.EntryType != None: 1367839Snilay@cs.wisc.edu self.error("Multiple AbstractCacheEntry types in a " \ 1377839Snilay@cs.wisc.edu "single machine."); 1387839Snilay@cs.wisc.edu self.EntryType = type 1397839Snilay@cs.wisc.edu 1406657Snate@binkert.org # Needs to be called before accessing the table 1416657Snate@binkert.org def buildTable(self): 1426657Snate@binkert.org assert self.table is None 1436657Snate@binkert.org 1446657Snate@binkert.org table = {} 1456657Snate@binkert.org 1466657Snate@binkert.org for trans in self.transitions: 1476657Snate@binkert.org # Track which actions we touch so we know if we use them 1486657Snate@binkert.org # all -- really this should be done for all symbols as 1496657Snate@binkert.org # part of the symbol table, then only trigger it for 1506657Snate@binkert.org # Actions, States, Events, etc. 1516657Snate@binkert.org 1526657Snate@binkert.org for action in trans.actions: 1536657Snate@binkert.org action.used = True 1546657Snate@binkert.org 1556657Snate@binkert.org index = (trans.state, trans.event) 1566657Snate@binkert.org if index in table: 1576657Snate@binkert.org table[index].warning("Duplicate transition: %s" % table[index]) 1586657Snate@binkert.org trans.error("Duplicate transition: %s" % trans) 1596657Snate@binkert.org table[index] = trans 1606657Snate@binkert.org 1616657Snate@binkert.org # Look at all actions to make sure we used them all 1626657Snate@binkert.org for action in self.actions.itervalues(): 1636657Snate@binkert.org if not action.used: 1646657Snate@binkert.org error_msg = "Unused action: %s" % action.ident 1656657Snate@binkert.org if "desc" in action: 1666657Snate@binkert.org error_msg += ", " + action.desc 1676657Snate@binkert.org action.warning(error_msg) 1686657Snate@binkert.org self.table = table 1696657Snate@binkert.org 1709219Spower.jg@gmail.com def writeCodeFiles(self, path, includes): 1716877Ssteve.reinhardt@amd.com self.printControllerPython(path) 1726657Snate@binkert.org self.printControllerHH(path) 1739219Spower.jg@gmail.com self.printControllerCC(path, includes) 1746657Snate@binkert.org self.printCSwitch(path) 1759219Spower.jg@gmail.com self.printCWakeup(path, includes) 1766657Snate@binkert.org self.printProfilerCC(path) 1776657Snate@binkert.org self.printProfilerHH(path) 1787542SBrad.Beckmann@amd.com self.printProfileDumperCC(path) 1797542SBrad.Beckmann@amd.com self.printProfileDumperHH(path) 1806657Snate@binkert.org 1816877Ssteve.reinhardt@amd.com def printControllerPython(self, path): 1826999Snate@binkert.org code = self.symtab.codeFormatter() 1836877Ssteve.reinhardt@amd.com ident = self.ident 1846877Ssteve.reinhardt@amd.com py_ident = "%s_Controller" % ident 1856877Ssteve.reinhardt@amd.com c_ident = "%s_Controller" % self.ident 1866877Ssteve.reinhardt@amd.com code(''' 1876877Ssteve.reinhardt@amd.comfrom m5.params import * 1886877Ssteve.reinhardt@amd.comfrom m5.SimObject import SimObject 1896877Ssteve.reinhardt@amd.comfrom Controller import RubyController 1906877Ssteve.reinhardt@amd.com 1916877Ssteve.reinhardt@amd.comclass $py_ident(RubyController): 1926877Ssteve.reinhardt@amd.com type = '$py_ident' 1939338SAndreas.Sandberg@arm.com cxx_header = 'mem/protocol/${c_ident}.hh' 1946877Ssteve.reinhardt@amd.com''') 1956877Ssteve.reinhardt@amd.com code.indent() 1966877Ssteve.reinhardt@amd.com for param in self.config_parameters: 1976877Ssteve.reinhardt@amd.com dflt_str = '' 1986877Ssteve.reinhardt@amd.com if param.default is not None: 1996877Ssteve.reinhardt@amd.com dflt_str = str(param.default) + ', ' 2006882SBrad.Beckmann@amd.com if python_class_map.has_key(param.type_ast.type.c_ident): 2016882SBrad.Beckmann@amd.com python_type = python_class_map[param.type_ast.type.c_ident] 2026882SBrad.Beckmann@amd.com code('${{param.name}} = Param.${{python_type}}(${dflt_str}"")') 2036882SBrad.Beckmann@amd.com else: 2046882SBrad.Beckmann@amd.com self.error("Unknown c++ to python class conversion for c++ " \ 2056882SBrad.Beckmann@amd.com "type: '%s'. Please update the python_class_map " \ 2066882SBrad.Beckmann@amd.com "in StateMachine.py", param.type_ast.type.c_ident) 2076877Ssteve.reinhardt@amd.com code.dedent() 2086877Ssteve.reinhardt@amd.com code.write(path, '%s.py' % py_ident) 2096877Ssteve.reinhardt@amd.com 2106877Ssteve.reinhardt@amd.com 2116657Snate@binkert.org def printControllerHH(self, path): 2126657Snate@binkert.org '''Output the method declarations for the class declaration''' 2136999Snate@binkert.org code = self.symtab.codeFormatter() 2146657Snate@binkert.org ident = self.ident 2156657Snate@binkert.org c_ident = "%s_Controller" % self.ident 2166657Snate@binkert.org 2176657Snate@binkert.org self.message_buffer_names = [] 2186657Snate@binkert.org 2196657Snate@binkert.org code(''' 2207007Snate@binkert.org/** \\file $c_ident.hh 2216657Snate@binkert.org * 2226657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 2236657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 2246657Snate@binkert.org */ 2256657Snate@binkert.org 2267007Snate@binkert.org#ifndef __${ident}_CONTROLLER_HH__ 2277007Snate@binkert.org#define __${ident}_CONTROLLER_HH__ 2286657Snate@binkert.org 2297002Snate@binkert.org#include <iostream> 2307002Snate@binkert.org#include <sstream> 2317002Snate@binkert.org#include <string> 2327002Snate@binkert.org 2338229Snate@binkert.org#include "mem/protocol/${ident}_ProfileDumper.hh" 2348229Snate@binkert.org#include "mem/protocol/${ident}_Profiler.hh" 2356657Snate@binkert.org#include "mem/protocol/TransitionResult.hh" 2366657Snate@binkert.org#include "mem/protocol/Types.hh" 2378229Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 2388229Snate@binkert.org#include "mem/ruby/common/Global.hh" 2398229Snate@binkert.org#include "mem/ruby/slicc_interface/AbstractController.hh" 2408229Snate@binkert.org#include "params/$c_ident.hh" 2416657Snate@binkert.org''') 2426657Snate@binkert.org 2436657Snate@binkert.org seen_types = set() 2446657Snate@binkert.org for var in self.objects: 2456793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 2466657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 2476657Snate@binkert.org seen_types.add(var.type.ident) 2486657Snate@binkert.org 2496657Snate@binkert.org # for adding information to the protocol debug trace 2506657Snate@binkert.org code(''' 2517002Snate@binkert.orgextern std::stringstream ${ident}_transitionComment; 2526657Snate@binkert.org 2537007Snate@binkert.orgclass $c_ident : public AbstractController 2547007Snate@binkert.org{ 2559271Snilay@cs.wisc.edu public: 2566877Ssteve.reinhardt@amd.com typedef ${c_ident}Params Params; 2576877Ssteve.reinhardt@amd.com $c_ident(const Params *p); 2586657Snate@binkert.org static int getNumControllers(); 2596877Ssteve.reinhardt@amd.com void init(); 2606657Snate@binkert.org MessageBuffer* getMandatoryQueue() const; 2616657Snate@binkert.org const int & getVersion() const; 2627002Snate@binkert.org const std::string toString() const; 2637002Snate@binkert.org const std::string getName() const; 2647567SBrad.Beckmann@amd.com void stallBuffer(MessageBuffer* buf, Address addr); 2657567SBrad.Beckmann@amd.com void wakeUpBuffers(Address addr); 2667922SBrad.Beckmann@amd.com void wakeUpAllBuffers(); 2676881SBrad.Beckmann@amd.com void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 2687002Snate@binkert.org void print(std::ostream& out) const; 2696657Snate@binkert.org void wakeup(); 2707002Snate@binkert.org void printStats(std::ostream& out) const; 2716902SBrad.Beckmann@amd.com void clearStats(); 2726863Sdrh5@cs.wisc.edu void blockOnQueue(Address addr, MessageBuffer* port); 2736863Sdrh5@cs.wisc.edu void unblock(Address addr); 2748683Snilay@cs.wisc.edu void recordCacheTrace(int cntrl, CacheRecorder* tr); 2758683Snilay@cs.wisc.edu Sequencer* getSequencer() const; 2767007Snate@binkert.org 2779302Snilay@cs.wisc.edu bool functionalReadBuffers(PacketPtr&); 2789302Snilay@cs.wisc.edu uint32_t functionalWriteBuffers(PacketPtr&); 2799302Snilay@cs.wisc.edu 2806657Snate@binkert.orgprivate: 2816657Snate@binkert.org''') 2826657Snate@binkert.org 2836657Snate@binkert.org code.indent() 2846657Snate@binkert.org # added by SS 2856657Snate@binkert.org for param in self.config_parameters: 2866882SBrad.Beckmann@amd.com if param.pointer: 2876882SBrad.Beckmann@amd.com code('${{param.type_ast.type}}* m_${{param.ident}}_ptr;') 2886882SBrad.Beckmann@amd.com else: 2896882SBrad.Beckmann@amd.com code('${{param.type_ast.type}} m_${{param.ident}};') 2906657Snate@binkert.org 2916657Snate@binkert.org code(''' 2927007Snate@binkert.orgTransitionResult doTransition(${ident}_Event event, 2937839Snilay@cs.wisc.edu''') 2947839Snilay@cs.wisc.edu 2957839Snilay@cs.wisc.edu if self.EntryType != None: 2967839Snilay@cs.wisc.edu code(''' 2977839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}* m_cache_entry_ptr, 2987839Snilay@cs.wisc.edu''') 2997839Snilay@cs.wisc.edu if self.TBEType != None: 3007839Snilay@cs.wisc.edu code(''' 3017839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}* m_tbe_ptr, 3027839Snilay@cs.wisc.edu''') 3037839Snilay@cs.wisc.edu 3047839Snilay@cs.wisc.edu code(''' 3057007Snate@binkert.org const Address& addr); 3067007Snate@binkert.org 3077007Snate@binkert.orgTransitionResult doTransitionWorker(${ident}_Event event, 3087007Snate@binkert.org ${ident}_State state, 3097007Snate@binkert.org ${ident}_State& next_state, 3107839Snilay@cs.wisc.edu''') 3117839Snilay@cs.wisc.edu 3127839Snilay@cs.wisc.edu if self.TBEType != None: 3137839Snilay@cs.wisc.edu code(''' 3147839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}*& m_tbe_ptr, 3157839Snilay@cs.wisc.edu''') 3167839Snilay@cs.wisc.edu if self.EntryType != None: 3177839Snilay@cs.wisc.edu code(''' 3187839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, 3197839Snilay@cs.wisc.edu''') 3207839Snilay@cs.wisc.edu 3217839Snilay@cs.wisc.edu code(''' 3227007Snate@binkert.org const Address& addr); 3237007Snate@binkert.org 3247542SBrad.Beckmann@amd.comstatic ${ident}_ProfileDumper s_profileDumper; 3257542SBrad.Beckmann@amd.com${ident}_Profiler m_profiler; 3266657Snate@binkert.orgstatic int m_num_controllers; 3277007Snate@binkert.org 3286657Snate@binkert.org// Internal functions 3296657Snate@binkert.org''') 3306657Snate@binkert.org 3316657Snate@binkert.org for func in self.functions: 3326657Snate@binkert.org proto = func.prototype 3336657Snate@binkert.org if proto: 3346657Snate@binkert.org code('$proto') 3356657Snate@binkert.org 3367839Snilay@cs.wisc.edu if self.EntryType != None: 3377839Snilay@cs.wisc.edu code(''' 3387839Snilay@cs.wisc.edu 3397839Snilay@cs.wisc.edu// Set and Reset for cache_entry variable 3407839Snilay@cs.wisc.eduvoid set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry); 3417839Snilay@cs.wisc.eduvoid unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr); 3427839Snilay@cs.wisc.edu''') 3437839Snilay@cs.wisc.edu 3447839Snilay@cs.wisc.edu if self.TBEType != None: 3457839Snilay@cs.wisc.edu code(''' 3467839Snilay@cs.wisc.edu 3477839Snilay@cs.wisc.edu// Set and Reset for tbe variable 3487839Snilay@cs.wisc.eduvoid set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${ident}_TBE* m_new_tbe); 3497839Snilay@cs.wisc.eduvoid unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr); 3507839Snilay@cs.wisc.edu''') 3517839Snilay@cs.wisc.edu 3526657Snate@binkert.org code(''' 3536657Snate@binkert.org 3546657Snate@binkert.org// Actions 3556657Snate@binkert.org''') 3567839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 3577839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3587839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3597839Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr);') 3607839Snilay@cs.wisc.edu elif self.TBEType != None: 3617839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3627839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3637839Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr);') 3647839Snilay@cs.wisc.edu elif self.EntryType != None: 3657839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3667839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3677839Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr);') 3687839Snilay@cs.wisc.edu else: 3697839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3707839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3717839Snilay@cs.wisc.edu code('void ${{action.ident}}(const Address& addr);') 3726657Snate@binkert.org 3736657Snate@binkert.org # the controller internal variables 3746657Snate@binkert.org code(''' 3756657Snate@binkert.org 3767007Snate@binkert.org// Objects 3776657Snate@binkert.org''') 3786657Snate@binkert.org for var in self.objects: 3799273Snilay@cs.wisc.edu th = var.get("template", "") 3806657Snate@binkert.org code('${{var.type.c_ident}}$th* m_${{var.c_ident}}_ptr;') 3816657Snate@binkert.org 3826657Snate@binkert.org if var.type.ident == "MessageBuffer": 3836657Snate@binkert.org self.message_buffer_names.append("m_%s_ptr" % var.c_ident) 3846657Snate@binkert.org 3856657Snate@binkert.org code.dedent() 3866657Snate@binkert.org code('};') 3877007Snate@binkert.org code('#endif // __${ident}_CONTROLLER_H__') 3886657Snate@binkert.org code.write(path, '%s.hh' % c_ident) 3896657Snate@binkert.org 3909219Spower.jg@gmail.com def printControllerCC(self, path, includes): 3916657Snate@binkert.org '''Output the actions for performing the actions''' 3926657Snate@binkert.org 3936999Snate@binkert.org code = self.symtab.codeFormatter() 3946657Snate@binkert.org ident = self.ident 3956657Snate@binkert.org c_ident = "%s_Controller" % self.ident 3966657Snate@binkert.org 3976657Snate@binkert.org code(''' 3987007Snate@binkert.org/** \\file $c_ident.cc 3996657Snate@binkert.org * 4006657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4016657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 4026657Snate@binkert.org */ 4036657Snate@binkert.org 4048946Sandreas.hansson@arm.com#include <sys/types.h> 4058946Sandreas.hansson@arm.com#include <unistd.h> 4068946Sandreas.hansson@arm.com 4077832Snate@binkert.org#include <cassert> 4087002Snate@binkert.org#include <sstream> 4097002Snate@binkert.org#include <string> 4107002Snate@binkert.org 4118641Snate@binkert.org#include "base/compiler.hh" 4127056Snate@binkert.org#include "base/cprintf.hh" 4138232Snate@binkert.org#include "debug/RubyGenerated.hh" 4148232Snate@binkert.org#include "debug/RubySlicc.hh" 4156657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 4168229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 4176657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 4186657Snate@binkert.org#include "mem/protocol/Types.hh" 4197056Snate@binkert.org#include "mem/ruby/common/Global.hh" 4206657Snate@binkert.org#include "mem/ruby/system/System.hh" 4219219Spower.jg@gmail.com''') 4229219Spower.jg@gmail.com for include_path in includes: 4239219Spower.jg@gmail.com code('#include "${{include_path}}"') 4249219Spower.jg@gmail.com 4259219Spower.jg@gmail.com code(''' 4267002Snate@binkert.org 4277002Snate@binkert.orgusing namespace std; 4286657Snate@binkert.org''') 4296657Snate@binkert.org 4306657Snate@binkert.org # include object classes 4316657Snate@binkert.org seen_types = set() 4326657Snate@binkert.org for var in self.objects: 4336793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 4346657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 4356657Snate@binkert.org seen_types.add(var.type.ident) 4366657Snate@binkert.org 4376657Snate@binkert.org code(''' 4386877Ssteve.reinhardt@amd.com$c_ident * 4396877Ssteve.reinhardt@amd.com${c_ident}Params::create() 4406877Ssteve.reinhardt@amd.com{ 4416877Ssteve.reinhardt@amd.com return new $c_ident(this); 4426877Ssteve.reinhardt@amd.com} 4436877Ssteve.reinhardt@amd.com 4446657Snate@binkert.orgint $c_ident::m_num_controllers = 0; 4457542SBrad.Beckmann@amd.com${ident}_ProfileDumper $c_ident::s_profileDumper; 4466657Snate@binkert.org 4477007Snate@binkert.org// for adding information to the protocol debug trace 4486657Snate@binkert.orgstringstream ${ident}_transitionComment; 4496657Snate@binkert.org#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str) 4507007Snate@binkert.org 4516657Snate@binkert.org/** \\brief constructor */ 4526877Ssteve.reinhardt@amd.com$c_ident::$c_ident(const Params *p) 4536877Ssteve.reinhardt@amd.com : AbstractController(p) 4546657Snate@binkert.org{ 4558532SLisa.Hsu@amd.com m_name = "${ident}"; 4566657Snate@binkert.org''') 4577567SBrad.Beckmann@amd.com # 4587567SBrad.Beckmann@amd.com # max_port_rank is used to size vectors and thus should be one plus the 4597567SBrad.Beckmann@amd.com # largest port rank 4607567SBrad.Beckmann@amd.com # 4617567SBrad.Beckmann@amd.com max_port_rank = self.in_ports[0].pairs["max_port_rank"] + 1 4627567SBrad.Beckmann@amd.com code(' m_max_in_port_rank = $max_port_rank;') 4636657Snate@binkert.org code.indent() 4646882SBrad.Beckmann@amd.com 4656882SBrad.Beckmann@amd.com # 4666882SBrad.Beckmann@amd.com # After initializing the universal machine parameters, initialize the 4676882SBrad.Beckmann@amd.com # this machines config parameters. Also detemine if these configuration 4686882SBrad.Beckmann@amd.com # params include a sequencer. This information will be used later for 4696882SBrad.Beckmann@amd.com # contecting the sequencer back to the L1 cache controller. 4706882SBrad.Beckmann@amd.com # 4718189SLisa.Hsu@amd.com contains_dma_sequencer = False 4728189SLisa.Hsu@amd.com sequencers = [] 4736877Ssteve.reinhardt@amd.com for param in self.config_parameters: 4748189SLisa.Hsu@amd.com if param.name == "dma_sequencer": 4758189SLisa.Hsu@amd.com contains_dma_sequencer = True 4768189SLisa.Hsu@amd.com elif re.compile("sequencer").search(param.name): 4778189SLisa.Hsu@amd.com sequencers.append(param.name) 4786882SBrad.Beckmann@amd.com if param.pointer: 4796882SBrad.Beckmann@amd.com code('m_${{param.name}}_ptr = p->${{param.name}};') 4806882SBrad.Beckmann@amd.com else: 4816882SBrad.Beckmann@amd.com code('m_${{param.name}} = p->${{param.name}};') 4826882SBrad.Beckmann@amd.com 4836882SBrad.Beckmann@amd.com # 4846882SBrad.Beckmann@amd.com # For the l1 cache controller, add the special atomic support which 4856882SBrad.Beckmann@amd.com # includes passing the sequencer a pointer to the controller. 4866882SBrad.Beckmann@amd.com # 4876882SBrad.Beckmann@amd.com if self.ident == "L1Cache": 4888189SLisa.Hsu@amd.com if not sequencers: 4896882SBrad.Beckmann@amd.com self.error("The L1Cache controller must include the sequencer " \ 4906882SBrad.Beckmann@amd.com "configuration parameter") 4916882SBrad.Beckmann@amd.com 4928189SLisa.Hsu@amd.com for seq in sequencers: 4938189SLisa.Hsu@amd.com code(''' 4948189SLisa.Hsu@amd.comm_${{seq}}_ptr->setController(this); 4958189SLisa.Hsu@amd.com ''') 4968938SLisa.Hsu@amd.com 4978938SLisa.Hsu@amd.com else: 4988938SLisa.Hsu@amd.com for seq in sequencers: 4998938SLisa.Hsu@amd.com code(''' 5008938SLisa.Hsu@amd.comm_${{seq}}_ptr->setController(this); 5018938SLisa.Hsu@amd.com ''') 5028938SLisa.Hsu@amd.com 5036888SBrad.Beckmann@amd.com # 5046888SBrad.Beckmann@amd.com # For the DMA controller, pass the sequencer a pointer to the 5056888SBrad.Beckmann@amd.com # controller. 5066888SBrad.Beckmann@amd.com # 5076888SBrad.Beckmann@amd.com if self.ident == "DMA": 5088189SLisa.Hsu@amd.com if not contains_dma_sequencer: 5096888SBrad.Beckmann@amd.com self.error("The DMA controller must include the sequencer " \ 5106888SBrad.Beckmann@amd.com "configuration parameter") 5116657Snate@binkert.org 5126888SBrad.Beckmann@amd.com code(''' 5136888SBrad.Beckmann@amd.comm_dma_sequencer_ptr->setController(this); 5146888SBrad.Beckmann@amd.com''') 5156888SBrad.Beckmann@amd.com 5166657Snate@binkert.org code('m_num_controllers++;') 5176657Snate@binkert.org for var in self.objects: 5186657Snate@binkert.org if var.ident.find("mandatoryQueue") >= 0: 5196657Snate@binkert.org code('m_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}();') 5206657Snate@binkert.org 5216657Snate@binkert.org code.dedent() 5226657Snate@binkert.org code(''' 5236657Snate@binkert.org} 5246657Snate@binkert.org 5257007Snate@binkert.orgvoid 5267007Snate@binkert.org$c_ident::init() 5276657Snate@binkert.org{ 5287007Snate@binkert.org MachineType machine_type; 5297007Snate@binkert.org int base; 5309465Snilay@cs.wisc.edu machine_type = string_to_MachineType("${{var.machine.ident}}"); 5319465Snilay@cs.wisc.edu base = MachineType_base_number(machine_type); 5327007Snate@binkert.org 5336657Snate@binkert.org m_machineID.type = MachineType_${ident}; 5346657Snate@binkert.org m_machineID.num = m_version; 5356657Snate@binkert.org 5367007Snate@binkert.org // initialize objects 5377542SBrad.Beckmann@amd.com m_profiler.setVersion(m_version); 5387542SBrad.Beckmann@amd.com s_profileDumper.registerProfiler(&m_profiler); 5397007Snate@binkert.org 5406657Snate@binkert.org''') 5416657Snate@binkert.org 5426657Snate@binkert.org code.indent() 5436657Snate@binkert.org for var in self.objects: 5446657Snate@binkert.org vtype = var.type 5456657Snate@binkert.org vid = "m_%s_ptr" % var.c_ident 5466657Snate@binkert.org if "network" not in var: 5476657Snate@binkert.org # Not a network port object 5486657Snate@binkert.org if "primitive" in vtype: 5496657Snate@binkert.org code('$vid = new ${{vtype.c_ident}};') 5506657Snate@binkert.org if "default" in var: 5516657Snate@binkert.org code('(*$vid) = ${{var["default"]}};') 5526657Snate@binkert.org else: 5536657Snate@binkert.org # Normal Object 5546657Snate@binkert.org # added by SS 5556657Snate@binkert.org if "factory" in var: 5566657Snate@binkert.org code('$vid = ${{var["factory"]}};') 5576657Snate@binkert.org elif var.ident.find("mandatoryQueue") < 0: 5589273Snilay@cs.wisc.edu th = var.get("template", "") 5596657Snate@binkert.org expr = "%s = new %s%s" % (vid, vtype.c_ident, th) 5606657Snate@binkert.org args = "" 5616657Snate@binkert.org if "non_obj" not in vtype and not vtype.isEnumeration: 5629364Snilay@cs.wisc.edu args = var.get("constructor", "") 5637007Snate@binkert.org code('$expr($args);') 5646657Snate@binkert.org 5656657Snate@binkert.org code('assert($vid != NULL);') 5666657Snate@binkert.org 5676657Snate@binkert.org if "default" in var: 5687007Snate@binkert.org code('*$vid = ${{var["default"]}}; // Object default') 5696657Snate@binkert.org elif "default" in vtype: 5707007Snate@binkert.org comment = "Type %s default" % vtype.ident 5717007Snate@binkert.org code('*$vid = ${{vtype["default"]}}; // $comment') 5726657Snate@binkert.org 5736657Snate@binkert.org # Set ordering 5746657Snate@binkert.org if "ordered" in var and "trigger_queue" not in var: 5756657Snate@binkert.org # A buffer 5766657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 5776657Snate@binkert.org 5786657Snate@binkert.org # Set randomization 5796657Snate@binkert.org if "random" in var: 5806657Snate@binkert.org # A buffer 5816657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}});') 5826657Snate@binkert.org 5836657Snate@binkert.org # Set Priority 5846657Snate@binkert.org if vtype.isBuffer and \ 5856657Snate@binkert.org "rank" in var and "trigger_queue" not in var: 5866657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}});') 5877566SBrad.Beckmann@amd.com 5886657Snate@binkert.org else: 5896657Snate@binkert.org # Network port object 5906657Snate@binkert.org network = var["network"] 5916657Snate@binkert.org ordered = var["ordered"] 5926657Snate@binkert.org vnet = var["virtual_network"] 5938308Stushar@csail.mit.edu vnet_type = var["vnet_type"] 5946657Snate@binkert.org 5956657Snate@binkert.org assert var.machine is not None 5966657Snate@binkert.org code(''' 5978308Stushar@csail.mit.edu$vid = m_net_ptr->get${network}NetQueue(m_version + base, $ordered, $vnet, "$vnet_type"); 5986657Snate@binkert.org''') 5996657Snate@binkert.org 6006657Snate@binkert.org code('assert($vid != NULL);') 6016657Snate@binkert.org 6026657Snate@binkert.org # Set ordering 6036657Snate@binkert.org if "ordered" in var: 6046657Snate@binkert.org # A buffer 6056657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 6066657Snate@binkert.org 6076657Snate@binkert.org # Set randomization 6086657Snate@binkert.org if "random" in var: 6096657Snate@binkert.org # A buffer 6108187SLisa.Hsu@amd.com code('$vid->setRandomization(${{var["random"]}});') 6116657Snate@binkert.org 6126657Snate@binkert.org # Set Priority 6136657Snate@binkert.org if "rank" in var: 6146657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}})') 6156657Snate@binkert.org 6166657Snate@binkert.org # Set buffer size 6176657Snate@binkert.org if vtype.isBuffer: 6186657Snate@binkert.org code(''' 6196657Snate@binkert.orgif (m_buffer_size > 0) { 6207454Snate@binkert.org $vid->resize(m_buffer_size); 6216657Snate@binkert.org} 6226657Snate@binkert.org''') 6236657Snate@binkert.org 6246657Snate@binkert.org # set description (may be overriden later by port def) 6257007Snate@binkert.org code(''' 6267056Snate@binkert.org$vid->setDescription("[Version " + to_string(m_version) + ", ${ident}, name=${{var.c_ident}}]"); 6277007Snate@binkert.org 6287007Snate@binkert.org''') 6296657Snate@binkert.org 6307566SBrad.Beckmann@amd.com if vtype.isBuffer: 6317566SBrad.Beckmann@amd.com if "recycle_latency" in var: 6327566SBrad.Beckmann@amd.com code('$vid->setRecycleLatency(${{var["recycle_latency"]}});') 6337566SBrad.Beckmann@amd.com else: 6347566SBrad.Beckmann@amd.com code('$vid->setRecycleLatency(m_recycle_latency);') 6357566SBrad.Beckmann@amd.com 6369366Snilay@cs.wisc.edu # Set the prefetchers 6379366Snilay@cs.wisc.edu code() 6389366Snilay@cs.wisc.edu for prefetcher in self.prefetchers: 6399366Snilay@cs.wisc.edu code('${{prefetcher.code}}.setController(this);') 6407566SBrad.Beckmann@amd.com 6417672Snate@binkert.org code() 6426657Snate@binkert.org for port in self.in_ports: 6439465Snilay@cs.wisc.edu # Set the queue consumers 6446657Snate@binkert.org code('${{port.code}}.setConsumer(this);') 6459465Snilay@cs.wisc.edu # Set the queue descriptions 6467056Snate@binkert.org code('${{port.code}}.setDescription("[Version " + to_string(m_version) + ", $ident, $port]");') 6479465Snilay@cs.wisc.edu # Set the clock object 6489465Snilay@cs.wisc.edu code('${{port.code}}.setClockObj(this);') 6496657Snate@binkert.org 6506657Snate@binkert.org # Initialize the transition profiling 6517672Snate@binkert.org code() 6526657Snate@binkert.org for trans in self.transitions: 6536657Snate@binkert.org # Figure out if we stall 6546657Snate@binkert.org stall = False 6556657Snate@binkert.org for action in trans.actions: 6566657Snate@binkert.org if action.ident == "z_stall": 6576657Snate@binkert.org stall = True 6586657Snate@binkert.org 6596657Snate@binkert.org # Only possible if it is not a 'z' case 6606657Snate@binkert.org if not stall: 6616657Snate@binkert.org state = "%s_State_%s" % (self.ident, trans.state.ident) 6626657Snate@binkert.org event = "%s_Event_%s" % (self.ident, trans.event.ident) 6637542SBrad.Beckmann@amd.com code('m_profiler.possibleTransition($state, $event);') 6646657Snate@binkert.org 6656657Snate@binkert.org code.dedent() 6669496Snilay@cs.wisc.edu code(''' 6679496Snilay@cs.wisc.edu AbstractController::init(); 6689496Snilay@cs.wisc.edu clearStats(); 6699496Snilay@cs.wisc.edu} 6709496Snilay@cs.wisc.edu''') 6716657Snate@binkert.org 6726657Snate@binkert.org has_mandatory_q = False 6736657Snate@binkert.org for port in self.in_ports: 6746657Snate@binkert.org if port.code.find("mandatoryQueue_ptr") >= 0: 6756657Snate@binkert.org has_mandatory_q = True 6766657Snate@binkert.org 6776657Snate@binkert.org if has_mandatory_q: 6786657Snate@binkert.org mq_ident = "m_%s_mandatoryQueue_ptr" % self.ident 6796657Snate@binkert.org else: 6806657Snate@binkert.org mq_ident = "NULL" 6816657Snate@binkert.org 6828683Snilay@cs.wisc.edu seq_ident = "NULL" 6838683Snilay@cs.wisc.edu for param in self.config_parameters: 6848683Snilay@cs.wisc.edu if param.name == "sequencer": 6858683Snilay@cs.wisc.edu assert(param.pointer) 6868683Snilay@cs.wisc.edu seq_ident = "m_%s_ptr" % param.name 6878683Snilay@cs.wisc.edu 6886657Snate@binkert.org code(''' 6897007Snate@binkert.orgint 6907007Snate@binkert.org$c_ident::getNumControllers() 6917007Snate@binkert.org{ 6926657Snate@binkert.org return m_num_controllers; 6936657Snate@binkert.org} 6946657Snate@binkert.org 6957007Snate@binkert.orgMessageBuffer* 6967007Snate@binkert.org$c_ident::getMandatoryQueue() const 6977007Snate@binkert.org{ 6986657Snate@binkert.org return $mq_ident; 6996657Snate@binkert.org} 7006657Snate@binkert.org 7018683Snilay@cs.wisc.eduSequencer* 7028683Snilay@cs.wisc.edu$c_ident::getSequencer() const 7038683Snilay@cs.wisc.edu{ 7048683Snilay@cs.wisc.edu return $seq_ident; 7058683Snilay@cs.wisc.edu} 7068683Snilay@cs.wisc.edu 7077007Snate@binkert.orgconst int & 7087007Snate@binkert.org$c_ident::getVersion() const 7097007Snate@binkert.org{ 7106657Snate@binkert.org return m_version; 7116657Snate@binkert.org} 7126657Snate@binkert.org 7137007Snate@binkert.orgconst string 7147007Snate@binkert.org$c_ident::toString() const 7157007Snate@binkert.org{ 7166657Snate@binkert.org return "$c_ident"; 7176657Snate@binkert.org} 7186657Snate@binkert.org 7197007Snate@binkert.orgconst string 7207007Snate@binkert.org$c_ident::getName() const 7217007Snate@binkert.org{ 7226657Snate@binkert.org return m_name; 7236657Snate@binkert.org} 7247007Snate@binkert.org 7257007Snate@binkert.orgvoid 7267567SBrad.Beckmann@amd.com$c_ident::stallBuffer(MessageBuffer* buf, Address addr) 7277567SBrad.Beckmann@amd.com{ 7287567SBrad.Beckmann@amd.com if (m_waiting_buffers.count(addr) == 0) { 7297567SBrad.Beckmann@amd.com MsgVecType* msgVec = new MsgVecType; 7307567SBrad.Beckmann@amd.com msgVec->resize(m_max_in_port_rank, NULL); 7317567SBrad.Beckmann@amd.com m_waiting_buffers[addr] = msgVec; 7327567SBrad.Beckmann@amd.com } 7337567SBrad.Beckmann@amd.com (*(m_waiting_buffers[addr]))[m_cur_in_port_rank] = buf; 7347567SBrad.Beckmann@amd.com} 7357567SBrad.Beckmann@amd.com 7367567SBrad.Beckmann@amd.comvoid 7377567SBrad.Beckmann@amd.com$c_ident::wakeUpBuffers(Address addr) 7387567SBrad.Beckmann@amd.com{ 7398155Snilay@cs.wisc.edu if (m_waiting_buffers.count(addr) > 0) { 7408155Snilay@cs.wisc.edu // 7418155Snilay@cs.wisc.edu // Wake up all possible lower rank (i.e. lower priority) buffers that could 7428155Snilay@cs.wisc.edu // be waiting on this message. 7438155Snilay@cs.wisc.edu // 7448155Snilay@cs.wisc.edu for (int in_port_rank = m_cur_in_port_rank - 1; 7458155Snilay@cs.wisc.edu in_port_rank >= 0; 7468155Snilay@cs.wisc.edu in_port_rank--) { 7478155Snilay@cs.wisc.edu if ((*(m_waiting_buffers[addr]))[in_port_rank] != NULL) { 7488155Snilay@cs.wisc.edu (*(m_waiting_buffers[addr]))[in_port_rank]->reanalyzeMessages(addr); 7498155Snilay@cs.wisc.edu } 7507567SBrad.Beckmann@amd.com } 7518155Snilay@cs.wisc.edu delete m_waiting_buffers[addr]; 7528155Snilay@cs.wisc.edu m_waiting_buffers.erase(addr); 7537567SBrad.Beckmann@amd.com } 7547567SBrad.Beckmann@amd.com} 7557567SBrad.Beckmann@amd.com 7567567SBrad.Beckmann@amd.comvoid 7577922SBrad.Beckmann@amd.com$c_ident::wakeUpAllBuffers() 7587922SBrad.Beckmann@amd.com{ 7597922SBrad.Beckmann@amd.com // 7607922SBrad.Beckmann@amd.com // Wake up all possible buffers that could be waiting on any message. 7617922SBrad.Beckmann@amd.com // 7627922SBrad.Beckmann@amd.com 7637922SBrad.Beckmann@amd.com std::vector<MsgVecType*> wokeUpMsgVecs; 7647922SBrad.Beckmann@amd.com 7658154Snilay@cs.wisc.edu if(m_waiting_buffers.size() > 0) { 7668154Snilay@cs.wisc.edu for (WaitingBufType::iterator buf_iter = m_waiting_buffers.begin(); 7678154Snilay@cs.wisc.edu buf_iter != m_waiting_buffers.end(); 7688154Snilay@cs.wisc.edu ++buf_iter) { 7698154Snilay@cs.wisc.edu for (MsgVecType::iterator vec_iter = buf_iter->second->begin(); 7708154Snilay@cs.wisc.edu vec_iter != buf_iter->second->end(); 7718154Snilay@cs.wisc.edu ++vec_iter) { 7728154Snilay@cs.wisc.edu if (*vec_iter != NULL) { 7738154Snilay@cs.wisc.edu (*vec_iter)->reanalyzeAllMessages(); 7748154Snilay@cs.wisc.edu } 7758154Snilay@cs.wisc.edu } 7768154Snilay@cs.wisc.edu wokeUpMsgVecs.push_back(buf_iter->second); 7778154Snilay@cs.wisc.edu } 7788154Snilay@cs.wisc.edu 7798154Snilay@cs.wisc.edu for (std::vector<MsgVecType*>::iterator wb_iter = wokeUpMsgVecs.begin(); 7808154Snilay@cs.wisc.edu wb_iter != wokeUpMsgVecs.end(); 7818154Snilay@cs.wisc.edu ++wb_iter) { 7828154Snilay@cs.wisc.edu delete (*wb_iter); 7838154Snilay@cs.wisc.edu } 7848154Snilay@cs.wisc.edu 7858154Snilay@cs.wisc.edu m_waiting_buffers.clear(); 7867922SBrad.Beckmann@amd.com } 7877922SBrad.Beckmann@amd.com} 7887922SBrad.Beckmann@amd.com 7897922SBrad.Beckmann@amd.comvoid 7907007Snate@binkert.org$c_ident::blockOnQueue(Address addr, MessageBuffer* port) 7917007Snate@binkert.org{ 7926863Sdrh5@cs.wisc.edu m_is_blocking = true; 7936863Sdrh5@cs.wisc.edu m_block_map[addr] = port; 7946863Sdrh5@cs.wisc.edu} 7957007Snate@binkert.org 7967007Snate@binkert.orgvoid 7977007Snate@binkert.org$c_ident::unblock(Address addr) 7987007Snate@binkert.org{ 7996863Sdrh5@cs.wisc.edu m_block_map.erase(addr); 8006863Sdrh5@cs.wisc.edu if (m_block_map.size() == 0) { 8016863Sdrh5@cs.wisc.edu m_is_blocking = false; 8026863Sdrh5@cs.wisc.edu } 8036863Sdrh5@cs.wisc.edu} 8046863Sdrh5@cs.wisc.edu 8057007Snate@binkert.orgvoid 8067007Snate@binkert.org$c_ident::print(ostream& out) const 8077007Snate@binkert.org{ 8087007Snate@binkert.org out << "[$c_ident " << m_version << "]"; 8097007Snate@binkert.org} 8106657Snate@binkert.org 8117007Snate@binkert.orgvoid 8127007Snate@binkert.org$c_ident::printStats(ostream& out) const 8137007Snate@binkert.org{ 8146902SBrad.Beckmann@amd.com''') 8156902SBrad.Beckmann@amd.com # 8166902SBrad.Beckmann@amd.com # Cache and Memory Controllers have specific profilers associated with 8176902SBrad.Beckmann@amd.com # them. Print out these stats before dumping state transition stats. 8186902SBrad.Beckmann@amd.com # 8196902SBrad.Beckmann@amd.com for param in self.config_parameters: 8206902SBrad.Beckmann@amd.com if param.type_ast.type.ident == "CacheMemory" or \ 8217025SBrad.Beckmann@amd.com param.type_ast.type.ident == "DirectoryMemory" or \ 8226902SBrad.Beckmann@amd.com param.type_ast.type.ident == "MemoryControl": 8236902SBrad.Beckmann@amd.com assert(param.pointer) 8246902SBrad.Beckmann@amd.com code(' m_${{param.ident}}_ptr->printStats(out);') 8256902SBrad.Beckmann@amd.com 8266902SBrad.Beckmann@amd.com code(''' 8277542SBrad.Beckmann@amd.com if (m_version == 0) { 8287542SBrad.Beckmann@amd.com s_profileDumper.dumpStats(out); 8297542SBrad.Beckmann@amd.com } 8306902SBrad.Beckmann@amd.com} 8316902SBrad.Beckmann@amd.com 8326902SBrad.Beckmann@amd.comvoid $c_ident::clearStats() { 8336902SBrad.Beckmann@amd.com''') 8346902SBrad.Beckmann@amd.com # 8356902SBrad.Beckmann@amd.com # Cache and Memory Controllers have specific profilers associated with 8366902SBrad.Beckmann@amd.com # them. These stats must be cleared too. 8376902SBrad.Beckmann@amd.com # 8386902SBrad.Beckmann@amd.com for param in self.config_parameters: 8396902SBrad.Beckmann@amd.com if param.type_ast.type.ident == "CacheMemory" or \ 8406902SBrad.Beckmann@amd.com param.type_ast.type.ident == "MemoryControl": 8416902SBrad.Beckmann@amd.com assert(param.pointer) 8426902SBrad.Beckmann@amd.com code(' m_${{param.ident}}_ptr->clearStats();') 8436902SBrad.Beckmann@amd.com 8446902SBrad.Beckmann@amd.com code(''' 8457542SBrad.Beckmann@amd.com m_profiler.clearStats(); 8469496Snilay@cs.wisc.edu AbstractController::clearStats(); 8476902SBrad.Beckmann@amd.com} 8487839Snilay@cs.wisc.edu''') 8497839Snilay@cs.wisc.edu 8507839Snilay@cs.wisc.edu if self.EntryType != None: 8517839Snilay@cs.wisc.edu code(''' 8527839Snilay@cs.wisc.edu 8537839Snilay@cs.wisc.edu// Set and Reset for cache_entry variable 8547839Snilay@cs.wisc.eduvoid 8557839Snilay@cs.wisc.edu$c_ident::set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry) 8567839Snilay@cs.wisc.edu{ 8577839Snilay@cs.wisc.edu m_cache_entry_ptr = (${{self.EntryType.c_ident}}*)m_new_cache_entry; 8587839Snilay@cs.wisc.edu} 8597839Snilay@cs.wisc.edu 8607839Snilay@cs.wisc.eduvoid 8617839Snilay@cs.wisc.edu$c_ident::unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr) 8627839Snilay@cs.wisc.edu{ 8637839Snilay@cs.wisc.edu m_cache_entry_ptr = 0; 8647839Snilay@cs.wisc.edu} 8657839Snilay@cs.wisc.edu''') 8667839Snilay@cs.wisc.edu 8677839Snilay@cs.wisc.edu if self.TBEType != None: 8687839Snilay@cs.wisc.edu code(''' 8697839Snilay@cs.wisc.edu 8707839Snilay@cs.wisc.edu// Set and Reset for tbe variable 8717839Snilay@cs.wisc.eduvoid 8727839Snilay@cs.wisc.edu$c_ident::set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.TBEType.c_ident}}* m_new_tbe) 8737839Snilay@cs.wisc.edu{ 8747839Snilay@cs.wisc.edu m_tbe_ptr = m_new_tbe; 8757839Snilay@cs.wisc.edu} 8767839Snilay@cs.wisc.edu 8777839Snilay@cs.wisc.eduvoid 8787839Snilay@cs.wisc.edu$c_ident::unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr) 8797839Snilay@cs.wisc.edu{ 8807839Snilay@cs.wisc.edu m_tbe_ptr = NULL; 8817839Snilay@cs.wisc.edu} 8827839Snilay@cs.wisc.edu''') 8837839Snilay@cs.wisc.edu 8847839Snilay@cs.wisc.edu code(''' 8856902SBrad.Beckmann@amd.com 8868683Snilay@cs.wisc.eduvoid 8878683Snilay@cs.wisc.edu$c_ident::recordCacheTrace(int cntrl, CacheRecorder* tr) 8888683Snilay@cs.wisc.edu{ 8898683Snilay@cs.wisc.edu''') 8908683Snilay@cs.wisc.edu # 8918683Snilay@cs.wisc.edu # Record cache contents for all associated caches. 8928683Snilay@cs.wisc.edu # 8938683Snilay@cs.wisc.edu code.indent() 8948683Snilay@cs.wisc.edu for param in self.config_parameters: 8958683Snilay@cs.wisc.edu if param.type_ast.type.ident == "CacheMemory": 8968683Snilay@cs.wisc.edu assert(param.pointer) 8978683Snilay@cs.wisc.edu code('m_${{param.ident}}_ptr->recordCacheContents(cntrl, tr);') 8988683Snilay@cs.wisc.edu 8998683Snilay@cs.wisc.edu code.dedent() 9008683Snilay@cs.wisc.edu code(''' 9018683Snilay@cs.wisc.edu} 9028683Snilay@cs.wisc.edu 9036657Snate@binkert.org// Actions 9046657Snate@binkert.org''') 9057839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 9067839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9077839Snilay@cs.wisc.edu if "c_code" not in action: 9087839Snilay@cs.wisc.edu continue 9096657Snate@binkert.org 9107839Snilay@cs.wisc.edu code(''' 9117839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9127839Snilay@cs.wisc.eduvoid 9137839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr) 9147839Snilay@cs.wisc.edu{ 9158055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9167839Snilay@cs.wisc.edu ${{action["c_code"]}} 9177839Snilay@cs.wisc.edu} 9186657Snate@binkert.org 9197839Snilay@cs.wisc.edu''') 9207839Snilay@cs.wisc.edu elif self.TBEType != None: 9217839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9227839Snilay@cs.wisc.edu if "c_code" not in action: 9237839Snilay@cs.wisc.edu continue 9247839Snilay@cs.wisc.edu 9257839Snilay@cs.wisc.edu code(''' 9267839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9277839Snilay@cs.wisc.eduvoid 9287839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr) 9297839Snilay@cs.wisc.edu{ 9308055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9317839Snilay@cs.wisc.edu ${{action["c_code"]}} 9327839Snilay@cs.wisc.edu} 9337839Snilay@cs.wisc.edu 9347839Snilay@cs.wisc.edu''') 9357839Snilay@cs.wisc.edu elif self.EntryType != None: 9367839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9377839Snilay@cs.wisc.edu if "c_code" not in action: 9387839Snilay@cs.wisc.edu continue 9397839Snilay@cs.wisc.edu 9407839Snilay@cs.wisc.edu code(''' 9417839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9427839Snilay@cs.wisc.eduvoid 9437839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr) 9447839Snilay@cs.wisc.edu{ 9458055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9467839Snilay@cs.wisc.edu ${{action["c_code"]}} 9477839Snilay@cs.wisc.edu} 9487839Snilay@cs.wisc.edu 9497839Snilay@cs.wisc.edu''') 9507839Snilay@cs.wisc.edu else: 9517839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9527839Snilay@cs.wisc.edu if "c_code" not in action: 9537839Snilay@cs.wisc.edu continue 9547839Snilay@cs.wisc.edu 9557839Snilay@cs.wisc.edu code(''' 9566657Snate@binkert.org/** \\brief ${{action.desc}} */ 9577007Snate@binkert.orgvoid 9587007Snate@binkert.org$c_ident::${{action.ident}}(const Address& addr) 9596657Snate@binkert.org{ 9608055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9616657Snate@binkert.org ${{action["c_code"]}} 9626657Snate@binkert.org} 9636657Snate@binkert.org 9646657Snate@binkert.org''') 9658478Snilay@cs.wisc.edu for func in self.functions: 9668478Snilay@cs.wisc.edu code(func.generateCode()) 9678478Snilay@cs.wisc.edu 9689302Snilay@cs.wisc.edu # Function for functional reads from messages buffered in the controller 9699302Snilay@cs.wisc.edu code(''' 9709302Snilay@cs.wisc.edubool 9719302Snilay@cs.wisc.edu$c_ident::functionalReadBuffers(PacketPtr& pkt) 9729302Snilay@cs.wisc.edu{ 9739302Snilay@cs.wisc.edu''') 9749302Snilay@cs.wisc.edu for var in self.objects: 9759302Snilay@cs.wisc.edu vtype = var.type 9769302Snilay@cs.wisc.edu if vtype.isBuffer: 9779302Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.c_ident 9789302Snilay@cs.wisc.edu code('if ($vid->functionalRead(pkt)) { return true; }') 9799302Snilay@cs.wisc.edu code(''' 9809302Snilay@cs.wisc.edu return false; 9819302Snilay@cs.wisc.edu} 9829302Snilay@cs.wisc.edu''') 9839302Snilay@cs.wisc.edu 9849302Snilay@cs.wisc.edu # Function for functional writes to messages buffered in the controller 9859302Snilay@cs.wisc.edu code(''' 9869302Snilay@cs.wisc.eduuint32_t 9879302Snilay@cs.wisc.edu$c_ident::functionalWriteBuffers(PacketPtr& pkt) 9889302Snilay@cs.wisc.edu{ 9899302Snilay@cs.wisc.edu uint32_t num_functional_writes = 0; 9909302Snilay@cs.wisc.edu''') 9919302Snilay@cs.wisc.edu for var in self.objects: 9929302Snilay@cs.wisc.edu vtype = var.type 9939302Snilay@cs.wisc.edu if vtype.isBuffer: 9949302Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.c_ident 9959302Snilay@cs.wisc.edu code('num_functional_writes += $vid->functionalWrite(pkt);') 9969302Snilay@cs.wisc.edu code(''' 9979302Snilay@cs.wisc.edu return num_functional_writes; 9989302Snilay@cs.wisc.edu} 9999302Snilay@cs.wisc.edu''') 10009302Snilay@cs.wisc.edu 10016657Snate@binkert.org code.write(path, "%s.cc" % c_ident) 10026657Snate@binkert.org 10039219Spower.jg@gmail.com def printCWakeup(self, path, includes): 10046657Snate@binkert.org '''Output the wakeup loop for the events''' 10056657Snate@binkert.org 10066999Snate@binkert.org code = self.symtab.codeFormatter() 10076657Snate@binkert.org ident = self.ident 10086657Snate@binkert.org 10099104Shestness@cs.utexas.edu outputRequest_types = True 10109104Shestness@cs.utexas.edu if len(self.request_types) == 0: 10119104Shestness@cs.utexas.edu outputRequest_types = False 10129104Shestness@cs.utexas.edu 10136657Snate@binkert.org code(''' 10146657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 10156657Snate@binkert.org// ${ident}: ${{self.short}} 10166657Snate@binkert.org 10178946Sandreas.hansson@arm.com#include <sys/types.h> 10188946Sandreas.hansson@arm.com#include <unistd.h> 10198946Sandreas.hansson@arm.com 10207832Snate@binkert.org#include <cassert> 10217832Snate@binkert.org 10227007Snate@binkert.org#include "base/misc.hh" 10238232Snate@binkert.org#include "debug/RubySlicc.hh" 10248229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 10258229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 10268229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 10279104Shestness@cs.utexas.edu''') 10289104Shestness@cs.utexas.edu 10299104Shestness@cs.utexas.edu if outputRequest_types: 10309104Shestness@cs.utexas.edu code('''#include "mem/protocol/${ident}_RequestType.hh"''') 10319104Shestness@cs.utexas.edu 10329104Shestness@cs.utexas.edu code(''' 10338229Snate@binkert.org#include "mem/protocol/Types.hh" 10346657Snate@binkert.org#include "mem/ruby/common/Global.hh" 10356657Snate@binkert.org#include "mem/ruby/system/System.hh" 10369219Spower.jg@gmail.com''') 10379219Spower.jg@gmail.com 10389219Spower.jg@gmail.com 10399219Spower.jg@gmail.com for include_path in includes: 10409219Spower.jg@gmail.com code('#include "${{include_path}}"') 10419219Spower.jg@gmail.com 10429219Spower.jg@gmail.com code(''' 10436657Snate@binkert.org 10447055Snate@binkert.orgusing namespace std; 10457055Snate@binkert.org 10467007Snate@binkert.orgvoid 10477007Snate@binkert.org${ident}_Controller::wakeup() 10486657Snate@binkert.org{ 10496657Snate@binkert.org int counter = 0; 10506657Snate@binkert.org while (true) { 10516657Snate@binkert.org // Some cases will put us into an infinite loop without this limit 10526657Snate@binkert.org assert(counter <= m_transitions_per_cycle); 10536657Snate@binkert.org if (counter == m_transitions_per_cycle) { 10547007Snate@binkert.org // Count how often we are fully utilized 10559496Snilay@cs.wisc.edu m_fully_busy_cycles++; 10567007Snate@binkert.org 10577007Snate@binkert.org // Wakeup in another cycle and try again 10589230Snilay@cs.wisc.edu scheduleEvent(1); 10596657Snate@binkert.org break; 10606657Snate@binkert.org } 10616657Snate@binkert.org''') 10626657Snate@binkert.org 10636657Snate@binkert.org code.indent() 10646657Snate@binkert.org code.indent() 10656657Snate@binkert.org 10666657Snate@binkert.org # InPorts 10676657Snate@binkert.org # 10686657Snate@binkert.org for port in self.in_ports: 10696657Snate@binkert.org code.indent() 10706657Snate@binkert.org code('// ${ident}InPort $port') 10717567SBrad.Beckmann@amd.com if port.pairs.has_key("rank"): 10727567SBrad.Beckmann@amd.com code('m_cur_in_port_rank = ${{port.pairs["rank"]}};') 10737567SBrad.Beckmann@amd.com else: 10747567SBrad.Beckmann@amd.com code('m_cur_in_port_rank = 0;') 10756657Snate@binkert.org code('${{port["c_code_in_port"]}}') 10766657Snate@binkert.org code.dedent() 10776657Snate@binkert.org 10786657Snate@binkert.org code('') 10796657Snate@binkert.org 10806657Snate@binkert.org code.dedent() 10816657Snate@binkert.org code.dedent() 10826657Snate@binkert.org code(''' 10836657Snate@binkert.org break; // If we got this far, we have nothing left todo 10846657Snate@binkert.org } 10856657Snate@binkert.org} 10866657Snate@binkert.org''') 10876657Snate@binkert.org 10886657Snate@binkert.org code.write(path, "%s_Wakeup.cc" % self.ident) 10896657Snate@binkert.org 10906657Snate@binkert.org def printCSwitch(self, path): 10916657Snate@binkert.org '''Output switch statement for transition table''' 10926657Snate@binkert.org 10936999Snate@binkert.org code = self.symtab.codeFormatter() 10946657Snate@binkert.org ident = self.ident 10956657Snate@binkert.org 10966657Snate@binkert.org code(''' 10976657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 10986657Snate@binkert.org// ${ident}: ${{self.short}} 10996657Snate@binkert.org 11007832Snate@binkert.org#include <cassert> 11017832Snate@binkert.org 11027805Snilay@cs.wisc.edu#include "base/misc.hh" 11037832Snate@binkert.org#include "base/trace.hh" 11048232Snate@binkert.org#include "debug/ProtocolTrace.hh" 11058232Snate@binkert.org#include "debug/RubyGenerated.hh" 11068229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 11078229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 11088229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 11098229Snate@binkert.org#include "mem/protocol/Types.hh" 11106657Snate@binkert.org#include "mem/ruby/common/Global.hh" 11116657Snate@binkert.org#include "mem/ruby/system/System.hh" 11126657Snate@binkert.org 11136657Snate@binkert.org#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event)) 11146657Snate@binkert.org 11156657Snate@binkert.org#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str()) 11166657Snate@binkert.org#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str("")) 11176657Snate@binkert.org 11187007Snate@binkert.orgTransitionResult 11197007Snate@binkert.org${ident}_Controller::doTransition(${ident}_Event event, 11207839Snilay@cs.wisc.edu''') 11217839Snilay@cs.wisc.edu if self.EntryType != None: 11227839Snilay@cs.wisc.edu code(''' 11237839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}* m_cache_entry_ptr, 11247839Snilay@cs.wisc.edu''') 11257839Snilay@cs.wisc.edu if self.TBEType != None: 11267839Snilay@cs.wisc.edu code(''' 11277839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}* m_tbe_ptr, 11287839Snilay@cs.wisc.edu''') 11297839Snilay@cs.wisc.edu code(''' 11307007Snate@binkert.org const Address &addr) 11316657Snate@binkert.org{ 11327839Snilay@cs.wisc.edu''') 11337839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11348337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, m_cache_entry_ptr, addr);') 11357839Snilay@cs.wisc.edu elif self.TBEType != None: 11368337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, addr);') 11377839Snilay@cs.wisc.edu elif self.EntryType != None: 11388337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_cache_entry_ptr, addr);') 11397839Snilay@cs.wisc.edu else: 11408337Snilay@cs.wisc.edu code('${ident}_State state = getState(addr);') 11417839Snilay@cs.wisc.edu 11427839Snilay@cs.wisc.edu code(''' 11436657Snate@binkert.org ${ident}_State next_state = state; 11446657Snate@binkert.org 11457780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "%s, Time: %lld, state: %s, event: %s, addr: %s\\n", 11469465Snilay@cs.wisc.edu *this, curCycle(), ${ident}_State_to_string(state), 11479171Snilay@cs.wisc.edu ${ident}_Event_to_string(event), addr); 11486657Snate@binkert.org 11497007Snate@binkert.org TransitionResult result = 11507839Snilay@cs.wisc.edu''') 11517839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11527839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, m_cache_entry_ptr, addr);') 11537839Snilay@cs.wisc.edu elif self.TBEType != None: 11547839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, addr);') 11557839Snilay@cs.wisc.edu elif self.EntryType != None: 11567839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_cache_entry_ptr, addr);') 11577839Snilay@cs.wisc.edu else: 11587839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, addr);') 11596657Snate@binkert.org 11607839Snilay@cs.wisc.edu code(''' 11616657Snate@binkert.org if (result == TransitionResult_Valid) { 11627780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "next_state: %s\\n", 11637780Snilay@cs.wisc.edu ${ident}_State_to_string(next_state)); 11647542SBrad.Beckmann@amd.com m_profiler.countTransition(state, event); 11658266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15d %3s %10s%20s %6s>%-6s %s %s\\n", 11668266Sksewell@umich.edu curTick(), m_version, "${ident}", 11678266Sksewell@umich.edu ${ident}_Event_to_string(event), 11688266Sksewell@umich.edu ${ident}_State_to_string(state), 11698266Sksewell@umich.edu ${ident}_State_to_string(next_state), 11708266Sksewell@umich.edu addr, GET_TRANSITION_COMMENT()); 11716657Snate@binkert.org 11727832Snate@binkert.org CLEAR_TRANSITION_COMMENT(); 11737839Snilay@cs.wisc.edu''') 11747839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11758337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, m_cache_entry_ptr, addr, next_state);') 11768341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 11777839Snilay@cs.wisc.edu elif self.TBEType != None: 11788337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, addr, next_state);') 11798341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 11807839Snilay@cs.wisc.edu elif self.EntryType != None: 11818337Snilay@cs.wisc.edu code('setState(m_cache_entry_ptr, addr, next_state);') 11828341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 11837839Snilay@cs.wisc.edu else: 11848337Snilay@cs.wisc.edu code('setState(addr, next_state);') 11858341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 11867839Snilay@cs.wisc.edu 11877839Snilay@cs.wisc.edu code(''' 11886657Snate@binkert.org } else if (result == TransitionResult_ResourceStall) { 11898266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n", 11908266Sksewell@umich.edu curTick(), m_version, "${ident}", 11918266Sksewell@umich.edu ${ident}_Event_to_string(event), 11928266Sksewell@umich.edu ${ident}_State_to_string(state), 11938266Sksewell@umich.edu ${ident}_State_to_string(next_state), 11948266Sksewell@umich.edu addr, "Resource Stall"); 11956657Snate@binkert.org } else if (result == TransitionResult_ProtocolStall) { 11967780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "stalling\\n"); 11978266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n", 11988266Sksewell@umich.edu curTick(), m_version, "${ident}", 11998266Sksewell@umich.edu ${ident}_Event_to_string(event), 12008266Sksewell@umich.edu ${ident}_State_to_string(state), 12018266Sksewell@umich.edu ${ident}_State_to_string(next_state), 12028266Sksewell@umich.edu addr, "Protocol Stall"); 12036657Snate@binkert.org } 12046657Snate@binkert.org 12056657Snate@binkert.org return result; 12066657Snate@binkert.org} 12076657Snate@binkert.org 12087007Snate@binkert.orgTransitionResult 12097007Snate@binkert.org${ident}_Controller::doTransitionWorker(${ident}_Event event, 12107007Snate@binkert.org ${ident}_State state, 12117007Snate@binkert.org ${ident}_State& next_state, 12127839Snilay@cs.wisc.edu''') 12137839Snilay@cs.wisc.edu 12147839Snilay@cs.wisc.edu if self.TBEType != None: 12157839Snilay@cs.wisc.edu code(''' 12167839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}*& m_tbe_ptr, 12177839Snilay@cs.wisc.edu''') 12187839Snilay@cs.wisc.edu if self.EntryType != None: 12197839Snilay@cs.wisc.edu code(''' 12207839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, 12217839Snilay@cs.wisc.edu''') 12227839Snilay@cs.wisc.edu code(''' 12237007Snate@binkert.org const Address& addr) 12246657Snate@binkert.org{ 12256657Snate@binkert.org switch(HASH_FUN(state, event)) { 12266657Snate@binkert.org''') 12276657Snate@binkert.org 12286657Snate@binkert.org # This map will allow suppress generating duplicate code 12296657Snate@binkert.org cases = orderdict() 12306657Snate@binkert.org 12316657Snate@binkert.org for trans in self.transitions: 12326657Snate@binkert.org case_string = "%s_State_%s, %s_Event_%s" % \ 12336657Snate@binkert.org (self.ident, trans.state.ident, self.ident, trans.event.ident) 12346657Snate@binkert.org 12356999Snate@binkert.org case = self.symtab.codeFormatter() 12366657Snate@binkert.org # Only set next_state if it changes 12376657Snate@binkert.org if trans.state != trans.nextState: 12386657Snate@binkert.org ns_ident = trans.nextState.ident 12396657Snate@binkert.org case('next_state = ${ident}_State_${ns_ident};') 12406657Snate@binkert.org 12416657Snate@binkert.org actions = trans.actions 12429104Shestness@cs.utexas.edu request_types = trans.request_types 12436657Snate@binkert.org 12446657Snate@binkert.org # Check for resources 12456657Snate@binkert.org case_sorter = [] 12466657Snate@binkert.org res = trans.resources 12476657Snate@binkert.org for key,val in res.iteritems(): 12486657Snate@binkert.org if key.type.ident != "DNUCAStopTable": 12496657Snate@binkert.org val = ''' 12507007Snate@binkert.orgif (!%s.areNSlotsAvailable(%s)) 12516657Snate@binkert.org return TransitionResult_ResourceStall; 12526657Snate@binkert.org''' % (key.code, val) 12536657Snate@binkert.org case_sorter.append(val) 12546657Snate@binkert.org 12559105SBrad.Beckmann@amd.com # Check all of the request_types for resource constraints 12569105SBrad.Beckmann@amd.com for request_type in request_types: 12579105SBrad.Beckmann@amd.com val = ''' 12589105SBrad.Beckmann@amd.comif (!checkResourceAvailable(%s_RequestType_%s, addr)) { 12599105SBrad.Beckmann@amd.com return TransitionResult_ResourceStall; 12609105SBrad.Beckmann@amd.com} 12619105SBrad.Beckmann@amd.com''' % (self.ident, request_type.ident) 12629105SBrad.Beckmann@amd.com case_sorter.append(val) 12636657Snate@binkert.org 12646657Snate@binkert.org # Emit the code sequences in a sorted order. This makes the 12656657Snate@binkert.org # output deterministic (without this the output order can vary 12666657Snate@binkert.org # since Map's keys() on a vector of pointers is not deterministic 12676657Snate@binkert.org for c in sorted(case_sorter): 12686657Snate@binkert.org case("$c") 12696657Snate@binkert.org 12709104Shestness@cs.utexas.edu # Record access types for this transition 12719104Shestness@cs.utexas.edu for request_type in request_types: 12729104Shestness@cs.utexas.edu case('recordRequestType(${ident}_RequestType_${{request_type.ident}}, addr);') 12739104Shestness@cs.utexas.edu 12746657Snate@binkert.org # Figure out if we stall 12756657Snate@binkert.org stall = False 12766657Snate@binkert.org for action in actions: 12776657Snate@binkert.org if action.ident == "z_stall": 12786657Snate@binkert.org stall = True 12796657Snate@binkert.org break 12806657Snate@binkert.org 12816657Snate@binkert.org if stall: 12826657Snate@binkert.org case('return TransitionResult_ProtocolStall;') 12836657Snate@binkert.org else: 12847839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 12857839Snilay@cs.wisc.edu for action in actions: 12867839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, m_cache_entry_ptr, addr);') 12877839Snilay@cs.wisc.edu elif self.TBEType != None: 12887839Snilay@cs.wisc.edu for action in actions: 12897839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, addr);') 12907839Snilay@cs.wisc.edu elif self.EntryType != None: 12917839Snilay@cs.wisc.edu for action in actions: 12927839Snilay@cs.wisc.edu case('${{action.ident}}(m_cache_entry_ptr, addr);') 12937839Snilay@cs.wisc.edu else: 12947839Snilay@cs.wisc.edu for action in actions: 12957839Snilay@cs.wisc.edu case('${{action.ident}}(addr);') 12966657Snate@binkert.org case('return TransitionResult_Valid;') 12976657Snate@binkert.org 12986657Snate@binkert.org case = str(case) 12996657Snate@binkert.org 13006657Snate@binkert.org # Look to see if this transition code is unique. 13016657Snate@binkert.org if case not in cases: 13026657Snate@binkert.org cases[case] = [] 13036657Snate@binkert.org 13046657Snate@binkert.org cases[case].append(case_string) 13056657Snate@binkert.org 13066657Snate@binkert.org # Walk through all of the unique code blocks and spit out the 13076657Snate@binkert.org # corresponding case statement elements 13086657Snate@binkert.org for case,transitions in cases.iteritems(): 13096657Snate@binkert.org # Iterative over all the multiple transitions that share 13106657Snate@binkert.org # the same code 13116657Snate@binkert.org for trans in transitions: 13126657Snate@binkert.org code(' case HASH_FUN($trans):') 13136657Snate@binkert.org code(' $case') 13146657Snate@binkert.org 13156657Snate@binkert.org code(''' 13166657Snate@binkert.org default: 13177805Snilay@cs.wisc.edu fatal("Invalid transition\\n" 13188159SBrad.Beckmann@amd.com "%s time: %d addr: %s event: %s state: %s\\n", 13199465Snilay@cs.wisc.edu name(), curCycle(), addr, event, state); 13206657Snate@binkert.org } 13216657Snate@binkert.org return TransitionResult_Valid; 13226657Snate@binkert.org} 13236657Snate@binkert.org''') 13246657Snate@binkert.org code.write(path, "%s_Transitions.cc" % self.ident) 13256657Snate@binkert.org 13267542SBrad.Beckmann@amd.com def printProfileDumperHH(self, path): 13277542SBrad.Beckmann@amd.com code = self.symtab.codeFormatter() 13287542SBrad.Beckmann@amd.com ident = self.ident 13297542SBrad.Beckmann@amd.com 13307542SBrad.Beckmann@amd.com code(''' 13317542SBrad.Beckmann@amd.com// Auto generated C++ code started by $__file__:$__line__ 13327542SBrad.Beckmann@amd.com// ${ident}: ${{self.short}} 13337542SBrad.Beckmann@amd.com 13347542SBrad.Beckmann@amd.com#ifndef __${ident}_PROFILE_DUMPER_HH__ 13357542SBrad.Beckmann@amd.com#define __${ident}_PROFILE_DUMPER_HH__ 13367542SBrad.Beckmann@amd.com 13377832Snate@binkert.org#include <cassert> 13387542SBrad.Beckmann@amd.com#include <iostream> 13397542SBrad.Beckmann@amd.com#include <vector> 13407542SBrad.Beckmann@amd.com 13418229Snate@binkert.org#include "${ident}_Event.hh" 13427542SBrad.Beckmann@amd.com#include "${ident}_Profiler.hh" 13437542SBrad.Beckmann@amd.com 13447542SBrad.Beckmann@amd.comtypedef std::vector<${ident}_Profiler *> ${ident}_profilers; 13457542SBrad.Beckmann@amd.com 13467542SBrad.Beckmann@amd.comclass ${ident}_ProfileDumper 13477542SBrad.Beckmann@amd.com{ 13487542SBrad.Beckmann@amd.com public: 13497542SBrad.Beckmann@amd.com ${ident}_ProfileDumper(); 13507542SBrad.Beckmann@amd.com void registerProfiler(${ident}_Profiler* profiler); 13517542SBrad.Beckmann@amd.com void dumpStats(std::ostream& out) const; 13527542SBrad.Beckmann@amd.com 13537542SBrad.Beckmann@amd.com private: 13547542SBrad.Beckmann@amd.com ${ident}_profilers m_profilers; 13557542SBrad.Beckmann@amd.com}; 13567542SBrad.Beckmann@amd.com 13577542SBrad.Beckmann@amd.com#endif // __${ident}_PROFILE_DUMPER_HH__ 13587542SBrad.Beckmann@amd.com''') 13597542SBrad.Beckmann@amd.com code.write(path, "%s_ProfileDumper.hh" % self.ident) 13607542SBrad.Beckmann@amd.com 13617542SBrad.Beckmann@amd.com def printProfileDumperCC(self, path): 13627542SBrad.Beckmann@amd.com code = self.symtab.codeFormatter() 13637542SBrad.Beckmann@amd.com ident = self.ident 13647542SBrad.Beckmann@amd.com 13657542SBrad.Beckmann@amd.com code(''' 13667542SBrad.Beckmann@amd.com// Auto generated C++ code started by $__file__:$__line__ 13677542SBrad.Beckmann@amd.com// ${ident}: ${{self.short}} 13687542SBrad.Beckmann@amd.com 13697542SBrad.Beckmann@amd.com#include "mem/protocol/${ident}_ProfileDumper.hh" 13707542SBrad.Beckmann@amd.com 13717542SBrad.Beckmann@amd.com${ident}_ProfileDumper::${ident}_ProfileDumper() 13727542SBrad.Beckmann@amd.com{ 13737542SBrad.Beckmann@amd.com} 13747542SBrad.Beckmann@amd.com 13757542SBrad.Beckmann@amd.comvoid 13767542SBrad.Beckmann@amd.com${ident}_ProfileDumper::registerProfiler(${ident}_Profiler* profiler) 13777542SBrad.Beckmann@amd.com{ 13787542SBrad.Beckmann@amd.com m_profilers.push_back(profiler); 13797542SBrad.Beckmann@amd.com} 13807542SBrad.Beckmann@amd.com 13817542SBrad.Beckmann@amd.comvoid 13827542SBrad.Beckmann@amd.com${ident}_ProfileDumper::dumpStats(std::ostream& out) const 13837542SBrad.Beckmann@amd.com{ 13847542SBrad.Beckmann@amd.com out << " --- ${ident} ---\\n"; 13857542SBrad.Beckmann@amd.com out << " - Event Counts -\\n"; 13867542SBrad.Beckmann@amd.com for (${ident}_Event event = ${ident}_Event_FIRST; 13877542SBrad.Beckmann@amd.com event < ${ident}_Event_NUM; 13887542SBrad.Beckmann@amd.com ++event) { 13897542SBrad.Beckmann@amd.com out << (${ident}_Event) event << " ["; 13907542SBrad.Beckmann@amd.com uint64 total = 0; 13917542SBrad.Beckmann@amd.com for (int i = 0; i < m_profilers.size(); i++) { 13927542SBrad.Beckmann@amd.com out << m_profilers[i]->getEventCount(event) << " "; 13937542SBrad.Beckmann@amd.com total += m_profilers[i]->getEventCount(event); 13947542SBrad.Beckmann@amd.com } 13957542SBrad.Beckmann@amd.com out << "] " << total << "\\n"; 13967542SBrad.Beckmann@amd.com } 13977542SBrad.Beckmann@amd.com out << "\\n"; 13987542SBrad.Beckmann@amd.com out << " - Transitions -\\n"; 13997542SBrad.Beckmann@amd.com for (${ident}_State state = ${ident}_State_FIRST; 14007542SBrad.Beckmann@amd.com state < ${ident}_State_NUM; 14017542SBrad.Beckmann@amd.com ++state) { 14027542SBrad.Beckmann@amd.com for (${ident}_Event event = ${ident}_Event_FIRST; 14037542SBrad.Beckmann@amd.com event < ${ident}_Event_NUM; 14047542SBrad.Beckmann@amd.com ++event) { 14057542SBrad.Beckmann@amd.com if (m_profilers[0]->isPossible(state, event)) { 14067542SBrad.Beckmann@amd.com out << (${ident}_State) state << " " 14077542SBrad.Beckmann@amd.com << (${ident}_Event) event << " ["; 14087542SBrad.Beckmann@amd.com uint64 total = 0; 14097542SBrad.Beckmann@amd.com for (int i = 0; i < m_profilers.size(); i++) { 14107542SBrad.Beckmann@amd.com out << m_profilers[i]->getTransitionCount(state, event) << " "; 14117542SBrad.Beckmann@amd.com total += m_profilers[i]->getTransitionCount(state, event); 14127542SBrad.Beckmann@amd.com } 14137542SBrad.Beckmann@amd.com out << "] " << total << "\\n"; 14147542SBrad.Beckmann@amd.com } 14157542SBrad.Beckmann@amd.com } 14167542SBrad.Beckmann@amd.com out << "\\n"; 14177542SBrad.Beckmann@amd.com } 14187542SBrad.Beckmann@amd.com} 14197542SBrad.Beckmann@amd.com''') 14207542SBrad.Beckmann@amd.com code.write(path, "%s_ProfileDumper.cc" % self.ident) 14217542SBrad.Beckmann@amd.com 14226657Snate@binkert.org def printProfilerHH(self, path): 14236999Snate@binkert.org code = self.symtab.codeFormatter() 14246657Snate@binkert.org ident = self.ident 14256657Snate@binkert.org 14266657Snate@binkert.org code(''' 14276657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 14286657Snate@binkert.org// ${ident}: ${{self.short}} 14296657Snate@binkert.org 14307542SBrad.Beckmann@amd.com#ifndef __${ident}_PROFILER_HH__ 14317542SBrad.Beckmann@amd.com#define __${ident}_PROFILER_HH__ 14326657Snate@binkert.org 14337832Snate@binkert.org#include <cassert> 14347002Snate@binkert.org#include <iostream> 14357002Snate@binkert.org 14368229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 14378229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 14388608Snilay@cs.wisc.edu#include "mem/ruby/common/TypeDefines.hh" 14396657Snate@binkert.org 14407007Snate@binkert.orgclass ${ident}_Profiler 14417007Snate@binkert.org{ 14426657Snate@binkert.org public: 14436657Snate@binkert.org ${ident}_Profiler(); 14446657Snate@binkert.org void setVersion(int version); 14456657Snate@binkert.org void countTransition(${ident}_State state, ${ident}_Event event); 14466657Snate@binkert.org void possibleTransition(${ident}_State state, ${ident}_Event event); 14477542SBrad.Beckmann@amd.com uint64 getEventCount(${ident}_Event event); 14487542SBrad.Beckmann@amd.com bool isPossible(${ident}_State state, ${ident}_Event event); 14497542SBrad.Beckmann@amd.com uint64 getTransitionCount(${ident}_State state, ${ident}_Event event); 14506657Snate@binkert.org void clearStats(); 14516657Snate@binkert.org 14526657Snate@binkert.org private: 14536657Snate@binkert.org int m_counters[${ident}_State_NUM][${ident}_Event_NUM]; 14546657Snate@binkert.org int m_event_counters[${ident}_Event_NUM]; 14556657Snate@binkert.org bool m_possible[${ident}_State_NUM][${ident}_Event_NUM]; 14566657Snate@binkert.org int m_version; 14576657Snate@binkert.org}; 14586657Snate@binkert.org 14597007Snate@binkert.org#endif // __${ident}_PROFILER_HH__ 14606657Snate@binkert.org''') 14616657Snate@binkert.org code.write(path, "%s_Profiler.hh" % self.ident) 14626657Snate@binkert.org 14636657Snate@binkert.org def printProfilerCC(self, path): 14646999Snate@binkert.org code = self.symtab.codeFormatter() 14656657Snate@binkert.org ident = self.ident 14666657Snate@binkert.org 14676657Snate@binkert.org code(''' 14686657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 14696657Snate@binkert.org// ${ident}: ${{self.short}} 14706657Snate@binkert.org 14717832Snate@binkert.org#include <cassert> 14727832Snate@binkert.org 14736657Snate@binkert.org#include "mem/protocol/${ident}_Profiler.hh" 14746657Snate@binkert.org 14756657Snate@binkert.org${ident}_Profiler::${ident}_Profiler() 14766657Snate@binkert.org{ 14776657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 14786657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 14796657Snate@binkert.org m_possible[state][event] = false; 14806657Snate@binkert.org m_counters[state][event] = 0; 14816657Snate@binkert.org } 14826657Snate@binkert.org } 14836657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 14846657Snate@binkert.org m_event_counters[event] = 0; 14856657Snate@binkert.org } 14866657Snate@binkert.org} 14877007Snate@binkert.org 14887007Snate@binkert.orgvoid 14897007Snate@binkert.org${ident}_Profiler::setVersion(int version) 14906657Snate@binkert.org{ 14916657Snate@binkert.org m_version = version; 14926657Snate@binkert.org} 14937007Snate@binkert.org 14947007Snate@binkert.orgvoid 14957007Snate@binkert.org${ident}_Profiler::clearStats() 14966657Snate@binkert.org{ 14976657Snate@binkert.org for (int state = 0; state < ${ident}_State_NUM; state++) { 14986657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 14996657Snate@binkert.org m_counters[state][event] = 0; 15006657Snate@binkert.org } 15016657Snate@binkert.org } 15026657Snate@binkert.org 15036657Snate@binkert.org for (int event = 0; event < ${ident}_Event_NUM; event++) { 15046657Snate@binkert.org m_event_counters[event] = 0; 15056657Snate@binkert.org } 15066657Snate@binkert.org} 15077007Snate@binkert.orgvoid 15087007Snate@binkert.org${ident}_Profiler::countTransition(${ident}_State state, ${ident}_Event event) 15096657Snate@binkert.org{ 15106657Snate@binkert.org assert(m_possible[state][event]); 15116657Snate@binkert.org m_counters[state][event]++; 15126657Snate@binkert.org m_event_counters[event]++; 15136657Snate@binkert.org} 15147007Snate@binkert.orgvoid 15157007Snate@binkert.org${ident}_Profiler::possibleTransition(${ident}_State state, 15167007Snate@binkert.org ${ident}_Event event) 15176657Snate@binkert.org{ 15186657Snate@binkert.org m_possible[state][event] = true; 15196657Snate@binkert.org} 15207007Snate@binkert.org 15217542SBrad.Beckmann@amd.comuint64 15227542SBrad.Beckmann@amd.com${ident}_Profiler::getEventCount(${ident}_Event event) 15236657Snate@binkert.org{ 15247542SBrad.Beckmann@amd.com return m_event_counters[event]; 15257542SBrad.Beckmann@amd.com} 15267002Snate@binkert.org 15277542SBrad.Beckmann@amd.combool 15287542SBrad.Beckmann@amd.com${ident}_Profiler::isPossible(${ident}_State state, ${ident}_Event event) 15297542SBrad.Beckmann@amd.com{ 15307542SBrad.Beckmann@amd.com return m_possible[state][event]; 15316657Snate@binkert.org} 15327542SBrad.Beckmann@amd.com 15337542SBrad.Beckmann@amd.comuint64 15347542SBrad.Beckmann@amd.com${ident}_Profiler::getTransitionCount(${ident}_State state, 15357542SBrad.Beckmann@amd.com ${ident}_Event event) 15367542SBrad.Beckmann@amd.com{ 15377542SBrad.Beckmann@amd.com return m_counters[state][event]; 15387542SBrad.Beckmann@amd.com} 15397542SBrad.Beckmann@amd.com 15406657Snate@binkert.org''') 15416657Snate@binkert.org code.write(path, "%s_Profiler.cc" % self.ident) 15426657Snate@binkert.org 15436657Snate@binkert.org # ************************** 15446657Snate@binkert.org # ******* HTML Files ******* 15456657Snate@binkert.org # ************************** 15467007Snate@binkert.org def frameRef(self, click_href, click_target, over_href, over_num, text): 15476999Snate@binkert.org code = self.symtab.codeFormatter(fix_newlines=False) 15487007Snate@binkert.org code("""<A href=\"$click_href\" target=\"$click_target\" onmouseover=\" 15497007Snate@binkert.org if (parent.frames[$over_num].location != parent.location + '$over_href') { 15507007Snate@binkert.org parent.frames[$over_num].location='$over_href' 15517007Snate@binkert.org }\"> 15527007Snate@binkert.org ${{html.formatShorthand(text)}} 15537007Snate@binkert.org </A>""") 15546657Snate@binkert.org return str(code) 15556657Snate@binkert.org 15566657Snate@binkert.org def writeHTMLFiles(self, path): 15576657Snate@binkert.org # Create table with no row hilighted 15586657Snate@binkert.org self.printHTMLTransitions(path, None) 15596657Snate@binkert.org 15606657Snate@binkert.org # Generate transition tables 15616657Snate@binkert.org for state in self.states.itervalues(): 15626657Snate@binkert.org self.printHTMLTransitions(path, state) 15636657Snate@binkert.org 15646657Snate@binkert.org # Generate action descriptions 15656657Snate@binkert.org for action in self.actions.itervalues(): 15666657Snate@binkert.org name = "%s_action_%s.html" % (self.ident, action.ident) 15676657Snate@binkert.org code = html.createSymbol(action, "Action") 15686657Snate@binkert.org code.write(path, name) 15696657Snate@binkert.org 15706657Snate@binkert.org # Generate state descriptions 15716657Snate@binkert.org for state in self.states.itervalues(): 15726657Snate@binkert.org name = "%s_State_%s.html" % (self.ident, state.ident) 15736657Snate@binkert.org code = html.createSymbol(state, "State") 15746657Snate@binkert.org code.write(path, name) 15756657Snate@binkert.org 15766657Snate@binkert.org # Generate event descriptions 15776657Snate@binkert.org for event in self.events.itervalues(): 15786657Snate@binkert.org name = "%s_Event_%s.html" % (self.ident, event.ident) 15796657Snate@binkert.org code = html.createSymbol(event, "Event") 15806657Snate@binkert.org code.write(path, name) 15816657Snate@binkert.org 15826657Snate@binkert.org def printHTMLTransitions(self, path, active_state): 15836999Snate@binkert.org code = self.symtab.codeFormatter() 15846657Snate@binkert.org 15856657Snate@binkert.org code(''' 15867007Snate@binkert.org<HTML> 15877007Snate@binkert.org<BODY link="blue" vlink="blue"> 15886657Snate@binkert.org 15896657Snate@binkert.org<H1 align="center">${{html.formatShorthand(self.short)}}: 15906657Snate@binkert.org''') 15916657Snate@binkert.org code.indent() 15926657Snate@binkert.org for i,machine in enumerate(self.symtab.getAllType(StateMachine)): 15936657Snate@binkert.org mid = machine.ident 15946657Snate@binkert.org if i != 0: 15956657Snate@binkert.org extra = " - " 15966657Snate@binkert.org else: 15976657Snate@binkert.org extra = "" 15986657Snate@binkert.org if machine == self: 15996657Snate@binkert.org code('$extra$mid') 16006657Snate@binkert.org else: 16016657Snate@binkert.org code('$extra<A target="Table" href="${mid}_table.html">$mid</A>') 16026657Snate@binkert.org code.dedent() 16036657Snate@binkert.org 16046657Snate@binkert.org code(""" 16056657Snate@binkert.org</H1> 16066657Snate@binkert.org 16076657Snate@binkert.org<TABLE border=1> 16086657Snate@binkert.org<TR> 16096657Snate@binkert.org <TH> </TH> 16106657Snate@binkert.org""") 16116657Snate@binkert.org 16126657Snate@binkert.org for event in self.events.itervalues(): 16136657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 16146657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 16156657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 16166657Snate@binkert.org 16176657Snate@binkert.org code('</TR>') 16186657Snate@binkert.org # -- Body of table 16196657Snate@binkert.org for state in self.states.itervalues(): 16206657Snate@binkert.org # -- Each row 16216657Snate@binkert.org if state == active_state: 16226657Snate@binkert.org color = "yellow" 16236657Snate@binkert.org else: 16246657Snate@binkert.org color = "white" 16256657Snate@binkert.org 16266657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 16276657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 16286657Snate@binkert.org text = html.formatShorthand(state.short) 16296657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 16306657Snate@binkert.org code(''' 16316657Snate@binkert.org<TR> 16326657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 16336657Snate@binkert.org''') 16346657Snate@binkert.org 16356657Snate@binkert.org # -- One column for each event 16366657Snate@binkert.org for event in self.events.itervalues(): 16376657Snate@binkert.org trans = self.table.get((state,event), None) 16386657Snate@binkert.org if trans is None: 16396657Snate@binkert.org # This is the no transition case 16406657Snate@binkert.org if state == active_state: 16416657Snate@binkert.org color = "#C0C000" 16426657Snate@binkert.org else: 16436657Snate@binkert.org color = "lightgrey" 16446657Snate@binkert.org 16456657Snate@binkert.org code('<TD bgcolor=$color> </TD>') 16466657Snate@binkert.org continue 16476657Snate@binkert.org 16486657Snate@binkert.org next = trans.nextState 16496657Snate@binkert.org stall_action = False 16506657Snate@binkert.org 16516657Snate@binkert.org # -- Get the actions 16526657Snate@binkert.org for action in trans.actions: 16536657Snate@binkert.org if action.ident == "z_stall" or \ 16546657Snate@binkert.org action.ident == "zz_recycleMandatoryQueue": 16556657Snate@binkert.org stall_action = True 16566657Snate@binkert.org 16576657Snate@binkert.org # -- Print out "actions/next-state" 16586657Snate@binkert.org if stall_action: 16596657Snate@binkert.org if state == active_state: 16606657Snate@binkert.org color = "#C0C000" 16616657Snate@binkert.org else: 16626657Snate@binkert.org color = "lightgrey" 16636657Snate@binkert.org 16646657Snate@binkert.org elif active_state and next.ident == active_state.ident: 16656657Snate@binkert.org color = "aqua" 16666657Snate@binkert.org elif state == active_state: 16676657Snate@binkert.org color = "yellow" 16686657Snate@binkert.org else: 16696657Snate@binkert.org color = "white" 16706657Snate@binkert.org 16716657Snate@binkert.org code('<TD bgcolor=$color>') 16726657Snate@binkert.org for action in trans.actions: 16736657Snate@binkert.org href = "%s_action_%s.html" % (self.ident, action.ident) 16746657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", 16756657Snate@binkert.org action.short) 16767007Snate@binkert.org code(' $ref') 16776657Snate@binkert.org if next != state: 16786657Snate@binkert.org if trans.actions: 16796657Snate@binkert.org code('/') 16806657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, next.ident) 16816657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, next.ident) 16826657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", next.short) 16836657Snate@binkert.org code("$ref") 16847007Snate@binkert.org code("</TD>") 16856657Snate@binkert.org 16866657Snate@binkert.org # -- Each row 16876657Snate@binkert.org if state == active_state: 16886657Snate@binkert.org color = "yellow" 16896657Snate@binkert.org else: 16906657Snate@binkert.org color = "white" 16916657Snate@binkert.org 16926657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 16936657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 16946657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 16956657Snate@binkert.org code(''' 16966657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 16976657Snate@binkert.org</TR> 16986657Snate@binkert.org''') 16996657Snate@binkert.org code(''' 17007007Snate@binkert.org<!- Column footer-> 17016657Snate@binkert.org<TR> 17026657Snate@binkert.org <TH> </TH> 17036657Snate@binkert.org''') 17046657Snate@binkert.org 17056657Snate@binkert.org for event in self.events.itervalues(): 17066657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 17076657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 17086657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 17096657Snate@binkert.org code(''' 17106657Snate@binkert.org</TR> 17116657Snate@binkert.org</TABLE> 17126657Snate@binkert.org</BODY></HTML> 17136657Snate@binkert.org''') 17146657Snate@binkert.org 17156657Snate@binkert.org 17166657Snate@binkert.org if active_state: 17176657Snate@binkert.org name = "%s_table_%s.html" % (self.ident, active_state.ident) 17186657Snate@binkert.org else: 17196657Snate@binkert.org name = "%s_table.html" % self.ident 17206657Snate@binkert.org code.write(path, name) 17216657Snate@binkert.org 17226657Snate@binkert.org__all__ = [ "StateMachine" ] 1723