StateMachine.py revision 10078
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 359499Snilay@cs.wisc.edupython_class_map = { 369499Snilay@cs.wisc.edu "int": "Int", 379364Snilay@cs.wisc.edu "uint32_t" : "UInt32", 387055Snate@binkert.org "std::string": "String", 396882SBrad.Beckmann@amd.com "bool": "Bool", 406882SBrad.Beckmann@amd.com "CacheMemory": "RubyCache", 418191SLisa.Hsu@amd.com "WireBuffer": "RubyWireBuffer", 426882SBrad.Beckmann@amd.com "Sequencer": "RubySequencer", 436882SBrad.Beckmann@amd.com "DirectoryMemory": "RubyDirectoryMemory", 449102SNuwan.Jayasena@amd.com "MemoryControl": "MemoryControl", 459366Snilay@cs.wisc.edu "DMASequencer": "DMASequencer", 469499Snilay@cs.wisc.edu "Prefetcher":"Prefetcher", 479499Snilay@cs.wisc.edu "Cycles":"Cycles", 489499Snilay@cs.wisc.edu } 496882SBrad.Beckmann@amd.com 506657Snate@binkert.orgclass StateMachine(Symbol): 516657Snate@binkert.org def __init__(self, symtab, ident, location, pairs, config_parameters): 526657Snate@binkert.org super(StateMachine, self).__init__(symtab, ident, location, pairs) 536657Snate@binkert.org self.table = None 546657Snate@binkert.org self.config_parameters = config_parameters 559366Snilay@cs.wisc.edu self.prefetchers = [] 567839Snilay@cs.wisc.edu 576657Snate@binkert.org for param in config_parameters: 586882SBrad.Beckmann@amd.com if param.pointer: 596882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 606882SBrad.Beckmann@amd.com "(*m_%s_ptr)" % param.name, {}, self) 616882SBrad.Beckmann@amd.com else: 626882SBrad.Beckmann@amd.com var = Var(symtab, param.name, location, param.type_ast.type, 636882SBrad.Beckmann@amd.com "m_%s" % param.name, {}, self) 646657Snate@binkert.org self.symtab.registerSym(param.name, var) 659366Snilay@cs.wisc.edu if str(param.type_ast.type) == "Prefetcher": 669366Snilay@cs.wisc.edu self.prefetchers.append(var) 676657Snate@binkert.org 686657Snate@binkert.org self.states = orderdict() 696657Snate@binkert.org self.events = orderdict() 706657Snate@binkert.org self.actions = orderdict() 719104Shestness@cs.utexas.edu self.request_types = orderdict() 726657Snate@binkert.org self.transitions = [] 736657Snate@binkert.org self.in_ports = [] 746657Snate@binkert.org self.functions = [] 756657Snate@binkert.org self.objects = [] 767839Snilay@cs.wisc.edu self.TBEType = None 777839Snilay@cs.wisc.edu self.EntryType = None 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 1776877Ssteve.reinhardt@amd.com def printControllerPython(self, path): 1786999Snate@binkert.org code = self.symtab.codeFormatter() 1796877Ssteve.reinhardt@amd.com ident = self.ident 1806877Ssteve.reinhardt@amd.com py_ident = "%s_Controller" % ident 1816877Ssteve.reinhardt@amd.com c_ident = "%s_Controller" % self.ident 1826877Ssteve.reinhardt@amd.com code(''' 1836877Ssteve.reinhardt@amd.comfrom m5.params import * 1846877Ssteve.reinhardt@amd.comfrom m5.SimObject import SimObject 1856877Ssteve.reinhardt@amd.comfrom Controller import RubyController 1866877Ssteve.reinhardt@amd.com 1876877Ssteve.reinhardt@amd.comclass $py_ident(RubyController): 1886877Ssteve.reinhardt@amd.com type = '$py_ident' 1899338SAndreas.Sandberg@arm.com cxx_header = 'mem/protocol/${c_ident}.hh' 1906877Ssteve.reinhardt@amd.com''') 1916877Ssteve.reinhardt@amd.com code.indent() 1926877Ssteve.reinhardt@amd.com for param in self.config_parameters: 1936877Ssteve.reinhardt@amd.com dflt_str = '' 1946877Ssteve.reinhardt@amd.com if param.default is not None: 1956877Ssteve.reinhardt@amd.com dflt_str = str(param.default) + ', ' 1966882SBrad.Beckmann@amd.com if python_class_map.has_key(param.type_ast.type.c_ident): 1976882SBrad.Beckmann@amd.com python_type = python_class_map[param.type_ast.type.c_ident] 1986882SBrad.Beckmann@amd.com code('${{param.name}} = Param.${{python_type}}(${dflt_str}"")') 1996882SBrad.Beckmann@amd.com else: 2006882SBrad.Beckmann@amd.com self.error("Unknown c++ to python class conversion for c++ " \ 2016882SBrad.Beckmann@amd.com "type: '%s'. Please update the python_class_map " \ 2026882SBrad.Beckmann@amd.com "in StateMachine.py", param.type_ast.type.c_ident) 2036877Ssteve.reinhardt@amd.com code.dedent() 2046877Ssteve.reinhardt@amd.com code.write(path, '%s.py' % py_ident) 2056877Ssteve.reinhardt@amd.com 2066877Ssteve.reinhardt@amd.com 2076657Snate@binkert.org def printControllerHH(self, path): 2086657Snate@binkert.org '''Output the method declarations for the class declaration''' 2096999Snate@binkert.org code = self.symtab.codeFormatter() 2106657Snate@binkert.org ident = self.ident 2116657Snate@binkert.org c_ident = "%s_Controller" % self.ident 2126657Snate@binkert.org 2136657Snate@binkert.org code(''' 2147007Snate@binkert.org/** \\file $c_ident.hh 2156657Snate@binkert.org * 2166657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 2176657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 2186657Snate@binkert.org */ 2196657Snate@binkert.org 2207007Snate@binkert.org#ifndef __${ident}_CONTROLLER_HH__ 2217007Snate@binkert.org#define __${ident}_CONTROLLER_HH__ 2226657Snate@binkert.org 2237002Snate@binkert.org#include <iostream> 2247002Snate@binkert.org#include <sstream> 2257002Snate@binkert.org#include <string> 2267002Snate@binkert.org 2276657Snate@binkert.org#include "mem/protocol/TransitionResult.hh" 2286657Snate@binkert.org#include "mem/protocol/Types.hh" 2298229Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 2308229Snate@binkert.org#include "mem/ruby/common/Global.hh" 2318229Snate@binkert.org#include "mem/ruby/slicc_interface/AbstractController.hh" 2328229Snate@binkert.org#include "params/$c_ident.hh" 2336657Snate@binkert.org''') 2346657Snate@binkert.org 2356657Snate@binkert.org seen_types = set() 2369595Snilay@cs.wisc.edu has_peer = False 2376657Snate@binkert.org for var in self.objects: 2386793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 2396657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 2409595Snilay@cs.wisc.edu if "network" in var and "physical_network" in var: 2419595Snilay@cs.wisc.edu has_peer = True 2426657Snate@binkert.org seen_types.add(var.type.ident) 2436657Snate@binkert.org 2446657Snate@binkert.org # for adding information to the protocol debug trace 2456657Snate@binkert.org code(''' 2467002Snate@binkert.orgextern std::stringstream ${ident}_transitionComment; 2476657Snate@binkert.org 2487007Snate@binkert.orgclass $c_ident : public AbstractController 2497007Snate@binkert.org{ 2509271Snilay@cs.wisc.edu public: 2516877Ssteve.reinhardt@amd.com typedef ${c_ident}Params Params; 2526877Ssteve.reinhardt@amd.com $c_ident(const Params *p); 2536657Snate@binkert.org static int getNumControllers(); 2546877Ssteve.reinhardt@amd.com void init(); 2556657Snate@binkert.org MessageBuffer* getMandatoryQueue() const; 2567002Snate@binkert.org const std::string toString() const; 2579745Snilay@cs.wisc.edu 2587002Snate@binkert.org void print(std::ostream& out) const; 2596657Snate@binkert.org void wakeup(); 26010012Snilay@cs.wisc.edu void resetStats(); 2619745Snilay@cs.wisc.edu void regStats(); 2629745Snilay@cs.wisc.edu void collateStats(); 2639745Snilay@cs.wisc.edu 2648683Snilay@cs.wisc.edu void recordCacheTrace(int cntrl, CacheRecorder* tr); 2658683Snilay@cs.wisc.edu Sequencer* getSequencer() const; 2667007Snate@binkert.org 2679302Snilay@cs.wisc.edu bool functionalReadBuffers(PacketPtr&); 2689302Snilay@cs.wisc.edu uint32_t functionalWriteBuffers(PacketPtr&); 2699302Snilay@cs.wisc.edu 2709745Snilay@cs.wisc.edu void countTransition(${ident}_State state, ${ident}_Event event); 2719745Snilay@cs.wisc.edu void possibleTransition(${ident}_State state, ${ident}_Event event); 2729745Snilay@cs.wisc.edu uint64 getEventCount(${ident}_Event event); 2739745Snilay@cs.wisc.edu bool isPossible(${ident}_State state, ${ident}_Event event); 2749745Snilay@cs.wisc.edu uint64 getTransitionCount(${ident}_State state, ${ident}_Event event); 2759745Snilay@cs.wisc.edu 2766657Snate@binkert.orgprivate: 2776657Snate@binkert.org''') 2786657Snate@binkert.org 2796657Snate@binkert.org code.indent() 2806657Snate@binkert.org # added by SS 2816657Snate@binkert.org for param in self.config_parameters: 2826882SBrad.Beckmann@amd.com if param.pointer: 2836882SBrad.Beckmann@amd.com code('${{param.type_ast.type}}* m_${{param.ident}}_ptr;') 2846882SBrad.Beckmann@amd.com else: 2856882SBrad.Beckmann@amd.com code('${{param.type_ast.type}} m_${{param.ident}};') 2866657Snate@binkert.org 2876657Snate@binkert.org code(''' 2887007Snate@binkert.orgTransitionResult doTransition(${ident}_Event event, 2897839Snilay@cs.wisc.edu''') 2907839Snilay@cs.wisc.edu 2917839Snilay@cs.wisc.edu if self.EntryType != None: 2927839Snilay@cs.wisc.edu code(''' 2937839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}* m_cache_entry_ptr, 2947839Snilay@cs.wisc.edu''') 2957839Snilay@cs.wisc.edu if self.TBEType != None: 2967839Snilay@cs.wisc.edu code(''' 2977839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}* m_tbe_ptr, 2987839Snilay@cs.wisc.edu''') 2997839Snilay@cs.wisc.edu 3007839Snilay@cs.wisc.edu code(''' 30110010Snilay@cs.wisc.edu const Address addr); 3027007Snate@binkert.org 3037007Snate@binkert.orgTransitionResult doTransitionWorker(${ident}_Event event, 3047007Snate@binkert.org ${ident}_State state, 3057007Snate@binkert.org ${ident}_State& next_state, 3067839Snilay@cs.wisc.edu''') 3077839Snilay@cs.wisc.edu 3087839Snilay@cs.wisc.edu if self.TBEType != None: 3097839Snilay@cs.wisc.edu code(''' 3107839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}*& m_tbe_ptr, 3117839Snilay@cs.wisc.edu''') 3127839Snilay@cs.wisc.edu if self.EntryType != None: 3137839Snilay@cs.wisc.edu code(''' 3147839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, 3157839Snilay@cs.wisc.edu''') 3167839Snilay@cs.wisc.edu 3177839Snilay@cs.wisc.edu code(''' 3187007Snate@binkert.org const Address& addr); 3197007Snate@binkert.org 3209745Snilay@cs.wisc.eduint m_counters[${ident}_State_NUM][${ident}_Event_NUM]; 3219745Snilay@cs.wisc.eduint m_event_counters[${ident}_Event_NUM]; 3229745Snilay@cs.wisc.edubool m_possible[${ident}_State_NUM][${ident}_Event_NUM]; 3239745Snilay@cs.wisc.edu 3249745Snilay@cs.wisc.edustatic std::vector<Stats::Vector *> eventVec; 3259745Snilay@cs.wisc.edustatic std::vector<std::vector<Stats::Vector *> > transVec; 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 3369595Snilay@cs.wisc.edu if has_peer: 3379595Snilay@cs.wisc.edu code('void getQueuesFromPeer(AbstractController *);') 3387839Snilay@cs.wisc.edu if self.EntryType != None: 3397839Snilay@cs.wisc.edu code(''' 3407839Snilay@cs.wisc.edu 3417839Snilay@cs.wisc.edu// Set and Reset for cache_entry variable 3427839Snilay@cs.wisc.eduvoid set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry); 3437839Snilay@cs.wisc.eduvoid unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr); 3447839Snilay@cs.wisc.edu''') 3457839Snilay@cs.wisc.edu 3467839Snilay@cs.wisc.edu if self.TBEType != None: 3477839Snilay@cs.wisc.edu code(''' 3487839Snilay@cs.wisc.edu 3497839Snilay@cs.wisc.edu// Set and Reset for tbe variable 3507839Snilay@cs.wisc.eduvoid set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${ident}_TBE* m_new_tbe); 3517839Snilay@cs.wisc.eduvoid unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr); 3527839Snilay@cs.wisc.edu''') 3537839Snilay@cs.wisc.edu 3546657Snate@binkert.org code(''' 3556657Snate@binkert.org 3566657Snate@binkert.org// Actions 3576657Snate@binkert.org''') 3587839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 3597839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3607839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3617839Snilay@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);') 3627839Snilay@cs.wisc.edu elif self.TBEType != None: 3637839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3647839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3657839Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr);') 3667839Snilay@cs.wisc.edu elif self.EntryType != None: 3677839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3687839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3697839Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr);') 3707839Snilay@cs.wisc.edu else: 3717839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3727839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3737839Snilay@cs.wisc.edu code('void ${{action.ident}}(const Address& addr);') 3746657Snate@binkert.org 3756657Snate@binkert.org # the controller internal variables 3766657Snate@binkert.org code(''' 3776657Snate@binkert.org 3787007Snate@binkert.org// Objects 3796657Snate@binkert.org''') 3806657Snate@binkert.org for var in self.objects: 3819273Snilay@cs.wisc.edu th = var.get("template", "") 3826657Snate@binkert.org code('${{var.type.c_ident}}$th* m_${{var.c_ident}}_ptr;') 3836657Snate@binkert.org 3846657Snate@binkert.org code.dedent() 3856657Snate@binkert.org code('};') 3867007Snate@binkert.org code('#endif // __${ident}_CONTROLLER_H__') 3876657Snate@binkert.org code.write(path, '%s.hh' % c_ident) 3886657Snate@binkert.org 3899219Spower.jg@gmail.com def printControllerCC(self, path, includes): 3906657Snate@binkert.org '''Output the actions for performing the actions''' 3916657Snate@binkert.org 3926999Snate@binkert.org code = self.symtab.codeFormatter() 3936657Snate@binkert.org ident = self.ident 3946657Snate@binkert.org c_ident = "%s_Controller" % self.ident 3959595Snilay@cs.wisc.edu has_peer = False 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; 4459745Snilay@cs.wisc.edustd::vector<Stats::Vector *> $c_ident::eventVec; 4469745Snilay@cs.wisc.edustd::vector<std::vector<Stats::Vector *> > $c_ident::transVec; 4476657Snate@binkert.org 4487007Snate@binkert.org// for adding information to the protocol debug trace 4496657Snate@binkert.orgstringstream ${ident}_transitionComment; 4509801Snilay@cs.wisc.edu 4519801Snilay@cs.wisc.edu#ifndef NDEBUG 4526657Snate@binkert.org#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str) 4539801Snilay@cs.wisc.edu#else 4549801Snilay@cs.wisc.edu#define APPEND_TRANSITION_COMMENT(str) do {} while (0) 4559801Snilay@cs.wisc.edu#endif 4567007Snate@binkert.org 4576657Snate@binkert.org/** \\brief constructor */ 4586877Ssteve.reinhardt@amd.com$c_ident::$c_ident(const Params *p) 4596877Ssteve.reinhardt@amd.com : AbstractController(p) 4606657Snate@binkert.org{ 46110078Snilay@cs.wisc.edu m_machineID.type = MachineType_${ident}; 46210078Snilay@cs.wisc.edu m_machineID.num = m_version; 4636657Snate@binkert.org''') 4649996Snilay@cs.wisc.edu num_in_ports = len(self.in_ports) 4659996Snilay@cs.wisc.edu code(' m_in_ports = $num_in_ports;') 4666657Snate@binkert.org code.indent() 4676882SBrad.Beckmann@amd.com 4686882SBrad.Beckmann@amd.com # 4696882SBrad.Beckmann@amd.com # After initializing the universal machine parameters, initialize the 4706882SBrad.Beckmann@amd.com # this machines config parameters. Also detemine if these configuration 4716882SBrad.Beckmann@amd.com # params include a sequencer. This information will be used later for 4726882SBrad.Beckmann@amd.com # contecting the sequencer back to the L1 cache controller. 4736882SBrad.Beckmann@amd.com # 4748189SLisa.Hsu@amd.com contains_dma_sequencer = False 4758189SLisa.Hsu@amd.com sequencers = [] 4766877Ssteve.reinhardt@amd.com for param in self.config_parameters: 4778189SLisa.Hsu@amd.com if param.name == "dma_sequencer": 4788189SLisa.Hsu@amd.com contains_dma_sequencer = True 4798189SLisa.Hsu@amd.com elif re.compile("sequencer").search(param.name): 4808189SLisa.Hsu@amd.com sequencers.append(param.name) 4816882SBrad.Beckmann@amd.com if param.pointer: 4826882SBrad.Beckmann@amd.com code('m_${{param.name}}_ptr = p->${{param.name}};') 4836882SBrad.Beckmann@amd.com else: 4846882SBrad.Beckmann@amd.com code('m_${{param.name}} = p->${{param.name}};') 4856882SBrad.Beckmann@amd.com 4866882SBrad.Beckmann@amd.com # 4876882SBrad.Beckmann@amd.com # For the l1 cache controller, add the special atomic support which 4886882SBrad.Beckmann@amd.com # includes passing the sequencer a pointer to the controller. 4896882SBrad.Beckmann@amd.com # 4909597Snilay@cs.wisc.edu for seq in sequencers: 4919597Snilay@cs.wisc.edu code(''' 4928938SLisa.Hsu@amd.comm_${{seq}}_ptr->setController(this); 4938938SLisa.Hsu@amd.com ''') 4948938SLisa.Hsu@amd.com 4956888SBrad.Beckmann@amd.com # 4966888SBrad.Beckmann@amd.com # For the DMA controller, pass the sequencer a pointer to the 4976888SBrad.Beckmann@amd.com # controller. 4986888SBrad.Beckmann@amd.com # 4996888SBrad.Beckmann@amd.com if self.ident == "DMA": 5008189SLisa.Hsu@amd.com if not contains_dma_sequencer: 5016888SBrad.Beckmann@amd.com self.error("The DMA controller must include the sequencer " \ 5026888SBrad.Beckmann@amd.com "configuration parameter") 5036657Snate@binkert.org 5046888SBrad.Beckmann@amd.com code(''' 5056888SBrad.Beckmann@amd.comm_dma_sequencer_ptr->setController(this); 5066888SBrad.Beckmann@amd.com''') 5076888SBrad.Beckmann@amd.com 5086657Snate@binkert.org code('m_num_controllers++;') 5096657Snate@binkert.org for var in self.objects: 5106657Snate@binkert.org if var.ident.find("mandatoryQueue") >= 0: 5119508Snilay@cs.wisc.edu code(''' 5129508Snilay@cs.wisc.edum_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}(); 5139508Snilay@cs.wisc.edum_${{var.c_ident}}_ptr->setReceiver(this); 5149508Snilay@cs.wisc.edu''') 5159595Snilay@cs.wisc.edu else: 5169595Snilay@cs.wisc.edu if "network" in var and "physical_network" in var and \ 5179595Snilay@cs.wisc.edu var["network"] == "To": 5189595Snilay@cs.wisc.edu has_peer = True 5199595Snilay@cs.wisc.edu code(''' 5209595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}(); 5219595Snilay@cs.wisc.edupeerQueueMap[${{var["physical_network"]}}] = m_${{var.c_ident}}_ptr; 5229595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr->setSender(this); 5239595Snilay@cs.wisc.edu''') 5246657Snate@binkert.org 5259595Snilay@cs.wisc.edu code(''' 5269595Snilay@cs.wisc.eduif (p->peer != NULL) 5279595Snilay@cs.wisc.edu connectWithPeer(p->peer); 5289745Snilay@cs.wisc.edu 5299745Snilay@cs.wisc.edufor (int state = 0; state < ${ident}_State_NUM; state++) { 5309745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 5319745Snilay@cs.wisc.edu m_possible[state][event] = false; 5329745Snilay@cs.wisc.edu m_counters[state][event] = 0; 5339745Snilay@cs.wisc.edu } 5349745Snilay@cs.wisc.edu} 5359745Snilay@cs.wisc.edufor (int event = 0; event < ${ident}_Event_NUM; event++) { 5369745Snilay@cs.wisc.edu m_event_counters[event] = 0; 5379745Snilay@cs.wisc.edu} 5389595Snilay@cs.wisc.edu''') 5396657Snate@binkert.org code.dedent() 5406657Snate@binkert.org code(''' 5416657Snate@binkert.org} 5426657Snate@binkert.org 5437007Snate@binkert.orgvoid 5447007Snate@binkert.org$c_ident::init() 5456657Snate@binkert.org{ 5469745Snilay@cs.wisc.edu MachineType machine_type = string_to_MachineType("${{var.machine.ident}}"); 54710008Snilay@cs.wisc.edu int base M5_VAR_USED = MachineType_base_number(machine_type); 5487007Snate@binkert.org 5497007Snate@binkert.org // initialize objects 5507007Snate@binkert.org 5516657Snate@binkert.org''') 5526657Snate@binkert.org 5536657Snate@binkert.org code.indent() 5546657Snate@binkert.org for var in self.objects: 5556657Snate@binkert.org vtype = var.type 5566657Snate@binkert.org vid = "m_%s_ptr" % var.c_ident 5576657Snate@binkert.org if "network" not in var: 5586657Snate@binkert.org # Not a network port object 5596657Snate@binkert.org if "primitive" in vtype: 5606657Snate@binkert.org code('$vid = new ${{vtype.c_ident}};') 5616657Snate@binkert.org if "default" in var: 5626657Snate@binkert.org code('(*$vid) = ${{var["default"]}};') 5636657Snate@binkert.org else: 5646657Snate@binkert.org # Normal Object 5659595Snilay@cs.wisc.edu if var.ident.find("mandatoryQueue") < 0: 5669273Snilay@cs.wisc.edu th = var.get("template", "") 5676657Snate@binkert.org expr = "%s = new %s%s" % (vid, vtype.c_ident, th) 5686657Snate@binkert.org args = "" 5696657Snate@binkert.org if "non_obj" not in vtype and not vtype.isEnumeration: 5709364Snilay@cs.wisc.edu args = var.get("constructor", "") 5717007Snate@binkert.org code('$expr($args);') 5726657Snate@binkert.org 5736657Snate@binkert.org code('assert($vid != NULL);') 5746657Snate@binkert.org 5756657Snate@binkert.org if "default" in var: 5767007Snate@binkert.org code('*$vid = ${{var["default"]}}; // Object default') 5776657Snate@binkert.org elif "default" in vtype: 5787007Snate@binkert.org comment = "Type %s default" % vtype.ident 5797007Snate@binkert.org code('*$vid = ${{vtype["default"]}}; // $comment') 5806657Snate@binkert.org 5816657Snate@binkert.org # Set ordering 5829508Snilay@cs.wisc.edu if "ordered" in var: 5836657Snate@binkert.org # A buffer 5846657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 5856657Snate@binkert.org 5866657Snate@binkert.org # Set randomization 5876657Snate@binkert.org if "random" in var: 5886657Snate@binkert.org # A buffer 5896657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}});') 5906657Snate@binkert.org 5916657Snate@binkert.org # Set Priority 5929508Snilay@cs.wisc.edu if vtype.isBuffer and "rank" in var: 5936657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}});') 5947566SBrad.Beckmann@amd.com 5959508Snilay@cs.wisc.edu # Set sender and receiver for trigger queue 5969508Snilay@cs.wisc.edu if var.ident.find("triggerQueue") >= 0: 5979508Snilay@cs.wisc.edu code('$vid->setSender(this);') 5989508Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 5999508Snilay@cs.wisc.edu elif vtype.c_ident == "TimerTable": 6009508Snilay@cs.wisc.edu code('$vid->setClockObj(this);') 6019604Snilay@cs.wisc.edu elif var.ident.find("optionalQueue") >= 0: 6029604Snilay@cs.wisc.edu code('$vid->setSender(this);') 6039604Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 6049508Snilay@cs.wisc.edu 6056657Snate@binkert.org else: 6066657Snate@binkert.org # Network port object 6076657Snate@binkert.org network = var["network"] 6086657Snate@binkert.org ordered = var["ordered"] 6096657Snate@binkert.org 6109595Snilay@cs.wisc.edu if "virtual_network" in var: 6119595Snilay@cs.wisc.edu vnet = var["virtual_network"] 6129595Snilay@cs.wisc.edu vnet_type = var["vnet_type"] 6139595Snilay@cs.wisc.edu 6149595Snilay@cs.wisc.edu assert var.machine is not None 6159595Snilay@cs.wisc.edu code(''' 6168308Stushar@csail.mit.edu$vid = m_net_ptr->get${network}NetQueue(m_version + base, $ordered, $vnet, "$vnet_type"); 6179595Snilay@cs.wisc.eduassert($vid != NULL); 6186657Snate@binkert.org''') 6196657Snate@binkert.org 6209595Snilay@cs.wisc.edu # Set the end 6219595Snilay@cs.wisc.edu if network == "To": 6229595Snilay@cs.wisc.edu code('$vid->setSender(this);') 6239595Snilay@cs.wisc.edu else: 6249595Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 6259508Snilay@cs.wisc.edu 6266657Snate@binkert.org # Set ordering 6276657Snate@binkert.org if "ordered" in var: 6286657Snate@binkert.org # A buffer 6296657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 6306657Snate@binkert.org 6316657Snate@binkert.org # Set randomization 6326657Snate@binkert.org if "random" in var: 6336657Snate@binkert.org # A buffer 6348187SLisa.Hsu@amd.com code('$vid->setRandomization(${{var["random"]}});') 6356657Snate@binkert.org 6366657Snate@binkert.org # Set Priority 6376657Snate@binkert.org if "rank" in var: 6386657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}})') 6396657Snate@binkert.org 6406657Snate@binkert.org # Set buffer size 6416657Snate@binkert.org if vtype.isBuffer: 6426657Snate@binkert.org code(''' 6436657Snate@binkert.orgif (m_buffer_size > 0) { 6447454Snate@binkert.org $vid->resize(m_buffer_size); 6456657Snate@binkert.org} 6466657Snate@binkert.org''') 6476657Snate@binkert.org 6486657Snate@binkert.org # set description (may be overriden later by port def) 6497007Snate@binkert.org code(''' 6507056Snate@binkert.org$vid->setDescription("[Version " + to_string(m_version) + ", ${ident}, name=${{var.c_ident}}]"); 6517007Snate@binkert.org 6527007Snate@binkert.org''') 6536657Snate@binkert.org 6547566SBrad.Beckmann@amd.com if vtype.isBuffer: 6557566SBrad.Beckmann@amd.com if "recycle_latency" in var: 6569499Snilay@cs.wisc.edu code('$vid->setRecycleLatency( ' \ 6579499Snilay@cs.wisc.edu 'Cycles(${{var["recycle_latency"]}}));') 6587566SBrad.Beckmann@amd.com else: 6597566SBrad.Beckmann@amd.com code('$vid->setRecycleLatency(m_recycle_latency);') 6607566SBrad.Beckmann@amd.com 6619366Snilay@cs.wisc.edu # Set the prefetchers 6629366Snilay@cs.wisc.edu code() 6639366Snilay@cs.wisc.edu for prefetcher in self.prefetchers: 6649366Snilay@cs.wisc.edu code('${{prefetcher.code}}.setController(this);') 6657566SBrad.Beckmann@amd.com 6667672Snate@binkert.org code() 6676657Snate@binkert.org for port in self.in_ports: 6689465Snilay@cs.wisc.edu # Set the queue consumers 6696657Snate@binkert.org code('${{port.code}}.setConsumer(this);') 6709465Snilay@cs.wisc.edu # Set the queue descriptions 6717056Snate@binkert.org code('${{port.code}}.setDescription("[Version " + to_string(m_version) + ", $ident, $port]");') 6726657Snate@binkert.org 6736657Snate@binkert.org # Initialize the transition profiling 6747672Snate@binkert.org code() 6756657Snate@binkert.org for trans in self.transitions: 6766657Snate@binkert.org # Figure out if we stall 6776657Snate@binkert.org stall = False 6786657Snate@binkert.org for action in trans.actions: 6796657Snate@binkert.org if action.ident == "z_stall": 6806657Snate@binkert.org stall = True 6816657Snate@binkert.org 6826657Snate@binkert.org # Only possible if it is not a 'z' case 6836657Snate@binkert.org if not stall: 6846657Snate@binkert.org state = "%s_State_%s" % (self.ident, trans.state.ident) 6856657Snate@binkert.org event = "%s_Event_%s" % (self.ident, trans.event.ident) 6869745Snilay@cs.wisc.edu code('possibleTransition($state, $event);') 6876657Snate@binkert.org 6886657Snate@binkert.org code.dedent() 6899496Snilay@cs.wisc.edu code(''' 6909496Snilay@cs.wisc.edu AbstractController::init(); 69110012Snilay@cs.wisc.edu resetStats(); 6929496Snilay@cs.wisc.edu} 6939496Snilay@cs.wisc.edu''') 6946657Snate@binkert.org 6956657Snate@binkert.org has_mandatory_q = False 6966657Snate@binkert.org for port in self.in_ports: 6976657Snate@binkert.org if port.code.find("mandatoryQueue_ptr") >= 0: 6986657Snate@binkert.org has_mandatory_q = True 6996657Snate@binkert.org 7006657Snate@binkert.org if has_mandatory_q: 7016657Snate@binkert.org mq_ident = "m_%s_mandatoryQueue_ptr" % self.ident 7026657Snate@binkert.org else: 7036657Snate@binkert.org mq_ident = "NULL" 7046657Snate@binkert.org 7058683Snilay@cs.wisc.edu seq_ident = "NULL" 7068683Snilay@cs.wisc.edu for param in self.config_parameters: 7078683Snilay@cs.wisc.edu if param.name == "sequencer": 7088683Snilay@cs.wisc.edu assert(param.pointer) 7098683Snilay@cs.wisc.edu seq_ident = "m_%s_ptr" % param.name 7108683Snilay@cs.wisc.edu 7116657Snate@binkert.org code(''' 7129745Snilay@cs.wisc.edu 7139745Snilay@cs.wisc.eduvoid 7149745Snilay@cs.wisc.edu$c_ident::regStats() 7159745Snilay@cs.wisc.edu{ 71610012Snilay@cs.wisc.edu AbstractController::regStats(); 71710012Snilay@cs.wisc.edu 7189745Snilay@cs.wisc.edu if (m_version == 0) { 7199745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7209745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7219745Snilay@cs.wisc.edu Stats::Vector *t = new Stats::Vector(); 7229745Snilay@cs.wisc.edu t->init(m_num_controllers); 72310012Snilay@cs.wisc.edu t->name(g_system_ptr->name() + ".${c_ident}." + 72410012Snilay@cs.wisc.edu ${ident}_Event_to_string(event)); 7259745Snilay@cs.wisc.edu t->flags(Stats::pdf | Stats::total | Stats::oneline | 7269745Snilay@cs.wisc.edu Stats::nozero); 7279745Snilay@cs.wisc.edu 7289745Snilay@cs.wisc.edu eventVec.push_back(t); 7299745Snilay@cs.wisc.edu } 7309745Snilay@cs.wisc.edu 7319745Snilay@cs.wisc.edu for (${ident}_State state = ${ident}_State_FIRST; 7329745Snilay@cs.wisc.edu state < ${ident}_State_NUM; ++state) { 7339745Snilay@cs.wisc.edu 7349745Snilay@cs.wisc.edu transVec.push_back(std::vector<Stats::Vector *>()); 7359745Snilay@cs.wisc.edu 7369745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7379745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7389745Snilay@cs.wisc.edu 7399745Snilay@cs.wisc.edu Stats::Vector *t = new Stats::Vector(); 7409745Snilay@cs.wisc.edu t->init(m_num_controllers); 74110012Snilay@cs.wisc.edu t->name(g_system_ptr->name() + ".${c_ident}." + 74210012Snilay@cs.wisc.edu ${ident}_State_to_string(state) + 7439745Snilay@cs.wisc.edu "." + ${ident}_Event_to_string(event)); 7449745Snilay@cs.wisc.edu 7459745Snilay@cs.wisc.edu t->flags(Stats::pdf | Stats::total | Stats::oneline | 7469745Snilay@cs.wisc.edu Stats::nozero); 7479745Snilay@cs.wisc.edu transVec[state].push_back(t); 7489745Snilay@cs.wisc.edu } 7499745Snilay@cs.wisc.edu } 7509745Snilay@cs.wisc.edu } 7519745Snilay@cs.wisc.edu} 7529745Snilay@cs.wisc.edu 7539745Snilay@cs.wisc.eduvoid 7549745Snilay@cs.wisc.edu$c_ident::collateStats() 7559745Snilay@cs.wisc.edu{ 7569745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7579745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7589745Snilay@cs.wisc.edu for (unsigned int i = 0; i < m_num_controllers; ++i) { 7599745Snilay@cs.wisc.edu std::map<uint32_t, AbstractController *>::iterator it = 7609745Snilay@cs.wisc.edu g_abs_controls[MachineType_${ident}].find(i); 7619745Snilay@cs.wisc.edu assert(it != g_abs_controls[MachineType_${ident}].end()); 7629745Snilay@cs.wisc.edu (*eventVec[event])[i] = 7639745Snilay@cs.wisc.edu (($c_ident *)(*it).second)->getEventCount(event); 7649745Snilay@cs.wisc.edu } 7659745Snilay@cs.wisc.edu } 7669745Snilay@cs.wisc.edu 7679745Snilay@cs.wisc.edu for (${ident}_State state = ${ident}_State_FIRST; 7689745Snilay@cs.wisc.edu state < ${ident}_State_NUM; ++state) { 7699745Snilay@cs.wisc.edu 7709745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7719745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7729745Snilay@cs.wisc.edu 7739745Snilay@cs.wisc.edu for (unsigned int i = 0; i < m_num_controllers; ++i) { 7749745Snilay@cs.wisc.edu std::map<uint32_t, AbstractController *>::iterator it = 7759745Snilay@cs.wisc.edu g_abs_controls[MachineType_${ident}].find(i); 7769745Snilay@cs.wisc.edu assert(it != g_abs_controls[MachineType_${ident}].end()); 7779745Snilay@cs.wisc.edu (*transVec[state][event])[i] = 7789745Snilay@cs.wisc.edu (($c_ident *)(*it).second)->getTransitionCount(state, event); 7799745Snilay@cs.wisc.edu } 7809745Snilay@cs.wisc.edu } 7819745Snilay@cs.wisc.edu } 7829745Snilay@cs.wisc.edu} 7839745Snilay@cs.wisc.edu 7849745Snilay@cs.wisc.eduvoid 7859745Snilay@cs.wisc.edu$c_ident::countTransition(${ident}_State state, ${ident}_Event event) 7869745Snilay@cs.wisc.edu{ 7879745Snilay@cs.wisc.edu assert(m_possible[state][event]); 7889745Snilay@cs.wisc.edu m_counters[state][event]++; 7899745Snilay@cs.wisc.edu m_event_counters[event]++; 7909745Snilay@cs.wisc.edu} 7919745Snilay@cs.wisc.eduvoid 7929745Snilay@cs.wisc.edu$c_ident::possibleTransition(${ident}_State state, 7939745Snilay@cs.wisc.edu ${ident}_Event event) 7949745Snilay@cs.wisc.edu{ 7959745Snilay@cs.wisc.edu m_possible[state][event] = true; 7969745Snilay@cs.wisc.edu} 7979745Snilay@cs.wisc.edu 7989745Snilay@cs.wisc.eduuint64 7999745Snilay@cs.wisc.edu$c_ident::getEventCount(${ident}_Event event) 8009745Snilay@cs.wisc.edu{ 8019745Snilay@cs.wisc.edu return m_event_counters[event]; 8029745Snilay@cs.wisc.edu} 8039745Snilay@cs.wisc.edu 8049745Snilay@cs.wisc.edubool 8059745Snilay@cs.wisc.edu$c_ident::isPossible(${ident}_State state, ${ident}_Event event) 8069745Snilay@cs.wisc.edu{ 8079745Snilay@cs.wisc.edu return m_possible[state][event]; 8089745Snilay@cs.wisc.edu} 8099745Snilay@cs.wisc.edu 8109745Snilay@cs.wisc.eduuint64 8119745Snilay@cs.wisc.edu$c_ident::getTransitionCount(${ident}_State state, 8129745Snilay@cs.wisc.edu ${ident}_Event event) 8139745Snilay@cs.wisc.edu{ 8149745Snilay@cs.wisc.edu return m_counters[state][event]; 8159745Snilay@cs.wisc.edu} 8169745Snilay@cs.wisc.edu 8177007Snate@binkert.orgint 8187007Snate@binkert.org$c_ident::getNumControllers() 8197007Snate@binkert.org{ 8206657Snate@binkert.org return m_num_controllers; 8216657Snate@binkert.org} 8226657Snate@binkert.org 8237007Snate@binkert.orgMessageBuffer* 8247007Snate@binkert.org$c_ident::getMandatoryQueue() const 8257007Snate@binkert.org{ 8266657Snate@binkert.org return $mq_ident; 8276657Snate@binkert.org} 8286657Snate@binkert.org 8298683Snilay@cs.wisc.eduSequencer* 8308683Snilay@cs.wisc.edu$c_ident::getSequencer() const 8318683Snilay@cs.wisc.edu{ 8328683Snilay@cs.wisc.edu return $seq_ident; 8338683Snilay@cs.wisc.edu} 8348683Snilay@cs.wisc.edu 8357007Snate@binkert.orgconst string 8367007Snate@binkert.org$c_ident::toString() const 8377007Snate@binkert.org{ 8386657Snate@binkert.org return "$c_ident"; 8396657Snate@binkert.org} 8406657Snate@binkert.org 8417007Snate@binkert.orgvoid 8427007Snate@binkert.org$c_ident::print(ostream& out) const 8437007Snate@binkert.org{ 8447007Snate@binkert.org out << "[$c_ident " << m_version << "]"; 8457007Snate@binkert.org} 8466657Snate@binkert.org 84710012Snilay@cs.wisc.eduvoid $c_ident::resetStats() 8489745Snilay@cs.wisc.edu{ 8499745Snilay@cs.wisc.edu for (int state = 0; state < ${ident}_State_NUM; state++) { 8509745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 8519745Snilay@cs.wisc.edu m_counters[state][event] = 0; 8529745Snilay@cs.wisc.edu } 8539745Snilay@cs.wisc.edu } 8546902SBrad.Beckmann@amd.com 8559745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 8569745Snilay@cs.wisc.edu m_event_counters[event] = 0; 8579745Snilay@cs.wisc.edu } 8589745Snilay@cs.wisc.edu 85910012Snilay@cs.wisc.edu AbstractController::resetStats(); 8606902SBrad.Beckmann@amd.com} 8617839Snilay@cs.wisc.edu''') 8627839Snilay@cs.wisc.edu 8637839Snilay@cs.wisc.edu if self.EntryType != None: 8647839Snilay@cs.wisc.edu code(''' 8657839Snilay@cs.wisc.edu 8667839Snilay@cs.wisc.edu// Set and Reset for cache_entry variable 8677839Snilay@cs.wisc.eduvoid 8687839Snilay@cs.wisc.edu$c_ident::set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry) 8697839Snilay@cs.wisc.edu{ 8707839Snilay@cs.wisc.edu m_cache_entry_ptr = (${{self.EntryType.c_ident}}*)m_new_cache_entry; 8717839Snilay@cs.wisc.edu} 8727839Snilay@cs.wisc.edu 8737839Snilay@cs.wisc.eduvoid 8747839Snilay@cs.wisc.edu$c_ident::unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr) 8757839Snilay@cs.wisc.edu{ 8767839Snilay@cs.wisc.edu m_cache_entry_ptr = 0; 8777839Snilay@cs.wisc.edu} 8787839Snilay@cs.wisc.edu''') 8797839Snilay@cs.wisc.edu 8807839Snilay@cs.wisc.edu if self.TBEType != None: 8817839Snilay@cs.wisc.edu code(''' 8827839Snilay@cs.wisc.edu 8837839Snilay@cs.wisc.edu// Set and Reset for tbe variable 8847839Snilay@cs.wisc.eduvoid 8857839Snilay@cs.wisc.edu$c_ident::set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.TBEType.c_ident}}* m_new_tbe) 8867839Snilay@cs.wisc.edu{ 8877839Snilay@cs.wisc.edu m_tbe_ptr = m_new_tbe; 8887839Snilay@cs.wisc.edu} 8897839Snilay@cs.wisc.edu 8907839Snilay@cs.wisc.eduvoid 8917839Snilay@cs.wisc.edu$c_ident::unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr) 8927839Snilay@cs.wisc.edu{ 8937839Snilay@cs.wisc.edu m_tbe_ptr = NULL; 8947839Snilay@cs.wisc.edu} 8957839Snilay@cs.wisc.edu''') 8967839Snilay@cs.wisc.edu 8977839Snilay@cs.wisc.edu code(''' 8986902SBrad.Beckmann@amd.com 8998683Snilay@cs.wisc.eduvoid 9008683Snilay@cs.wisc.edu$c_ident::recordCacheTrace(int cntrl, CacheRecorder* tr) 9018683Snilay@cs.wisc.edu{ 9028683Snilay@cs.wisc.edu''') 9038683Snilay@cs.wisc.edu # 9048683Snilay@cs.wisc.edu # Record cache contents for all associated caches. 9058683Snilay@cs.wisc.edu # 9068683Snilay@cs.wisc.edu code.indent() 9078683Snilay@cs.wisc.edu for param in self.config_parameters: 9088683Snilay@cs.wisc.edu if param.type_ast.type.ident == "CacheMemory": 9098683Snilay@cs.wisc.edu assert(param.pointer) 9108683Snilay@cs.wisc.edu code('m_${{param.ident}}_ptr->recordCacheContents(cntrl, tr);') 9118683Snilay@cs.wisc.edu 9128683Snilay@cs.wisc.edu code.dedent() 9138683Snilay@cs.wisc.edu code(''' 9148683Snilay@cs.wisc.edu} 9158683Snilay@cs.wisc.edu 9166657Snate@binkert.org// Actions 9176657Snate@binkert.org''') 9187839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 9197839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9207839Snilay@cs.wisc.edu if "c_code" not in action: 9217839Snilay@cs.wisc.edu continue 9226657Snate@binkert.org 9237839Snilay@cs.wisc.edu code(''' 9247839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9257839Snilay@cs.wisc.eduvoid 9267839Snilay@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) 9277839Snilay@cs.wisc.edu{ 9288055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9297839Snilay@cs.wisc.edu ${{action["c_code"]}} 9307839Snilay@cs.wisc.edu} 9316657Snate@binkert.org 9327839Snilay@cs.wisc.edu''') 9337839Snilay@cs.wisc.edu elif self.TBEType != None: 9347839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9357839Snilay@cs.wisc.edu if "c_code" not in action: 9367839Snilay@cs.wisc.edu continue 9377839Snilay@cs.wisc.edu 9387839Snilay@cs.wisc.edu code(''' 9397839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9407839Snilay@cs.wisc.eduvoid 9417839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr) 9427839Snilay@cs.wisc.edu{ 9438055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9447839Snilay@cs.wisc.edu ${{action["c_code"]}} 9457839Snilay@cs.wisc.edu} 9467839Snilay@cs.wisc.edu 9477839Snilay@cs.wisc.edu''') 9487839Snilay@cs.wisc.edu elif self.EntryType != None: 9497839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9507839Snilay@cs.wisc.edu if "c_code" not in action: 9517839Snilay@cs.wisc.edu continue 9527839Snilay@cs.wisc.edu 9537839Snilay@cs.wisc.edu code(''' 9547839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9557839Snilay@cs.wisc.eduvoid 9567839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr) 9577839Snilay@cs.wisc.edu{ 9588055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9597839Snilay@cs.wisc.edu ${{action["c_code"]}} 9607839Snilay@cs.wisc.edu} 9617839Snilay@cs.wisc.edu 9627839Snilay@cs.wisc.edu''') 9637839Snilay@cs.wisc.edu else: 9647839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9657839Snilay@cs.wisc.edu if "c_code" not in action: 9667839Snilay@cs.wisc.edu continue 9677839Snilay@cs.wisc.edu 9687839Snilay@cs.wisc.edu code(''' 9696657Snate@binkert.org/** \\brief ${{action.desc}} */ 9707007Snate@binkert.orgvoid 9717007Snate@binkert.org$c_ident::${{action.ident}}(const Address& addr) 9726657Snate@binkert.org{ 9738055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9746657Snate@binkert.org ${{action["c_code"]}} 9756657Snate@binkert.org} 9766657Snate@binkert.org 9776657Snate@binkert.org''') 9788478Snilay@cs.wisc.edu for func in self.functions: 9798478Snilay@cs.wisc.edu code(func.generateCode()) 9808478Snilay@cs.wisc.edu 9819302Snilay@cs.wisc.edu # Function for functional reads from messages buffered in the controller 9829302Snilay@cs.wisc.edu code(''' 9839302Snilay@cs.wisc.edubool 9849302Snilay@cs.wisc.edu$c_ident::functionalReadBuffers(PacketPtr& pkt) 9859302Snilay@cs.wisc.edu{ 9869302Snilay@cs.wisc.edu''') 9879302Snilay@cs.wisc.edu for var in self.objects: 9889302Snilay@cs.wisc.edu vtype = var.type 9899302Snilay@cs.wisc.edu if vtype.isBuffer: 9909302Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.c_ident 9919302Snilay@cs.wisc.edu code('if ($vid->functionalRead(pkt)) { return true; }') 9929302Snilay@cs.wisc.edu code(''' 9939302Snilay@cs.wisc.edu return false; 9949302Snilay@cs.wisc.edu} 9959302Snilay@cs.wisc.edu''') 9969302Snilay@cs.wisc.edu 9979302Snilay@cs.wisc.edu # Function for functional writes to messages buffered in the controller 9989302Snilay@cs.wisc.edu code(''' 9999302Snilay@cs.wisc.eduuint32_t 10009302Snilay@cs.wisc.edu$c_ident::functionalWriteBuffers(PacketPtr& pkt) 10019302Snilay@cs.wisc.edu{ 10029302Snilay@cs.wisc.edu uint32_t num_functional_writes = 0; 10039302Snilay@cs.wisc.edu''') 10049302Snilay@cs.wisc.edu for var in self.objects: 10059302Snilay@cs.wisc.edu vtype = var.type 10069302Snilay@cs.wisc.edu if vtype.isBuffer: 10079302Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.c_ident 10089302Snilay@cs.wisc.edu code('num_functional_writes += $vid->functionalWrite(pkt);') 10099302Snilay@cs.wisc.edu code(''' 10109302Snilay@cs.wisc.edu return num_functional_writes; 10119302Snilay@cs.wisc.edu} 10129302Snilay@cs.wisc.edu''') 10139302Snilay@cs.wisc.edu 10149595Snilay@cs.wisc.edu # Check if this controller has a peer, if yes then write the 10159595Snilay@cs.wisc.edu # function for connecting to the peer. 10169595Snilay@cs.wisc.edu if has_peer: 10179595Snilay@cs.wisc.edu code(''' 10189595Snilay@cs.wisc.edu 10199595Snilay@cs.wisc.eduvoid 10209595Snilay@cs.wisc.edu$c_ident::getQueuesFromPeer(AbstractController *peer) 10219595Snilay@cs.wisc.edu{ 10229595Snilay@cs.wisc.edu''') 10239595Snilay@cs.wisc.edu for var in self.objects: 10249595Snilay@cs.wisc.edu if "network" in var and "physical_network" in var and \ 10259595Snilay@cs.wisc.edu var["network"] == "From": 10269595Snilay@cs.wisc.edu code(''' 10279595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr = peer->getPeerQueue(${{var["physical_network"]}}); 10289595Snilay@cs.wisc.eduassert(m_${{var.c_ident}}_ptr != NULL); 10299595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr->setReceiver(this); 10309595Snilay@cs.wisc.edu 10319595Snilay@cs.wisc.edu''') 10329595Snilay@cs.wisc.edu code('}') 10339595Snilay@cs.wisc.edu 10346657Snate@binkert.org code.write(path, "%s.cc" % c_ident) 10356657Snate@binkert.org 10369219Spower.jg@gmail.com def printCWakeup(self, path, includes): 10376657Snate@binkert.org '''Output the wakeup loop for the events''' 10386657Snate@binkert.org 10396999Snate@binkert.org code = self.symtab.codeFormatter() 10406657Snate@binkert.org ident = self.ident 10416657Snate@binkert.org 10429104Shestness@cs.utexas.edu outputRequest_types = True 10439104Shestness@cs.utexas.edu if len(self.request_types) == 0: 10449104Shestness@cs.utexas.edu outputRequest_types = False 10459104Shestness@cs.utexas.edu 10466657Snate@binkert.org code(''' 10476657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 10486657Snate@binkert.org// ${ident}: ${{self.short}} 10496657Snate@binkert.org 10508946Sandreas.hansson@arm.com#include <sys/types.h> 10518946Sandreas.hansson@arm.com#include <unistd.h> 10528946Sandreas.hansson@arm.com 10537832Snate@binkert.org#include <cassert> 10547832Snate@binkert.org 10557007Snate@binkert.org#include "base/misc.hh" 10568232Snate@binkert.org#include "debug/RubySlicc.hh" 10578229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 10588229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 10598229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 10609104Shestness@cs.utexas.edu''') 10619104Shestness@cs.utexas.edu 10629104Shestness@cs.utexas.edu if outputRequest_types: 10639104Shestness@cs.utexas.edu code('''#include "mem/protocol/${ident}_RequestType.hh"''') 10649104Shestness@cs.utexas.edu 10659104Shestness@cs.utexas.edu code(''' 10668229Snate@binkert.org#include "mem/protocol/Types.hh" 10676657Snate@binkert.org#include "mem/ruby/common/Global.hh" 10686657Snate@binkert.org#include "mem/ruby/system/System.hh" 10699219Spower.jg@gmail.com''') 10709219Spower.jg@gmail.com 10719219Spower.jg@gmail.com 10729219Spower.jg@gmail.com for include_path in includes: 10739219Spower.jg@gmail.com code('#include "${{include_path}}"') 10749219Spower.jg@gmail.com 10759219Spower.jg@gmail.com code(''' 10766657Snate@binkert.org 10777055Snate@binkert.orgusing namespace std; 10787055Snate@binkert.org 10797007Snate@binkert.orgvoid 10807007Snate@binkert.org${ident}_Controller::wakeup() 10816657Snate@binkert.org{ 10826657Snate@binkert.org int counter = 0; 10836657Snate@binkert.org while (true) { 10846657Snate@binkert.org // Some cases will put us into an infinite loop without this limit 10856657Snate@binkert.org assert(counter <= m_transitions_per_cycle); 10866657Snate@binkert.org if (counter == m_transitions_per_cycle) { 10877007Snate@binkert.org // Count how often we are fully utilized 10889496Snilay@cs.wisc.edu m_fully_busy_cycles++; 10897007Snate@binkert.org 10907007Snate@binkert.org // Wakeup in another cycle and try again 10919499Snilay@cs.wisc.edu scheduleEvent(Cycles(1)); 10926657Snate@binkert.org break; 10936657Snate@binkert.org } 10946657Snate@binkert.org''') 10956657Snate@binkert.org 10966657Snate@binkert.org code.indent() 10976657Snate@binkert.org code.indent() 10986657Snate@binkert.org 10996657Snate@binkert.org # InPorts 11006657Snate@binkert.org # 11016657Snate@binkert.org for port in self.in_ports: 11026657Snate@binkert.org code.indent() 11036657Snate@binkert.org code('// ${ident}InPort $port') 11047567SBrad.Beckmann@amd.com if port.pairs.has_key("rank"): 11059996Snilay@cs.wisc.edu code('m_cur_in_port = ${{port.pairs["rank"]}};') 11067567SBrad.Beckmann@amd.com else: 11079996Snilay@cs.wisc.edu code('m_cur_in_port = 0;') 11086657Snate@binkert.org code('${{port["c_code_in_port"]}}') 11096657Snate@binkert.org code.dedent() 11106657Snate@binkert.org 11116657Snate@binkert.org code('') 11126657Snate@binkert.org 11136657Snate@binkert.org code.dedent() 11146657Snate@binkert.org code.dedent() 11156657Snate@binkert.org code(''' 11166657Snate@binkert.org break; // If we got this far, we have nothing left todo 11176657Snate@binkert.org } 11186657Snate@binkert.org} 11196657Snate@binkert.org''') 11206657Snate@binkert.org 11216657Snate@binkert.org code.write(path, "%s_Wakeup.cc" % self.ident) 11226657Snate@binkert.org 11236657Snate@binkert.org def printCSwitch(self, path): 11246657Snate@binkert.org '''Output switch statement for transition table''' 11256657Snate@binkert.org 11266999Snate@binkert.org code = self.symtab.codeFormatter() 11276657Snate@binkert.org ident = self.ident 11286657Snate@binkert.org 11296657Snate@binkert.org code(''' 11306657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 11316657Snate@binkert.org// ${ident}: ${{self.short}} 11326657Snate@binkert.org 11337832Snate@binkert.org#include <cassert> 11347832Snate@binkert.org 11357805Snilay@cs.wisc.edu#include "base/misc.hh" 11367832Snate@binkert.org#include "base/trace.hh" 11378232Snate@binkert.org#include "debug/ProtocolTrace.hh" 11388232Snate@binkert.org#include "debug/RubyGenerated.hh" 11398229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 11408229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 11418229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 11428229Snate@binkert.org#include "mem/protocol/Types.hh" 11436657Snate@binkert.org#include "mem/ruby/common/Global.hh" 11446657Snate@binkert.org#include "mem/ruby/system/System.hh" 11456657Snate@binkert.org 11466657Snate@binkert.org#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event)) 11476657Snate@binkert.org 11486657Snate@binkert.org#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str()) 11496657Snate@binkert.org#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str("")) 11506657Snate@binkert.org 11517007Snate@binkert.orgTransitionResult 11527007Snate@binkert.org${ident}_Controller::doTransition(${ident}_Event event, 11537839Snilay@cs.wisc.edu''') 11547839Snilay@cs.wisc.edu if self.EntryType != None: 11557839Snilay@cs.wisc.edu code(''' 11567839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}* m_cache_entry_ptr, 11577839Snilay@cs.wisc.edu''') 11587839Snilay@cs.wisc.edu if self.TBEType != None: 11597839Snilay@cs.wisc.edu code(''' 11607839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}* m_tbe_ptr, 11617839Snilay@cs.wisc.edu''') 11627839Snilay@cs.wisc.edu code(''' 116310010Snilay@cs.wisc.edu const Address addr) 11646657Snate@binkert.org{ 11657839Snilay@cs.wisc.edu''') 11667839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11678337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, m_cache_entry_ptr, addr);') 11687839Snilay@cs.wisc.edu elif self.TBEType != None: 11698337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, addr);') 11707839Snilay@cs.wisc.edu elif self.EntryType != None: 11718337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_cache_entry_ptr, addr);') 11727839Snilay@cs.wisc.edu else: 11738337Snilay@cs.wisc.edu code('${ident}_State state = getState(addr);') 11747839Snilay@cs.wisc.edu 11757839Snilay@cs.wisc.edu code(''' 11766657Snate@binkert.org ${ident}_State next_state = state; 11776657Snate@binkert.org 11787780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "%s, Time: %lld, state: %s, event: %s, addr: %s\\n", 11799465Snilay@cs.wisc.edu *this, curCycle(), ${ident}_State_to_string(state), 11809171Snilay@cs.wisc.edu ${ident}_Event_to_string(event), addr); 11816657Snate@binkert.org 11827007Snate@binkert.org TransitionResult result = 11837839Snilay@cs.wisc.edu''') 11847839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11857839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, m_cache_entry_ptr, addr);') 11867839Snilay@cs.wisc.edu elif self.TBEType != None: 11877839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, addr);') 11887839Snilay@cs.wisc.edu elif self.EntryType != None: 11897839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_cache_entry_ptr, addr);') 11907839Snilay@cs.wisc.edu else: 11917839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, addr);') 11926657Snate@binkert.org 11937839Snilay@cs.wisc.edu code(''' 11946657Snate@binkert.org if (result == TransitionResult_Valid) { 11957780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "next_state: %s\\n", 11967780Snilay@cs.wisc.edu ${ident}_State_to_string(next_state)); 11979745Snilay@cs.wisc.edu countTransition(state, event); 11988266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15d %3s %10s%20s %6s>%-6s %s %s\\n", 11998266Sksewell@umich.edu curTick(), m_version, "${ident}", 12008266Sksewell@umich.edu ${ident}_Event_to_string(event), 12018266Sksewell@umich.edu ${ident}_State_to_string(state), 12028266Sksewell@umich.edu ${ident}_State_to_string(next_state), 12038266Sksewell@umich.edu addr, GET_TRANSITION_COMMENT()); 12046657Snate@binkert.org 12057832Snate@binkert.org CLEAR_TRANSITION_COMMENT(); 12067839Snilay@cs.wisc.edu''') 12077839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 12088337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, m_cache_entry_ptr, addr, next_state);') 12098341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 12107839Snilay@cs.wisc.edu elif self.TBEType != None: 12118337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, addr, next_state);') 12128341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 12137839Snilay@cs.wisc.edu elif self.EntryType != None: 12148337Snilay@cs.wisc.edu code('setState(m_cache_entry_ptr, addr, next_state);') 12158341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 12167839Snilay@cs.wisc.edu else: 12178337Snilay@cs.wisc.edu code('setState(addr, next_state);') 12188341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 12197839Snilay@cs.wisc.edu 12207839Snilay@cs.wisc.edu code(''' 12216657Snate@binkert.org } else if (result == TransitionResult_ResourceStall) { 12228266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n", 12238266Sksewell@umich.edu curTick(), m_version, "${ident}", 12248266Sksewell@umich.edu ${ident}_Event_to_string(event), 12258266Sksewell@umich.edu ${ident}_State_to_string(state), 12268266Sksewell@umich.edu ${ident}_State_to_string(next_state), 12278266Sksewell@umich.edu addr, "Resource Stall"); 12286657Snate@binkert.org } else if (result == TransitionResult_ProtocolStall) { 12297780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "stalling\\n"); 12308266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n", 12318266Sksewell@umich.edu curTick(), m_version, "${ident}", 12328266Sksewell@umich.edu ${ident}_Event_to_string(event), 12338266Sksewell@umich.edu ${ident}_State_to_string(state), 12348266Sksewell@umich.edu ${ident}_State_to_string(next_state), 12358266Sksewell@umich.edu addr, "Protocol Stall"); 12366657Snate@binkert.org } 12376657Snate@binkert.org 12386657Snate@binkert.org return result; 12396657Snate@binkert.org} 12406657Snate@binkert.org 12417007Snate@binkert.orgTransitionResult 12427007Snate@binkert.org${ident}_Controller::doTransitionWorker(${ident}_Event event, 12437007Snate@binkert.org ${ident}_State state, 12447007Snate@binkert.org ${ident}_State& next_state, 12457839Snilay@cs.wisc.edu''') 12467839Snilay@cs.wisc.edu 12477839Snilay@cs.wisc.edu if self.TBEType != None: 12487839Snilay@cs.wisc.edu code(''' 12497839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}*& m_tbe_ptr, 12507839Snilay@cs.wisc.edu''') 12517839Snilay@cs.wisc.edu if self.EntryType != None: 12527839Snilay@cs.wisc.edu code(''' 12537839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, 12547839Snilay@cs.wisc.edu''') 12557839Snilay@cs.wisc.edu code(''' 12567007Snate@binkert.org const Address& addr) 12576657Snate@binkert.org{ 12586657Snate@binkert.org switch(HASH_FUN(state, event)) { 12596657Snate@binkert.org''') 12606657Snate@binkert.org 12616657Snate@binkert.org # This map will allow suppress generating duplicate code 12626657Snate@binkert.org cases = orderdict() 12636657Snate@binkert.org 12646657Snate@binkert.org for trans in self.transitions: 12656657Snate@binkert.org case_string = "%s_State_%s, %s_Event_%s" % \ 12666657Snate@binkert.org (self.ident, trans.state.ident, self.ident, trans.event.ident) 12676657Snate@binkert.org 12686999Snate@binkert.org case = self.symtab.codeFormatter() 12696657Snate@binkert.org # Only set next_state if it changes 12706657Snate@binkert.org if trans.state != trans.nextState: 12716657Snate@binkert.org ns_ident = trans.nextState.ident 12726657Snate@binkert.org case('next_state = ${ident}_State_${ns_ident};') 12736657Snate@binkert.org 12746657Snate@binkert.org actions = trans.actions 12759104Shestness@cs.utexas.edu request_types = trans.request_types 12766657Snate@binkert.org 12776657Snate@binkert.org # Check for resources 12786657Snate@binkert.org case_sorter = [] 12796657Snate@binkert.org res = trans.resources 12806657Snate@binkert.org for key,val in res.iteritems(): 12816657Snate@binkert.org if key.type.ident != "DNUCAStopTable": 12826657Snate@binkert.org val = ''' 12837007Snate@binkert.orgif (!%s.areNSlotsAvailable(%s)) 12846657Snate@binkert.org return TransitionResult_ResourceStall; 12856657Snate@binkert.org''' % (key.code, val) 12866657Snate@binkert.org case_sorter.append(val) 12876657Snate@binkert.org 12889105SBrad.Beckmann@amd.com # Check all of the request_types for resource constraints 12899105SBrad.Beckmann@amd.com for request_type in request_types: 12909105SBrad.Beckmann@amd.com val = ''' 12919105SBrad.Beckmann@amd.comif (!checkResourceAvailable(%s_RequestType_%s, addr)) { 12929105SBrad.Beckmann@amd.com return TransitionResult_ResourceStall; 12939105SBrad.Beckmann@amd.com} 12949105SBrad.Beckmann@amd.com''' % (self.ident, request_type.ident) 12959105SBrad.Beckmann@amd.com case_sorter.append(val) 12966657Snate@binkert.org 12976657Snate@binkert.org # Emit the code sequences in a sorted order. This makes the 12986657Snate@binkert.org # output deterministic (without this the output order can vary 12996657Snate@binkert.org # since Map's keys() on a vector of pointers is not deterministic 13006657Snate@binkert.org for c in sorted(case_sorter): 13016657Snate@binkert.org case("$c") 13026657Snate@binkert.org 13039104Shestness@cs.utexas.edu # Record access types for this transition 13049104Shestness@cs.utexas.edu for request_type in request_types: 13059104Shestness@cs.utexas.edu case('recordRequestType(${ident}_RequestType_${{request_type.ident}}, addr);') 13069104Shestness@cs.utexas.edu 13076657Snate@binkert.org # Figure out if we stall 13086657Snate@binkert.org stall = False 13096657Snate@binkert.org for action in actions: 13106657Snate@binkert.org if action.ident == "z_stall": 13116657Snate@binkert.org stall = True 13126657Snate@binkert.org break 13136657Snate@binkert.org 13146657Snate@binkert.org if stall: 13156657Snate@binkert.org case('return TransitionResult_ProtocolStall;') 13166657Snate@binkert.org else: 13177839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 13187839Snilay@cs.wisc.edu for action in actions: 13197839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, m_cache_entry_ptr, addr);') 13207839Snilay@cs.wisc.edu elif self.TBEType != None: 13217839Snilay@cs.wisc.edu for action in actions: 13227839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, addr);') 13237839Snilay@cs.wisc.edu elif self.EntryType != None: 13247839Snilay@cs.wisc.edu for action in actions: 13257839Snilay@cs.wisc.edu case('${{action.ident}}(m_cache_entry_ptr, addr);') 13267839Snilay@cs.wisc.edu else: 13277839Snilay@cs.wisc.edu for action in actions: 13287839Snilay@cs.wisc.edu case('${{action.ident}}(addr);') 13296657Snate@binkert.org case('return TransitionResult_Valid;') 13306657Snate@binkert.org 13316657Snate@binkert.org case = str(case) 13326657Snate@binkert.org 13336657Snate@binkert.org # Look to see if this transition code is unique. 13346657Snate@binkert.org if case not in cases: 13356657Snate@binkert.org cases[case] = [] 13366657Snate@binkert.org 13376657Snate@binkert.org cases[case].append(case_string) 13386657Snate@binkert.org 13396657Snate@binkert.org # Walk through all of the unique code blocks and spit out the 13406657Snate@binkert.org # corresponding case statement elements 13416657Snate@binkert.org for case,transitions in cases.iteritems(): 13426657Snate@binkert.org # Iterative over all the multiple transitions that share 13436657Snate@binkert.org # the same code 13446657Snate@binkert.org for trans in transitions: 13456657Snate@binkert.org code(' case HASH_FUN($trans):') 13466657Snate@binkert.org code(' $case') 13476657Snate@binkert.org 13486657Snate@binkert.org code(''' 13496657Snate@binkert.org default: 13507805Snilay@cs.wisc.edu fatal("Invalid transition\\n" 13518159SBrad.Beckmann@amd.com "%s time: %d addr: %s event: %s state: %s\\n", 13529465Snilay@cs.wisc.edu name(), curCycle(), addr, event, state); 13536657Snate@binkert.org } 13546657Snate@binkert.org return TransitionResult_Valid; 13556657Snate@binkert.org} 13566657Snate@binkert.org''') 13576657Snate@binkert.org code.write(path, "%s_Transitions.cc" % self.ident) 13586657Snate@binkert.org 13596657Snate@binkert.org 13606657Snate@binkert.org # ************************** 13616657Snate@binkert.org # ******* HTML Files ******* 13626657Snate@binkert.org # ************************** 13637007Snate@binkert.org def frameRef(self, click_href, click_target, over_href, over_num, text): 13646999Snate@binkert.org code = self.symtab.codeFormatter(fix_newlines=False) 13657007Snate@binkert.org code("""<A href=\"$click_href\" target=\"$click_target\" onmouseover=\" 13667007Snate@binkert.org if (parent.frames[$over_num].location != parent.location + '$over_href') { 13677007Snate@binkert.org parent.frames[$over_num].location='$over_href' 13687007Snate@binkert.org }\"> 13697007Snate@binkert.org ${{html.formatShorthand(text)}} 13707007Snate@binkert.org </A>""") 13716657Snate@binkert.org return str(code) 13726657Snate@binkert.org 13736657Snate@binkert.org def writeHTMLFiles(self, path): 13746657Snate@binkert.org # Create table with no row hilighted 13756657Snate@binkert.org self.printHTMLTransitions(path, None) 13766657Snate@binkert.org 13776657Snate@binkert.org # Generate transition tables 13786657Snate@binkert.org for state in self.states.itervalues(): 13796657Snate@binkert.org self.printHTMLTransitions(path, state) 13806657Snate@binkert.org 13816657Snate@binkert.org # Generate action descriptions 13826657Snate@binkert.org for action in self.actions.itervalues(): 13836657Snate@binkert.org name = "%s_action_%s.html" % (self.ident, action.ident) 13846657Snate@binkert.org code = html.createSymbol(action, "Action") 13856657Snate@binkert.org code.write(path, name) 13866657Snate@binkert.org 13876657Snate@binkert.org # Generate state descriptions 13886657Snate@binkert.org for state in self.states.itervalues(): 13896657Snate@binkert.org name = "%s_State_%s.html" % (self.ident, state.ident) 13906657Snate@binkert.org code = html.createSymbol(state, "State") 13916657Snate@binkert.org code.write(path, name) 13926657Snate@binkert.org 13936657Snate@binkert.org # Generate event descriptions 13946657Snate@binkert.org for event in self.events.itervalues(): 13956657Snate@binkert.org name = "%s_Event_%s.html" % (self.ident, event.ident) 13966657Snate@binkert.org code = html.createSymbol(event, "Event") 13976657Snate@binkert.org code.write(path, name) 13986657Snate@binkert.org 13996657Snate@binkert.org def printHTMLTransitions(self, path, active_state): 14006999Snate@binkert.org code = self.symtab.codeFormatter() 14016657Snate@binkert.org 14026657Snate@binkert.org code(''' 14037007Snate@binkert.org<HTML> 14047007Snate@binkert.org<BODY link="blue" vlink="blue"> 14056657Snate@binkert.org 14066657Snate@binkert.org<H1 align="center">${{html.formatShorthand(self.short)}}: 14076657Snate@binkert.org''') 14086657Snate@binkert.org code.indent() 14096657Snate@binkert.org for i,machine in enumerate(self.symtab.getAllType(StateMachine)): 14106657Snate@binkert.org mid = machine.ident 14116657Snate@binkert.org if i != 0: 14126657Snate@binkert.org extra = " - " 14136657Snate@binkert.org else: 14146657Snate@binkert.org extra = "" 14156657Snate@binkert.org if machine == self: 14166657Snate@binkert.org code('$extra$mid') 14176657Snate@binkert.org else: 14186657Snate@binkert.org code('$extra<A target="Table" href="${mid}_table.html">$mid</A>') 14196657Snate@binkert.org code.dedent() 14206657Snate@binkert.org 14216657Snate@binkert.org code(""" 14226657Snate@binkert.org</H1> 14236657Snate@binkert.org 14246657Snate@binkert.org<TABLE border=1> 14256657Snate@binkert.org<TR> 14266657Snate@binkert.org <TH> </TH> 14276657Snate@binkert.org""") 14286657Snate@binkert.org 14296657Snate@binkert.org for event in self.events.itervalues(): 14306657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 14316657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 14326657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 14336657Snate@binkert.org 14346657Snate@binkert.org code('</TR>') 14356657Snate@binkert.org # -- Body of table 14366657Snate@binkert.org for state in self.states.itervalues(): 14376657Snate@binkert.org # -- Each row 14386657Snate@binkert.org if state == active_state: 14396657Snate@binkert.org color = "yellow" 14406657Snate@binkert.org else: 14416657Snate@binkert.org color = "white" 14426657Snate@binkert.org 14436657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 14446657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 14456657Snate@binkert.org text = html.formatShorthand(state.short) 14466657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 14476657Snate@binkert.org code(''' 14486657Snate@binkert.org<TR> 14496657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 14506657Snate@binkert.org''') 14516657Snate@binkert.org 14526657Snate@binkert.org # -- One column for each event 14536657Snate@binkert.org for event in self.events.itervalues(): 14546657Snate@binkert.org trans = self.table.get((state,event), None) 14556657Snate@binkert.org if trans is None: 14566657Snate@binkert.org # This is the no transition case 14576657Snate@binkert.org if state == active_state: 14586657Snate@binkert.org color = "#C0C000" 14596657Snate@binkert.org else: 14606657Snate@binkert.org color = "lightgrey" 14616657Snate@binkert.org 14626657Snate@binkert.org code('<TD bgcolor=$color> </TD>') 14636657Snate@binkert.org continue 14646657Snate@binkert.org 14656657Snate@binkert.org next = trans.nextState 14666657Snate@binkert.org stall_action = False 14676657Snate@binkert.org 14686657Snate@binkert.org # -- Get the actions 14696657Snate@binkert.org for action in trans.actions: 14706657Snate@binkert.org if action.ident == "z_stall" or \ 14716657Snate@binkert.org action.ident == "zz_recycleMandatoryQueue": 14726657Snate@binkert.org stall_action = True 14736657Snate@binkert.org 14746657Snate@binkert.org # -- Print out "actions/next-state" 14756657Snate@binkert.org if stall_action: 14766657Snate@binkert.org if state == active_state: 14776657Snate@binkert.org color = "#C0C000" 14786657Snate@binkert.org else: 14796657Snate@binkert.org color = "lightgrey" 14806657Snate@binkert.org 14816657Snate@binkert.org elif active_state and next.ident == active_state.ident: 14826657Snate@binkert.org color = "aqua" 14836657Snate@binkert.org elif state == active_state: 14846657Snate@binkert.org color = "yellow" 14856657Snate@binkert.org else: 14866657Snate@binkert.org color = "white" 14876657Snate@binkert.org 14886657Snate@binkert.org code('<TD bgcolor=$color>') 14896657Snate@binkert.org for action in trans.actions: 14906657Snate@binkert.org href = "%s_action_%s.html" % (self.ident, action.ident) 14916657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", 14926657Snate@binkert.org action.short) 14937007Snate@binkert.org code(' $ref') 14946657Snate@binkert.org if next != state: 14956657Snate@binkert.org if trans.actions: 14966657Snate@binkert.org code('/') 14976657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, next.ident) 14986657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, next.ident) 14996657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", next.short) 15006657Snate@binkert.org code("$ref") 15017007Snate@binkert.org code("</TD>") 15026657Snate@binkert.org 15036657Snate@binkert.org # -- Each row 15046657Snate@binkert.org if state == active_state: 15056657Snate@binkert.org color = "yellow" 15066657Snate@binkert.org else: 15076657Snate@binkert.org color = "white" 15086657Snate@binkert.org 15096657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 15106657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 15116657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 15126657Snate@binkert.org code(''' 15136657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 15146657Snate@binkert.org</TR> 15156657Snate@binkert.org''') 15166657Snate@binkert.org code(''' 15177007Snate@binkert.org<!- Column footer-> 15186657Snate@binkert.org<TR> 15196657Snate@binkert.org <TH> </TH> 15206657Snate@binkert.org''') 15216657Snate@binkert.org 15226657Snate@binkert.org for event in self.events.itervalues(): 15236657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 15246657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 15256657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 15266657Snate@binkert.org code(''' 15276657Snate@binkert.org</TR> 15286657Snate@binkert.org</TABLE> 15296657Snate@binkert.org</BODY></HTML> 15306657Snate@binkert.org''') 15316657Snate@binkert.org 15326657Snate@binkert.org 15336657Snate@binkert.org if active_state: 15346657Snate@binkert.org name = "%s_table_%s.html" % (self.ident, active_state.ident) 15356657Snate@binkert.org else: 15366657Snate@binkert.org name = "%s_table.html" % self.ident 15376657Snate@binkert.org code.write(path, name) 15386657Snate@binkert.org 15396657Snate@binkert.org__all__ = [ "StateMachine" ] 1540