StateMachine.py revision 10228
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 35410121Snilay@cs.wisc.edu # Prototype the actions that the controller can take 3556657Snate@binkert.org code(''' 3566657Snate@binkert.org 3576657Snate@binkert.org// Actions 3586657Snate@binkert.org''') 3597839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 3607839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3617839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 36210121Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& ' 36310121Snilay@cs.wisc.edu 'm_tbe_ptr, ${{self.EntryType.c_ident}}*& ' 36410121Snilay@cs.wisc.edu 'm_cache_entry_ptr, const Address& addr);') 3657839Snilay@cs.wisc.edu elif self.TBEType != None: 3667839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3677839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 36810121Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& ' 36910121Snilay@cs.wisc.edu 'm_tbe_ptr, const Address& addr);') 3707839Snilay@cs.wisc.edu elif self.EntryType != None: 3717839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3727839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 37310121Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.EntryType.c_ident}}*& ' 37410121Snilay@cs.wisc.edu 'm_cache_entry_ptr, const Address& addr);') 3757839Snilay@cs.wisc.edu else: 3767839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3777839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3787839Snilay@cs.wisc.edu code('void ${{action.ident}}(const Address& addr);') 3796657Snate@binkert.org 3806657Snate@binkert.org # the controller internal variables 3816657Snate@binkert.org code(''' 3826657Snate@binkert.org 3837007Snate@binkert.org// Objects 3846657Snate@binkert.org''') 3856657Snate@binkert.org for var in self.objects: 3869273Snilay@cs.wisc.edu th = var.get("template", "") 3876657Snate@binkert.org code('${{var.type.c_ident}}$th* m_${{var.c_ident}}_ptr;') 3886657Snate@binkert.org 3896657Snate@binkert.org code.dedent() 3906657Snate@binkert.org code('};') 3917007Snate@binkert.org code('#endif // __${ident}_CONTROLLER_H__') 3926657Snate@binkert.org code.write(path, '%s.hh' % c_ident) 3936657Snate@binkert.org 3949219Spower.jg@gmail.com def printControllerCC(self, path, includes): 3956657Snate@binkert.org '''Output the actions for performing the actions''' 3966657Snate@binkert.org 3976999Snate@binkert.org code = self.symtab.codeFormatter() 3986657Snate@binkert.org ident = self.ident 3996657Snate@binkert.org c_ident = "%s_Controller" % self.ident 4009595Snilay@cs.wisc.edu has_peer = False 4016657Snate@binkert.org 4026657Snate@binkert.org code(''' 4037007Snate@binkert.org/** \\file $c_ident.cc 4046657Snate@binkert.org * 4056657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4066657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 4076657Snate@binkert.org */ 4086657Snate@binkert.org 4098946Sandreas.hansson@arm.com#include <sys/types.h> 4108946Sandreas.hansson@arm.com#include <unistd.h> 4118946Sandreas.hansson@arm.com 4127832Snate@binkert.org#include <cassert> 4137002Snate@binkert.org#include <sstream> 4147002Snate@binkert.org#include <string> 4157002Snate@binkert.org 4168641Snate@binkert.org#include "base/compiler.hh" 4177056Snate@binkert.org#include "base/cprintf.hh" 4188232Snate@binkert.org#include "debug/RubyGenerated.hh" 4198232Snate@binkert.org#include "debug/RubySlicc.hh" 4206657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 4218229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 4226657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 4236657Snate@binkert.org#include "mem/protocol/Types.hh" 4247056Snate@binkert.org#include "mem/ruby/common/Global.hh" 4256657Snate@binkert.org#include "mem/ruby/system/System.hh" 4269219Spower.jg@gmail.com''') 4279219Spower.jg@gmail.com for include_path in includes: 4289219Spower.jg@gmail.com code('#include "${{include_path}}"') 4299219Spower.jg@gmail.com 4309219Spower.jg@gmail.com code(''' 4317002Snate@binkert.org 4327002Snate@binkert.orgusing namespace std; 4336657Snate@binkert.org''') 4346657Snate@binkert.org 4356657Snate@binkert.org # include object classes 4366657Snate@binkert.org seen_types = set() 4376657Snate@binkert.org for var in self.objects: 4386793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 4396657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 4406657Snate@binkert.org seen_types.add(var.type.ident) 4416657Snate@binkert.org 44210121Snilay@cs.wisc.edu num_in_ports = len(self.in_ports) 44310121Snilay@cs.wisc.edu 4446657Snate@binkert.org code(''' 4456877Ssteve.reinhardt@amd.com$c_ident * 4466877Ssteve.reinhardt@amd.com${c_ident}Params::create() 4476877Ssteve.reinhardt@amd.com{ 4486877Ssteve.reinhardt@amd.com return new $c_ident(this); 4496877Ssteve.reinhardt@amd.com} 4506877Ssteve.reinhardt@amd.com 4516657Snate@binkert.orgint $c_ident::m_num_controllers = 0; 4529745Snilay@cs.wisc.edustd::vector<Stats::Vector *> $c_ident::eventVec; 4539745Snilay@cs.wisc.edustd::vector<std::vector<Stats::Vector *> > $c_ident::transVec; 4546657Snate@binkert.org 4557007Snate@binkert.org// for adding information to the protocol debug trace 4566657Snate@binkert.orgstringstream ${ident}_transitionComment; 4579801Snilay@cs.wisc.edu 4589801Snilay@cs.wisc.edu#ifndef NDEBUG 4596657Snate@binkert.org#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str) 4609801Snilay@cs.wisc.edu#else 4619801Snilay@cs.wisc.edu#define APPEND_TRANSITION_COMMENT(str) do {} while (0) 4629801Snilay@cs.wisc.edu#endif 4637007Snate@binkert.org 4646657Snate@binkert.org/** \\brief constructor */ 4656877Ssteve.reinhardt@amd.com$c_ident::$c_ident(const Params *p) 4666877Ssteve.reinhardt@amd.com : AbstractController(p) 4676657Snate@binkert.org{ 46810078Snilay@cs.wisc.edu m_machineID.type = MachineType_${ident}; 46910078Snilay@cs.wisc.edu m_machineID.num = m_version; 47010121Snilay@cs.wisc.edu m_num_controllers++; 47110121Snilay@cs.wisc.edu 47210121Snilay@cs.wisc.edu m_in_ports = $num_in_ports; 4736657Snate@binkert.org''') 4746657Snate@binkert.org code.indent() 4756882SBrad.Beckmann@amd.com 4766882SBrad.Beckmann@amd.com # 4776882SBrad.Beckmann@amd.com # After initializing the universal machine parameters, initialize the 47810121Snilay@cs.wisc.edu # this machines config parameters. Also if these configuration params 47910121Snilay@cs.wisc.edu # include a sequencer, connect the it to the controller. 4806882SBrad.Beckmann@amd.com # 4816877Ssteve.reinhardt@amd.com for param in self.config_parameters: 4826882SBrad.Beckmann@amd.com if param.pointer: 4836882SBrad.Beckmann@amd.com code('m_${{param.name}}_ptr = p->${{param.name}};') 4846882SBrad.Beckmann@amd.com else: 4856882SBrad.Beckmann@amd.com code('m_${{param.name}} = p->${{param.name}};') 48610121Snilay@cs.wisc.edu if re.compile("sequencer").search(param.name): 48710121Snilay@cs.wisc.edu code('m_${{param.name}}_ptr->setController(this);') 4886888SBrad.Beckmann@amd.com 4896657Snate@binkert.org for var in self.objects: 4906657Snate@binkert.org if var.ident.find("mandatoryQueue") >= 0: 4919508Snilay@cs.wisc.edu code(''' 4929508Snilay@cs.wisc.edum_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}(); 4939508Snilay@cs.wisc.edum_${{var.c_ident}}_ptr->setReceiver(this); 4949508Snilay@cs.wisc.edu''') 4959595Snilay@cs.wisc.edu else: 4969595Snilay@cs.wisc.edu if "network" in var and "physical_network" in var and \ 4979595Snilay@cs.wisc.edu var["network"] == "To": 4989595Snilay@cs.wisc.edu has_peer = True 4999595Snilay@cs.wisc.edu code(''' 5009595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}(); 5019595Snilay@cs.wisc.edupeerQueueMap[${{var["physical_network"]}}] = m_${{var.c_ident}}_ptr; 5029595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr->setSender(this); 5039595Snilay@cs.wisc.edu''') 5046657Snate@binkert.org 5059595Snilay@cs.wisc.edu code(''' 5069595Snilay@cs.wisc.eduif (p->peer != NULL) 5079595Snilay@cs.wisc.edu connectWithPeer(p->peer); 5089745Snilay@cs.wisc.edu 5099745Snilay@cs.wisc.edufor (int state = 0; state < ${ident}_State_NUM; state++) { 5109745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 5119745Snilay@cs.wisc.edu m_possible[state][event] = false; 5129745Snilay@cs.wisc.edu m_counters[state][event] = 0; 5139745Snilay@cs.wisc.edu } 5149745Snilay@cs.wisc.edu} 5159745Snilay@cs.wisc.edufor (int event = 0; event < ${ident}_Event_NUM; event++) { 5169745Snilay@cs.wisc.edu m_event_counters[event] = 0; 5179745Snilay@cs.wisc.edu} 5189595Snilay@cs.wisc.edu''') 5196657Snate@binkert.org code.dedent() 5206657Snate@binkert.org code(''' 5216657Snate@binkert.org} 5226657Snate@binkert.org 5237007Snate@binkert.orgvoid 5247007Snate@binkert.org$c_ident::init() 5256657Snate@binkert.org{ 5269745Snilay@cs.wisc.edu MachineType machine_type = string_to_MachineType("${{var.machine.ident}}"); 52710008Snilay@cs.wisc.edu int base M5_VAR_USED = MachineType_base_number(machine_type); 5287007Snate@binkert.org 5297007Snate@binkert.org // initialize objects 5307007Snate@binkert.org 5316657Snate@binkert.org''') 5326657Snate@binkert.org 5336657Snate@binkert.org code.indent() 5346657Snate@binkert.org for var in self.objects: 5356657Snate@binkert.org vtype = var.type 5366657Snate@binkert.org vid = "m_%s_ptr" % var.c_ident 5376657Snate@binkert.org if "network" not in var: 5386657Snate@binkert.org # Not a network port object 5396657Snate@binkert.org if "primitive" in vtype: 5406657Snate@binkert.org code('$vid = new ${{vtype.c_ident}};') 5416657Snate@binkert.org if "default" in var: 5426657Snate@binkert.org code('(*$vid) = ${{var["default"]}};') 5436657Snate@binkert.org else: 5446657Snate@binkert.org # Normal Object 5459595Snilay@cs.wisc.edu if var.ident.find("mandatoryQueue") < 0: 5469273Snilay@cs.wisc.edu th = var.get("template", "") 5476657Snate@binkert.org expr = "%s = new %s%s" % (vid, vtype.c_ident, th) 5486657Snate@binkert.org args = "" 5496657Snate@binkert.org if "non_obj" not in vtype and not vtype.isEnumeration: 5509364Snilay@cs.wisc.edu args = var.get("constructor", "") 5517007Snate@binkert.org code('$expr($args);') 5526657Snate@binkert.org 5536657Snate@binkert.org code('assert($vid != NULL);') 5546657Snate@binkert.org 5556657Snate@binkert.org if "default" in var: 5567007Snate@binkert.org code('*$vid = ${{var["default"]}}; // Object default') 5576657Snate@binkert.org elif "default" in vtype: 5587007Snate@binkert.org comment = "Type %s default" % vtype.ident 5597007Snate@binkert.org code('*$vid = ${{vtype["default"]}}; // $comment') 5606657Snate@binkert.org 5616657Snate@binkert.org # Set ordering 5629508Snilay@cs.wisc.edu if "ordered" in var: 5636657Snate@binkert.org # A buffer 5646657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 5656657Snate@binkert.org 5666657Snate@binkert.org # Set randomization 5676657Snate@binkert.org if "random" in var: 5686657Snate@binkert.org # A buffer 5696657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}});') 5706657Snate@binkert.org 5716657Snate@binkert.org # Set Priority 5729508Snilay@cs.wisc.edu if vtype.isBuffer and "rank" in var: 5736657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}});') 5747566SBrad.Beckmann@amd.com 5759508Snilay@cs.wisc.edu # Set sender and receiver for trigger queue 5769508Snilay@cs.wisc.edu if var.ident.find("triggerQueue") >= 0: 5779508Snilay@cs.wisc.edu code('$vid->setSender(this);') 5789508Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 5799508Snilay@cs.wisc.edu elif vtype.c_ident == "TimerTable": 5809508Snilay@cs.wisc.edu code('$vid->setClockObj(this);') 5819604Snilay@cs.wisc.edu elif var.ident.find("optionalQueue") >= 0: 5829604Snilay@cs.wisc.edu code('$vid->setSender(this);') 5839604Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 5849508Snilay@cs.wisc.edu 5856657Snate@binkert.org else: 5866657Snate@binkert.org # Network port object 5876657Snate@binkert.org network = var["network"] 5886657Snate@binkert.org ordered = var["ordered"] 5896657Snate@binkert.org 5909595Snilay@cs.wisc.edu if "virtual_network" in var: 5919595Snilay@cs.wisc.edu vnet = var["virtual_network"] 5929595Snilay@cs.wisc.edu vnet_type = var["vnet_type"] 5939595Snilay@cs.wisc.edu 5949595Snilay@cs.wisc.edu assert var.machine is not None 5959595Snilay@cs.wisc.edu code(''' 5968308Stushar@csail.mit.edu$vid = m_net_ptr->get${network}NetQueue(m_version + base, $ordered, $vnet, "$vnet_type"); 5979595Snilay@cs.wisc.eduassert($vid != NULL); 5986657Snate@binkert.org''') 5996657Snate@binkert.org 6009595Snilay@cs.wisc.edu # Set the end 6019595Snilay@cs.wisc.edu if network == "To": 6029595Snilay@cs.wisc.edu code('$vid->setSender(this);') 6039595Snilay@cs.wisc.edu else: 6049595Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 6059508Snilay@cs.wisc.edu 6066657Snate@binkert.org # Set ordering 6076657Snate@binkert.org if "ordered" in var: 6086657Snate@binkert.org # A buffer 6096657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 6106657Snate@binkert.org 6116657Snate@binkert.org # Set randomization 6126657Snate@binkert.org if "random" in var: 6136657Snate@binkert.org # A buffer 6148187SLisa.Hsu@amd.com code('$vid->setRandomization(${{var["random"]}});') 6156657Snate@binkert.org 6166657Snate@binkert.org # Set Priority 6176657Snate@binkert.org if "rank" in var: 6186657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}})') 6196657Snate@binkert.org 6206657Snate@binkert.org # Set buffer size 6216657Snate@binkert.org if vtype.isBuffer: 6226657Snate@binkert.org code(''' 6236657Snate@binkert.orgif (m_buffer_size > 0) { 6247454Snate@binkert.org $vid->resize(m_buffer_size); 6256657Snate@binkert.org} 6266657Snate@binkert.org''') 6276657Snate@binkert.org 6286657Snate@binkert.org # set description (may be overriden later by port def) 6297007Snate@binkert.org code(''' 6307056Snate@binkert.org$vid->setDescription("[Version " + to_string(m_version) + ", ${ident}, name=${{var.c_ident}}]"); 6317007Snate@binkert.org 6327007Snate@binkert.org''') 6336657Snate@binkert.org 6347566SBrad.Beckmann@amd.com if vtype.isBuffer: 6357566SBrad.Beckmann@amd.com if "recycle_latency" in var: 6369499Snilay@cs.wisc.edu code('$vid->setRecycleLatency( ' \ 6379499Snilay@cs.wisc.edu 'Cycles(${{var["recycle_latency"]}}));') 6387566SBrad.Beckmann@amd.com else: 6397566SBrad.Beckmann@amd.com code('$vid->setRecycleLatency(m_recycle_latency);') 6407566SBrad.Beckmann@amd.com 6419366Snilay@cs.wisc.edu # Set the prefetchers 6429366Snilay@cs.wisc.edu code() 6439366Snilay@cs.wisc.edu for prefetcher in self.prefetchers: 6449366Snilay@cs.wisc.edu code('${{prefetcher.code}}.setController(this);') 6457566SBrad.Beckmann@amd.com 6467672Snate@binkert.org code() 6476657Snate@binkert.org for port in self.in_ports: 6489465Snilay@cs.wisc.edu # Set the queue consumers 6496657Snate@binkert.org code('${{port.code}}.setConsumer(this);') 6509465Snilay@cs.wisc.edu # Set the queue descriptions 6517056Snate@binkert.org code('${{port.code}}.setDescription("[Version " + to_string(m_version) + ", $ident, $port]");') 6526657Snate@binkert.org 6536657Snate@binkert.org # Initialize the transition profiling 6547672Snate@binkert.org code() 6556657Snate@binkert.org for trans in self.transitions: 6566657Snate@binkert.org # Figure out if we stall 6576657Snate@binkert.org stall = False 6586657Snate@binkert.org for action in trans.actions: 6596657Snate@binkert.org if action.ident == "z_stall": 6606657Snate@binkert.org stall = True 6616657Snate@binkert.org 6626657Snate@binkert.org # Only possible if it is not a 'z' case 6636657Snate@binkert.org if not stall: 6646657Snate@binkert.org state = "%s_State_%s" % (self.ident, trans.state.ident) 6656657Snate@binkert.org event = "%s_Event_%s" % (self.ident, trans.event.ident) 6669745Snilay@cs.wisc.edu code('possibleTransition($state, $event);') 6676657Snate@binkert.org 6686657Snate@binkert.org code.dedent() 6699496Snilay@cs.wisc.edu code(''' 6709496Snilay@cs.wisc.edu AbstractController::init(); 67110012Snilay@cs.wisc.edu resetStats(); 6729496Snilay@cs.wisc.edu} 6739496Snilay@cs.wisc.edu''') 6746657Snate@binkert.org 67510121Snilay@cs.wisc.edu mq_ident = "NULL" 6766657Snate@binkert.org for port in self.in_ports: 6776657Snate@binkert.org if port.code.find("mandatoryQueue_ptr") >= 0: 67810121Snilay@cs.wisc.edu mq_ident = "m_%s_mandatoryQueue_ptr" % self.ident 6796657Snate@binkert.org 6808683Snilay@cs.wisc.edu seq_ident = "NULL" 6818683Snilay@cs.wisc.edu for param in self.config_parameters: 6828683Snilay@cs.wisc.edu if param.name == "sequencer": 6838683Snilay@cs.wisc.edu assert(param.pointer) 6848683Snilay@cs.wisc.edu seq_ident = "m_%s_ptr" % param.name 6858683Snilay@cs.wisc.edu 6866657Snate@binkert.org code(''' 6879745Snilay@cs.wisc.edu 6889745Snilay@cs.wisc.eduvoid 6899745Snilay@cs.wisc.edu$c_ident::regStats() 6909745Snilay@cs.wisc.edu{ 69110012Snilay@cs.wisc.edu AbstractController::regStats(); 69210012Snilay@cs.wisc.edu 6939745Snilay@cs.wisc.edu if (m_version == 0) { 6949745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 6959745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 6969745Snilay@cs.wisc.edu Stats::Vector *t = new Stats::Vector(); 6979745Snilay@cs.wisc.edu t->init(m_num_controllers); 69810012Snilay@cs.wisc.edu t->name(g_system_ptr->name() + ".${c_ident}." + 69910012Snilay@cs.wisc.edu ${ident}_Event_to_string(event)); 7009745Snilay@cs.wisc.edu t->flags(Stats::pdf | Stats::total | Stats::oneline | 7019745Snilay@cs.wisc.edu Stats::nozero); 7029745Snilay@cs.wisc.edu 7039745Snilay@cs.wisc.edu eventVec.push_back(t); 7049745Snilay@cs.wisc.edu } 7059745Snilay@cs.wisc.edu 7069745Snilay@cs.wisc.edu for (${ident}_State state = ${ident}_State_FIRST; 7079745Snilay@cs.wisc.edu state < ${ident}_State_NUM; ++state) { 7089745Snilay@cs.wisc.edu 7099745Snilay@cs.wisc.edu transVec.push_back(std::vector<Stats::Vector *>()); 7109745Snilay@cs.wisc.edu 7119745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7129745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7139745Snilay@cs.wisc.edu 7149745Snilay@cs.wisc.edu Stats::Vector *t = new Stats::Vector(); 7159745Snilay@cs.wisc.edu t->init(m_num_controllers); 71610012Snilay@cs.wisc.edu t->name(g_system_ptr->name() + ".${c_ident}." + 71710012Snilay@cs.wisc.edu ${ident}_State_to_string(state) + 7189745Snilay@cs.wisc.edu "." + ${ident}_Event_to_string(event)); 7199745Snilay@cs.wisc.edu 7209745Snilay@cs.wisc.edu t->flags(Stats::pdf | Stats::total | Stats::oneline | 7219745Snilay@cs.wisc.edu Stats::nozero); 7229745Snilay@cs.wisc.edu transVec[state].push_back(t); 7239745Snilay@cs.wisc.edu } 7249745Snilay@cs.wisc.edu } 7259745Snilay@cs.wisc.edu } 7269745Snilay@cs.wisc.edu} 7279745Snilay@cs.wisc.edu 7289745Snilay@cs.wisc.eduvoid 7299745Snilay@cs.wisc.edu$c_ident::collateStats() 7309745Snilay@cs.wisc.edu{ 7319745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7329745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7339745Snilay@cs.wisc.edu for (unsigned int i = 0; i < m_num_controllers; ++i) { 7349745Snilay@cs.wisc.edu std::map<uint32_t, AbstractController *>::iterator it = 7359745Snilay@cs.wisc.edu g_abs_controls[MachineType_${ident}].find(i); 7369745Snilay@cs.wisc.edu assert(it != g_abs_controls[MachineType_${ident}].end()); 7379745Snilay@cs.wisc.edu (*eventVec[event])[i] = 7389745Snilay@cs.wisc.edu (($c_ident *)(*it).second)->getEventCount(event); 7399745Snilay@cs.wisc.edu } 7409745Snilay@cs.wisc.edu } 7419745Snilay@cs.wisc.edu 7429745Snilay@cs.wisc.edu for (${ident}_State state = ${ident}_State_FIRST; 7439745Snilay@cs.wisc.edu state < ${ident}_State_NUM; ++state) { 7449745Snilay@cs.wisc.edu 7459745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7469745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7479745Snilay@cs.wisc.edu 7489745Snilay@cs.wisc.edu for (unsigned int i = 0; i < m_num_controllers; ++i) { 7499745Snilay@cs.wisc.edu std::map<uint32_t, AbstractController *>::iterator it = 7509745Snilay@cs.wisc.edu g_abs_controls[MachineType_${ident}].find(i); 7519745Snilay@cs.wisc.edu assert(it != g_abs_controls[MachineType_${ident}].end()); 7529745Snilay@cs.wisc.edu (*transVec[state][event])[i] = 7539745Snilay@cs.wisc.edu (($c_ident *)(*it).second)->getTransitionCount(state, event); 7549745Snilay@cs.wisc.edu } 7559745Snilay@cs.wisc.edu } 7569745Snilay@cs.wisc.edu } 7579745Snilay@cs.wisc.edu} 7589745Snilay@cs.wisc.edu 7599745Snilay@cs.wisc.eduvoid 7609745Snilay@cs.wisc.edu$c_ident::countTransition(${ident}_State state, ${ident}_Event event) 7619745Snilay@cs.wisc.edu{ 7629745Snilay@cs.wisc.edu assert(m_possible[state][event]); 7639745Snilay@cs.wisc.edu m_counters[state][event]++; 7649745Snilay@cs.wisc.edu m_event_counters[event]++; 7659745Snilay@cs.wisc.edu} 7669745Snilay@cs.wisc.eduvoid 7679745Snilay@cs.wisc.edu$c_ident::possibleTransition(${ident}_State state, 7689745Snilay@cs.wisc.edu ${ident}_Event event) 7699745Snilay@cs.wisc.edu{ 7709745Snilay@cs.wisc.edu m_possible[state][event] = true; 7719745Snilay@cs.wisc.edu} 7729745Snilay@cs.wisc.edu 7739745Snilay@cs.wisc.eduuint64 7749745Snilay@cs.wisc.edu$c_ident::getEventCount(${ident}_Event event) 7759745Snilay@cs.wisc.edu{ 7769745Snilay@cs.wisc.edu return m_event_counters[event]; 7779745Snilay@cs.wisc.edu} 7789745Snilay@cs.wisc.edu 7799745Snilay@cs.wisc.edubool 7809745Snilay@cs.wisc.edu$c_ident::isPossible(${ident}_State state, ${ident}_Event event) 7819745Snilay@cs.wisc.edu{ 7829745Snilay@cs.wisc.edu return m_possible[state][event]; 7839745Snilay@cs.wisc.edu} 7849745Snilay@cs.wisc.edu 7859745Snilay@cs.wisc.eduuint64 7869745Snilay@cs.wisc.edu$c_ident::getTransitionCount(${ident}_State state, 7879745Snilay@cs.wisc.edu ${ident}_Event event) 7889745Snilay@cs.wisc.edu{ 7899745Snilay@cs.wisc.edu return m_counters[state][event]; 7909745Snilay@cs.wisc.edu} 7919745Snilay@cs.wisc.edu 7927007Snate@binkert.orgint 7937007Snate@binkert.org$c_ident::getNumControllers() 7947007Snate@binkert.org{ 7956657Snate@binkert.org return m_num_controllers; 7966657Snate@binkert.org} 7976657Snate@binkert.org 7987007Snate@binkert.orgMessageBuffer* 7997007Snate@binkert.org$c_ident::getMandatoryQueue() const 8007007Snate@binkert.org{ 8016657Snate@binkert.org return $mq_ident; 8026657Snate@binkert.org} 8036657Snate@binkert.org 8048683Snilay@cs.wisc.eduSequencer* 8058683Snilay@cs.wisc.edu$c_ident::getSequencer() const 8068683Snilay@cs.wisc.edu{ 8078683Snilay@cs.wisc.edu return $seq_ident; 8088683Snilay@cs.wisc.edu} 8098683Snilay@cs.wisc.edu 8107007Snate@binkert.orgconst string 8117007Snate@binkert.org$c_ident::toString() const 8127007Snate@binkert.org{ 8136657Snate@binkert.org return "$c_ident"; 8146657Snate@binkert.org} 8156657Snate@binkert.org 8167007Snate@binkert.orgvoid 8177007Snate@binkert.org$c_ident::print(ostream& out) const 8187007Snate@binkert.org{ 8197007Snate@binkert.org out << "[$c_ident " << m_version << "]"; 8207007Snate@binkert.org} 8216657Snate@binkert.org 82210012Snilay@cs.wisc.eduvoid $c_ident::resetStats() 8239745Snilay@cs.wisc.edu{ 8249745Snilay@cs.wisc.edu for (int state = 0; state < ${ident}_State_NUM; state++) { 8259745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 8269745Snilay@cs.wisc.edu m_counters[state][event] = 0; 8279745Snilay@cs.wisc.edu } 8289745Snilay@cs.wisc.edu } 8296902SBrad.Beckmann@amd.com 8309745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 8319745Snilay@cs.wisc.edu m_event_counters[event] = 0; 8329745Snilay@cs.wisc.edu } 8339745Snilay@cs.wisc.edu 83410012Snilay@cs.wisc.edu AbstractController::resetStats(); 8356902SBrad.Beckmann@amd.com} 8367839Snilay@cs.wisc.edu''') 8377839Snilay@cs.wisc.edu 8387839Snilay@cs.wisc.edu if self.EntryType != None: 8397839Snilay@cs.wisc.edu code(''' 8407839Snilay@cs.wisc.edu 8417839Snilay@cs.wisc.edu// Set and Reset for cache_entry variable 8427839Snilay@cs.wisc.eduvoid 8437839Snilay@cs.wisc.edu$c_ident::set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry) 8447839Snilay@cs.wisc.edu{ 8457839Snilay@cs.wisc.edu m_cache_entry_ptr = (${{self.EntryType.c_ident}}*)m_new_cache_entry; 8467839Snilay@cs.wisc.edu} 8477839Snilay@cs.wisc.edu 8487839Snilay@cs.wisc.eduvoid 8497839Snilay@cs.wisc.edu$c_ident::unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr) 8507839Snilay@cs.wisc.edu{ 8517839Snilay@cs.wisc.edu m_cache_entry_ptr = 0; 8527839Snilay@cs.wisc.edu} 8537839Snilay@cs.wisc.edu''') 8547839Snilay@cs.wisc.edu 8557839Snilay@cs.wisc.edu if self.TBEType != None: 8567839Snilay@cs.wisc.edu code(''' 8577839Snilay@cs.wisc.edu 8587839Snilay@cs.wisc.edu// Set and Reset for tbe variable 8597839Snilay@cs.wisc.eduvoid 8607839Snilay@cs.wisc.edu$c_ident::set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.TBEType.c_ident}}* m_new_tbe) 8617839Snilay@cs.wisc.edu{ 8627839Snilay@cs.wisc.edu m_tbe_ptr = m_new_tbe; 8637839Snilay@cs.wisc.edu} 8647839Snilay@cs.wisc.edu 8657839Snilay@cs.wisc.eduvoid 8667839Snilay@cs.wisc.edu$c_ident::unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr) 8677839Snilay@cs.wisc.edu{ 8687839Snilay@cs.wisc.edu m_tbe_ptr = NULL; 8697839Snilay@cs.wisc.edu} 8707839Snilay@cs.wisc.edu''') 8717839Snilay@cs.wisc.edu 8727839Snilay@cs.wisc.edu code(''' 8736902SBrad.Beckmann@amd.com 8748683Snilay@cs.wisc.eduvoid 8758683Snilay@cs.wisc.edu$c_ident::recordCacheTrace(int cntrl, CacheRecorder* tr) 8768683Snilay@cs.wisc.edu{ 8778683Snilay@cs.wisc.edu''') 8788683Snilay@cs.wisc.edu # 8798683Snilay@cs.wisc.edu # Record cache contents for all associated caches. 8808683Snilay@cs.wisc.edu # 8818683Snilay@cs.wisc.edu code.indent() 8828683Snilay@cs.wisc.edu for param in self.config_parameters: 8838683Snilay@cs.wisc.edu if param.type_ast.type.ident == "CacheMemory": 8848683Snilay@cs.wisc.edu assert(param.pointer) 8858683Snilay@cs.wisc.edu code('m_${{param.ident}}_ptr->recordCacheContents(cntrl, tr);') 8868683Snilay@cs.wisc.edu 8878683Snilay@cs.wisc.edu code.dedent() 8888683Snilay@cs.wisc.edu code(''' 8898683Snilay@cs.wisc.edu} 8908683Snilay@cs.wisc.edu 8916657Snate@binkert.org// Actions 8926657Snate@binkert.org''') 8937839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 8947839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 8957839Snilay@cs.wisc.edu if "c_code" not in action: 8967839Snilay@cs.wisc.edu continue 8976657Snate@binkert.org 8987839Snilay@cs.wisc.edu code(''' 8997839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9007839Snilay@cs.wisc.eduvoid 9017839Snilay@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) 9027839Snilay@cs.wisc.edu{ 9038055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9047839Snilay@cs.wisc.edu ${{action["c_code"]}} 9057839Snilay@cs.wisc.edu} 9066657Snate@binkert.org 9077839Snilay@cs.wisc.edu''') 9087839Snilay@cs.wisc.edu elif self.TBEType != None: 9097839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9107839Snilay@cs.wisc.edu if "c_code" not in action: 9117839Snilay@cs.wisc.edu continue 9127839Snilay@cs.wisc.edu 9137839Snilay@cs.wisc.edu code(''' 9147839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9157839Snilay@cs.wisc.eduvoid 9167839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr) 9177839Snilay@cs.wisc.edu{ 9188055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9197839Snilay@cs.wisc.edu ${{action["c_code"]}} 9207839Snilay@cs.wisc.edu} 9217839Snilay@cs.wisc.edu 9227839Snilay@cs.wisc.edu''') 9237839Snilay@cs.wisc.edu elif self.EntryType != None: 9247839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9257839Snilay@cs.wisc.edu if "c_code" not in action: 9267839Snilay@cs.wisc.edu continue 9277839Snilay@cs.wisc.edu 9287839Snilay@cs.wisc.edu code(''' 9297839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9307839Snilay@cs.wisc.eduvoid 9317839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr) 9327839Snilay@cs.wisc.edu{ 9338055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9347839Snilay@cs.wisc.edu ${{action["c_code"]}} 9357839Snilay@cs.wisc.edu} 9367839Snilay@cs.wisc.edu 9377839Snilay@cs.wisc.edu''') 9387839Snilay@cs.wisc.edu else: 9397839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9407839Snilay@cs.wisc.edu if "c_code" not in action: 9417839Snilay@cs.wisc.edu continue 9427839Snilay@cs.wisc.edu 9437839Snilay@cs.wisc.edu code(''' 9446657Snate@binkert.org/** \\brief ${{action.desc}} */ 9457007Snate@binkert.orgvoid 9467007Snate@binkert.org$c_ident::${{action.ident}}(const Address& addr) 9476657Snate@binkert.org{ 9488055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9496657Snate@binkert.org ${{action["c_code"]}} 9506657Snate@binkert.org} 9516657Snate@binkert.org 9526657Snate@binkert.org''') 9538478Snilay@cs.wisc.edu for func in self.functions: 9548478Snilay@cs.wisc.edu code(func.generateCode()) 9558478Snilay@cs.wisc.edu 9569302Snilay@cs.wisc.edu # Function for functional reads from messages buffered in the controller 9579302Snilay@cs.wisc.edu code(''' 9589302Snilay@cs.wisc.edubool 9599302Snilay@cs.wisc.edu$c_ident::functionalReadBuffers(PacketPtr& pkt) 9609302Snilay@cs.wisc.edu{ 9619302Snilay@cs.wisc.edu''') 9629302Snilay@cs.wisc.edu for var in self.objects: 9639302Snilay@cs.wisc.edu vtype = var.type 9649302Snilay@cs.wisc.edu if vtype.isBuffer: 9659302Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.c_ident 9669302Snilay@cs.wisc.edu code('if ($vid->functionalRead(pkt)) { return true; }') 9679302Snilay@cs.wisc.edu code(''' 9689302Snilay@cs.wisc.edu return false; 9699302Snilay@cs.wisc.edu} 9709302Snilay@cs.wisc.edu''') 9719302Snilay@cs.wisc.edu 9729302Snilay@cs.wisc.edu # Function for functional writes to messages buffered in the controller 9739302Snilay@cs.wisc.edu code(''' 9749302Snilay@cs.wisc.eduuint32_t 9759302Snilay@cs.wisc.edu$c_ident::functionalWriteBuffers(PacketPtr& pkt) 9769302Snilay@cs.wisc.edu{ 9779302Snilay@cs.wisc.edu uint32_t num_functional_writes = 0; 9789302Snilay@cs.wisc.edu''') 9799302Snilay@cs.wisc.edu for var in self.objects: 9809302Snilay@cs.wisc.edu vtype = var.type 9819302Snilay@cs.wisc.edu if vtype.isBuffer: 9829302Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.c_ident 9839302Snilay@cs.wisc.edu code('num_functional_writes += $vid->functionalWrite(pkt);') 9849302Snilay@cs.wisc.edu code(''' 9859302Snilay@cs.wisc.edu return num_functional_writes; 9869302Snilay@cs.wisc.edu} 9879302Snilay@cs.wisc.edu''') 9889302Snilay@cs.wisc.edu 9899595Snilay@cs.wisc.edu # Check if this controller has a peer, if yes then write the 9909595Snilay@cs.wisc.edu # function for connecting to the peer. 9919595Snilay@cs.wisc.edu if has_peer: 9929595Snilay@cs.wisc.edu code(''' 9939595Snilay@cs.wisc.edu 9949595Snilay@cs.wisc.eduvoid 9959595Snilay@cs.wisc.edu$c_ident::getQueuesFromPeer(AbstractController *peer) 9969595Snilay@cs.wisc.edu{ 9979595Snilay@cs.wisc.edu''') 9989595Snilay@cs.wisc.edu for var in self.objects: 9999595Snilay@cs.wisc.edu if "network" in var and "physical_network" in var and \ 10009595Snilay@cs.wisc.edu var["network"] == "From": 10019595Snilay@cs.wisc.edu code(''' 10029595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr = peer->getPeerQueue(${{var["physical_network"]}}); 10039595Snilay@cs.wisc.eduassert(m_${{var.c_ident}}_ptr != NULL); 10049595Snilay@cs.wisc.edum_${{var.c_ident}}_ptr->setReceiver(this); 10059595Snilay@cs.wisc.edu 10069595Snilay@cs.wisc.edu''') 10079595Snilay@cs.wisc.edu code('}') 10089595Snilay@cs.wisc.edu 10096657Snate@binkert.org code.write(path, "%s.cc" % c_ident) 10106657Snate@binkert.org 10119219Spower.jg@gmail.com def printCWakeup(self, path, includes): 10126657Snate@binkert.org '''Output the wakeup loop for the events''' 10136657Snate@binkert.org 10146999Snate@binkert.org code = self.symtab.codeFormatter() 10156657Snate@binkert.org ident = self.ident 10166657Snate@binkert.org 10179104Shestness@cs.utexas.edu outputRequest_types = True 10189104Shestness@cs.utexas.edu if len(self.request_types) == 0: 10199104Shestness@cs.utexas.edu outputRequest_types = False 10209104Shestness@cs.utexas.edu 10216657Snate@binkert.org code(''' 10226657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 10236657Snate@binkert.org// ${ident}: ${{self.short}} 10246657Snate@binkert.org 10258946Sandreas.hansson@arm.com#include <sys/types.h> 10268946Sandreas.hansson@arm.com#include <unistd.h> 10278946Sandreas.hansson@arm.com 10287832Snate@binkert.org#include <cassert> 10297832Snate@binkert.org 10307007Snate@binkert.org#include "base/misc.hh" 10318232Snate@binkert.org#include "debug/RubySlicc.hh" 10328229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 10338229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 10348229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 10359104Shestness@cs.utexas.edu''') 10369104Shestness@cs.utexas.edu 10379104Shestness@cs.utexas.edu if outputRequest_types: 10389104Shestness@cs.utexas.edu code('''#include "mem/protocol/${ident}_RequestType.hh"''') 10399104Shestness@cs.utexas.edu 10409104Shestness@cs.utexas.edu code(''' 10418229Snate@binkert.org#include "mem/protocol/Types.hh" 10426657Snate@binkert.org#include "mem/ruby/common/Global.hh" 10436657Snate@binkert.org#include "mem/ruby/system/System.hh" 10449219Spower.jg@gmail.com''') 10459219Spower.jg@gmail.com 10469219Spower.jg@gmail.com 10479219Spower.jg@gmail.com for include_path in includes: 10489219Spower.jg@gmail.com code('#include "${{include_path}}"') 10499219Spower.jg@gmail.com 10509219Spower.jg@gmail.com code(''' 10516657Snate@binkert.org 10527055Snate@binkert.orgusing namespace std; 10537055Snate@binkert.org 10547007Snate@binkert.orgvoid 10557007Snate@binkert.org${ident}_Controller::wakeup() 10566657Snate@binkert.org{ 10576657Snate@binkert.org int counter = 0; 10586657Snate@binkert.org while (true) { 10596657Snate@binkert.org // Some cases will put us into an infinite loop without this limit 10606657Snate@binkert.org assert(counter <= m_transitions_per_cycle); 10616657Snate@binkert.org if (counter == m_transitions_per_cycle) { 10627007Snate@binkert.org // Count how often we are fully utilized 10639496Snilay@cs.wisc.edu m_fully_busy_cycles++; 10647007Snate@binkert.org 10657007Snate@binkert.org // Wakeup in another cycle and try again 10669499Snilay@cs.wisc.edu scheduleEvent(Cycles(1)); 10676657Snate@binkert.org break; 10686657Snate@binkert.org } 10696657Snate@binkert.org''') 10706657Snate@binkert.org 10716657Snate@binkert.org code.indent() 10726657Snate@binkert.org code.indent() 10736657Snate@binkert.org 10746657Snate@binkert.org # InPorts 10756657Snate@binkert.org # 10766657Snate@binkert.org for port in self.in_ports: 10776657Snate@binkert.org code.indent() 10786657Snate@binkert.org code('// ${ident}InPort $port') 10797567SBrad.Beckmann@amd.com if port.pairs.has_key("rank"): 10809996Snilay@cs.wisc.edu code('m_cur_in_port = ${{port.pairs["rank"]}};') 10817567SBrad.Beckmann@amd.com else: 10829996Snilay@cs.wisc.edu code('m_cur_in_port = 0;') 10836657Snate@binkert.org code('${{port["c_code_in_port"]}}') 10846657Snate@binkert.org code.dedent() 10856657Snate@binkert.org 10866657Snate@binkert.org code('') 10876657Snate@binkert.org 10886657Snate@binkert.org code.dedent() 10896657Snate@binkert.org code.dedent() 10906657Snate@binkert.org code(''' 10916657Snate@binkert.org break; // If we got this far, we have nothing left todo 10926657Snate@binkert.org } 10936657Snate@binkert.org} 10946657Snate@binkert.org''') 10956657Snate@binkert.org 10966657Snate@binkert.org code.write(path, "%s_Wakeup.cc" % self.ident) 10976657Snate@binkert.org 10986657Snate@binkert.org def printCSwitch(self, path): 10996657Snate@binkert.org '''Output switch statement for transition table''' 11006657Snate@binkert.org 11016999Snate@binkert.org code = self.symtab.codeFormatter() 11026657Snate@binkert.org ident = self.ident 11036657Snate@binkert.org 11046657Snate@binkert.org code(''' 11056657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 11066657Snate@binkert.org// ${ident}: ${{self.short}} 11076657Snate@binkert.org 11087832Snate@binkert.org#include <cassert> 11097832Snate@binkert.org 11107805Snilay@cs.wisc.edu#include "base/misc.hh" 11117832Snate@binkert.org#include "base/trace.hh" 11128232Snate@binkert.org#include "debug/ProtocolTrace.hh" 11138232Snate@binkert.org#include "debug/RubyGenerated.hh" 11148229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 11158229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 11168229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 11178229Snate@binkert.org#include "mem/protocol/Types.hh" 11186657Snate@binkert.org#include "mem/ruby/common/Global.hh" 11196657Snate@binkert.org#include "mem/ruby/system/System.hh" 11206657Snate@binkert.org 11216657Snate@binkert.org#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event)) 11226657Snate@binkert.org 11236657Snate@binkert.org#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str()) 11246657Snate@binkert.org#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str("")) 11256657Snate@binkert.org 11267007Snate@binkert.orgTransitionResult 11277007Snate@binkert.org${ident}_Controller::doTransition(${ident}_Event event, 11287839Snilay@cs.wisc.edu''') 11297839Snilay@cs.wisc.edu if self.EntryType != None: 11307839Snilay@cs.wisc.edu code(''' 11317839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}* m_cache_entry_ptr, 11327839Snilay@cs.wisc.edu''') 11337839Snilay@cs.wisc.edu if self.TBEType != None: 11347839Snilay@cs.wisc.edu code(''' 11357839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}* m_tbe_ptr, 11367839Snilay@cs.wisc.edu''') 11377839Snilay@cs.wisc.edu code(''' 113810010Snilay@cs.wisc.edu const Address addr) 11396657Snate@binkert.org{ 11407839Snilay@cs.wisc.edu''') 11417839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11428337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, m_cache_entry_ptr, addr);') 11437839Snilay@cs.wisc.edu elif self.TBEType != None: 11448337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, addr);') 11457839Snilay@cs.wisc.edu elif self.EntryType != None: 11468337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_cache_entry_ptr, addr);') 11477839Snilay@cs.wisc.edu else: 11488337Snilay@cs.wisc.edu code('${ident}_State state = getState(addr);') 11497839Snilay@cs.wisc.edu 11507839Snilay@cs.wisc.edu code(''' 11516657Snate@binkert.org ${ident}_State next_state = state; 11526657Snate@binkert.org 11537780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "%s, Time: %lld, state: %s, event: %s, addr: %s\\n", 11549465Snilay@cs.wisc.edu *this, curCycle(), ${ident}_State_to_string(state), 11559171Snilay@cs.wisc.edu ${ident}_Event_to_string(event), addr); 11566657Snate@binkert.org 11577007Snate@binkert.org TransitionResult result = 11587839Snilay@cs.wisc.edu''') 11597839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11607839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, m_cache_entry_ptr, addr);') 11617839Snilay@cs.wisc.edu elif self.TBEType != None: 11627839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, addr);') 11637839Snilay@cs.wisc.edu elif self.EntryType != None: 11647839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_cache_entry_ptr, addr);') 11657839Snilay@cs.wisc.edu else: 11667839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, addr);') 11676657Snate@binkert.org 11687839Snilay@cs.wisc.edu code(''' 11696657Snate@binkert.org if (result == TransitionResult_Valid) { 11707780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "next_state: %s\\n", 11717780Snilay@cs.wisc.edu ${ident}_State_to_string(next_state)); 11729745Snilay@cs.wisc.edu countTransition(state, event); 11738266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15d %3s %10s%20s %6s>%-6s %s %s\\n", 11748266Sksewell@umich.edu curTick(), m_version, "${ident}", 11758266Sksewell@umich.edu ${ident}_Event_to_string(event), 11768266Sksewell@umich.edu ${ident}_State_to_string(state), 11778266Sksewell@umich.edu ${ident}_State_to_string(next_state), 11788266Sksewell@umich.edu addr, GET_TRANSITION_COMMENT()); 11796657Snate@binkert.org 11807832Snate@binkert.org CLEAR_TRANSITION_COMMENT(); 11817839Snilay@cs.wisc.edu''') 11827839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11838337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, m_cache_entry_ptr, addr, next_state);') 11848341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 11857839Snilay@cs.wisc.edu elif self.TBEType != None: 11868337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, addr, next_state);') 11878341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 11887839Snilay@cs.wisc.edu elif self.EntryType != None: 11898337Snilay@cs.wisc.edu code('setState(m_cache_entry_ptr, addr, next_state);') 11908341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 11917839Snilay@cs.wisc.edu else: 11928337Snilay@cs.wisc.edu code('setState(addr, next_state);') 11938341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 11947839Snilay@cs.wisc.edu 11957839Snilay@cs.wisc.edu code(''' 11966657Snate@binkert.org } else if (result == TransitionResult_ResourceStall) { 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, "Resource Stall"); 12036657Snate@binkert.org } else if (result == TransitionResult_ProtocolStall) { 12047780Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "stalling\\n"); 12058266Sksewell@umich.edu DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n", 12068266Sksewell@umich.edu curTick(), m_version, "${ident}", 12078266Sksewell@umich.edu ${ident}_Event_to_string(event), 12088266Sksewell@umich.edu ${ident}_State_to_string(state), 12098266Sksewell@umich.edu ${ident}_State_to_string(next_state), 12108266Sksewell@umich.edu addr, "Protocol Stall"); 12116657Snate@binkert.org } 12126657Snate@binkert.org 12136657Snate@binkert.org return result; 12146657Snate@binkert.org} 12156657Snate@binkert.org 12167007Snate@binkert.orgTransitionResult 12177007Snate@binkert.org${ident}_Controller::doTransitionWorker(${ident}_Event event, 12187007Snate@binkert.org ${ident}_State state, 12197007Snate@binkert.org ${ident}_State& next_state, 12207839Snilay@cs.wisc.edu''') 12217839Snilay@cs.wisc.edu 12227839Snilay@cs.wisc.edu if self.TBEType != None: 12237839Snilay@cs.wisc.edu code(''' 12247839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}*& m_tbe_ptr, 12257839Snilay@cs.wisc.edu''') 12267839Snilay@cs.wisc.edu if self.EntryType != None: 12277839Snilay@cs.wisc.edu code(''' 12287839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, 12297839Snilay@cs.wisc.edu''') 12307839Snilay@cs.wisc.edu code(''' 12317007Snate@binkert.org const Address& addr) 12326657Snate@binkert.org{ 12336657Snate@binkert.org switch(HASH_FUN(state, event)) { 12346657Snate@binkert.org''') 12356657Snate@binkert.org 12366657Snate@binkert.org # This map will allow suppress generating duplicate code 12376657Snate@binkert.org cases = orderdict() 12386657Snate@binkert.org 12396657Snate@binkert.org for trans in self.transitions: 12406657Snate@binkert.org case_string = "%s_State_%s, %s_Event_%s" % \ 12416657Snate@binkert.org (self.ident, trans.state.ident, self.ident, trans.event.ident) 12426657Snate@binkert.org 12436999Snate@binkert.org case = self.symtab.codeFormatter() 12446657Snate@binkert.org # Only set next_state if it changes 12456657Snate@binkert.org if trans.state != trans.nextState: 12466657Snate@binkert.org ns_ident = trans.nextState.ident 12476657Snate@binkert.org case('next_state = ${ident}_State_${ns_ident};') 12486657Snate@binkert.org 12496657Snate@binkert.org actions = trans.actions 12509104Shestness@cs.utexas.edu request_types = trans.request_types 12516657Snate@binkert.org 12526657Snate@binkert.org # Check for resources 12536657Snate@binkert.org case_sorter = [] 12546657Snate@binkert.org res = trans.resources 12556657Snate@binkert.org for key,val in res.iteritems(): 125610228Snilay@cs.wisc.edu val = ''' 12577007Snate@binkert.orgif (!%s.areNSlotsAvailable(%s)) 12586657Snate@binkert.org return TransitionResult_ResourceStall; 12596657Snate@binkert.org''' % (key.code, val) 12606657Snate@binkert.org case_sorter.append(val) 12616657Snate@binkert.org 12629105SBrad.Beckmann@amd.com # Check all of the request_types for resource constraints 12639105SBrad.Beckmann@amd.com for request_type in request_types: 12649105SBrad.Beckmann@amd.com val = ''' 12659105SBrad.Beckmann@amd.comif (!checkResourceAvailable(%s_RequestType_%s, addr)) { 12669105SBrad.Beckmann@amd.com return TransitionResult_ResourceStall; 12679105SBrad.Beckmann@amd.com} 12689105SBrad.Beckmann@amd.com''' % (self.ident, request_type.ident) 12699105SBrad.Beckmann@amd.com case_sorter.append(val) 12706657Snate@binkert.org 12716657Snate@binkert.org # Emit the code sequences in a sorted order. This makes the 12726657Snate@binkert.org # output deterministic (without this the output order can vary 12736657Snate@binkert.org # since Map's keys() on a vector of pointers is not deterministic 12746657Snate@binkert.org for c in sorted(case_sorter): 12756657Snate@binkert.org case("$c") 12766657Snate@binkert.org 12779104Shestness@cs.utexas.edu # Record access types for this transition 12789104Shestness@cs.utexas.edu for request_type in request_types: 12799104Shestness@cs.utexas.edu case('recordRequestType(${ident}_RequestType_${{request_type.ident}}, addr);') 12809104Shestness@cs.utexas.edu 12816657Snate@binkert.org # Figure out if we stall 12826657Snate@binkert.org stall = False 12836657Snate@binkert.org for action in actions: 12846657Snate@binkert.org if action.ident == "z_stall": 12856657Snate@binkert.org stall = True 12866657Snate@binkert.org break 12876657Snate@binkert.org 12886657Snate@binkert.org if stall: 12896657Snate@binkert.org case('return TransitionResult_ProtocolStall;') 12906657Snate@binkert.org else: 12917839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 12927839Snilay@cs.wisc.edu for action in actions: 12937839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, m_cache_entry_ptr, addr);') 12947839Snilay@cs.wisc.edu elif self.TBEType != None: 12957839Snilay@cs.wisc.edu for action in actions: 12967839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, addr);') 12977839Snilay@cs.wisc.edu elif self.EntryType != None: 12987839Snilay@cs.wisc.edu for action in actions: 12997839Snilay@cs.wisc.edu case('${{action.ident}}(m_cache_entry_ptr, addr);') 13007839Snilay@cs.wisc.edu else: 13017839Snilay@cs.wisc.edu for action in actions: 13027839Snilay@cs.wisc.edu case('${{action.ident}}(addr);') 13036657Snate@binkert.org case('return TransitionResult_Valid;') 13046657Snate@binkert.org 13056657Snate@binkert.org case = str(case) 13066657Snate@binkert.org 13076657Snate@binkert.org # Look to see if this transition code is unique. 13086657Snate@binkert.org if case not in cases: 13096657Snate@binkert.org cases[case] = [] 13106657Snate@binkert.org 13116657Snate@binkert.org cases[case].append(case_string) 13126657Snate@binkert.org 13136657Snate@binkert.org # Walk through all of the unique code blocks and spit out the 13146657Snate@binkert.org # corresponding case statement elements 13156657Snate@binkert.org for case,transitions in cases.iteritems(): 13166657Snate@binkert.org # Iterative over all the multiple transitions that share 13176657Snate@binkert.org # the same code 13186657Snate@binkert.org for trans in transitions: 13196657Snate@binkert.org code(' case HASH_FUN($trans):') 13206657Snate@binkert.org code(' $case') 13216657Snate@binkert.org 13226657Snate@binkert.org code(''' 13236657Snate@binkert.org default: 13247805Snilay@cs.wisc.edu fatal("Invalid transition\\n" 13258159SBrad.Beckmann@amd.com "%s time: %d addr: %s event: %s state: %s\\n", 13269465Snilay@cs.wisc.edu name(), curCycle(), addr, event, state); 13276657Snate@binkert.org } 13286657Snate@binkert.org return TransitionResult_Valid; 13296657Snate@binkert.org} 13306657Snate@binkert.org''') 13316657Snate@binkert.org code.write(path, "%s_Transitions.cc" % self.ident) 13326657Snate@binkert.org 13336657Snate@binkert.org 13346657Snate@binkert.org # ************************** 13356657Snate@binkert.org # ******* HTML Files ******* 13366657Snate@binkert.org # ************************** 13377007Snate@binkert.org def frameRef(self, click_href, click_target, over_href, over_num, text): 13386999Snate@binkert.org code = self.symtab.codeFormatter(fix_newlines=False) 13397007Snate@binkert.org code("""<A href=\"$click_href\" target=\"$click_target\" onmouseover=\" 13407007Snate@binkert.org if (parent.frames[$over_num].location != parent.location + '$over_href') { 13417007Snate@binkert.org parent.frames[$over_num].location='$over_href' 13427007Snate@binkert.org }\"> 13437007Snate@binkert.org ${{html.formatShorthand(text)}} 13447007Snate@binkert.org </A>""") 13456657Snate@binkert.org return str(code) 13466657Snate@binkert.org 13476657Snate@binkert.org def writeHTMLFiles(self, path): 13486657Snate@binkert.org # Create table with no row hilighted 13496657Snate@binkert.org self.printHTMLTransitions(path, None) 13506657Snate@binkert.org 13516657Snate@binkert.org # Generate transition tables 13526657Snate@binkert.org for state in self.states.itervalues(): 13536657Snate@binkert.org self.printHTMLTransitions(path, state) 13546657Snate@binkert.org 13556657Snate@binkert.org # Generate action descriptions 13566657Snate@binkert.org for action in self.actions.itervalues(): 13576657Snate@binkert.org name = "%s_action_%s.html" % (self.ident, action.ident) 13586657Snate@binkert.org code = html.createSymbol(action, "Action") 13596657Snate@binkert.org code.write(path, name) 13606657Snate@binkert.org 13616657Snate@binkert.org # Generate state descriptions 13626657Snate@binkert.org for state in self.states.itervalues(): 13636657Snate@binkert.org name = "%s_State_%s.html" % (self.ident, state.ident) 13646657Snate@binkert.org code = html.createSymbol(state, "State") 13656657Snate@binkert.org code.write(path, name) 13666657Snate@binkert.org 13676657Snate@binkert.org # Generate event descriptions 13686657Snate@binkert.org for event in self.events.itervalues(): 13696657Snate@binkert.org name = "%s_Event_%s.html" % (self.ident, event.ident) 13706657Snate@binkert.org code = html.createSymbol(event, "Event") 13716657Snate@binkert.org code.write(path, name) 13726657Snate@binkert.org 13736657Snate@binkert.org def printHTMLTransitions(self, path, active_state): 13746999Snate@binkert.org code = self.symtab.codeFormatter() 13756657Snate@binkert.org 13766657Snate@binkert.org code(''' 13777007Snate@binkert.org<HTML> 13787007Snate@binkert.org<BODY link="blue" vlink="blue"> 13796657Snate@binkert.org 13806657Snate@binkert.org<H1 align="center">${{html.formatShorthand(self.short)}}: 13816657Snate@binkert.org''') 13826657Snate@binkert.org code.indent() 13836657Snate@binkert.org for i,machine in enumerate(self.symtab.getAllType(StateMachine)): 13846657Snate@binkert.org mid = machine.ident 13856657Snate@binkert.org if i != 0: 13866657Snate@binkert.org extra = " - " 13876657Snate@binkert.org else: 13886657Snate@binkert.org extra = "" 13896657Snate@binkert.org if machine == self: 13906657Snate@binkert.org code('$extra$mid') 13916657Snate@binkert.org else: 13926657Snate@binkert.org code('$extra<A target="Table" href="${mid}_table.html">$mid</A>') 13936657Snate@binkert.org code.dedent() 13946657Snate@binkert.org 13956657Snate@binkert.org code(""" 13966657Snate@binkert.org</H1> 13976657Snate@binkert.org 13986657Snate@binkert.org<TABLE border=1> 13996657Snate@binkert.org<TR> 14006657Snate@binkert.org <TH> </TH> 14016657Snate@binkert.org""") 14026657Snate@binkert.org 14036657Snate@binkert.org for event in self.events.itervalues(): 14046657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 14056657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 14066657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 14076657Snate@binkert.org 14086657Snate@binkert.org code('</TR>') 14096657Snate@binkert.org # -- Body of table 14106657Snate@binkert.org for state in self.states.itervalues(): 14116657Snate@binkert.org # -- Each row 14126657Snate@binkert.org if state == active_state: 14136657Snate@binkert.org color = "yellow" 14146657Snate@binkert.org else: 14156657Snate@binkert.org color = "white" 14166657Snate@binkert.org 14176657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 14186657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 14196657Snate@binkert.org text = html.formatShorthand(state.short) 14206657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 14216657Snate@binkert.org code(''' 14226657Snate@binkert.org<TR> 14236657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 14246657Snate@binkert.org''') 14256657Snate@binkert.org 14266657Snate@binkert.org # -- One column for each event 14276657Snate@binkert.org for event in self.events.itervalues(): 14286657Snate@binkert.org trans = self.table.get((state,event), None) 14296657Snate@binkert.org if trans is None: 14306657Snate@binkert.org # This is the no transition case 14316657Snate@binkert.org if state == active_state: 14326657Snate@binkert.org color = "#C0C000" 14336657Snate@binkert.org else: 14346657Snate@binkert.org color = "lightgrey" 14356657Snate@binkert.org 14366657Snate@binkert.org code('<TD bgcolor=$color> </TD>') 14376657Snate@binkert.org continue 14386657Snate@binkert.org 14396657Snate@binkert.org next = trans.nextState 14406657Snate@binkert.org stall_action = False 14416657Snate@binkert.org 14426657Snate@binkert.org # -- Get the actions 14436657Snate@binkert.org for action in trans.actions: 14446657Snate@binkert.org if action.ident == "z_stall" or \ 14456657Snate@binkert.org action.ident == "zz_recycleMandatoryQueue": 14466657Snate@binkert.org stall_action = True 14476657Snate@binkert.org 14486657Snate@binkert.org # -- Print out "actions/next-state" 14496657Snate@binkert.org if stall_action: 14506657Snate@binkert.org if state == active_state: 14516657Snate@binkert.org color = "#C0C000" 14526657Snate@binkert.org else: 14536657Snate@binkert.org color = "lightgrey" 14546657Snate@binkert.org 14556657Snate@binkert.org elif active_state and next.ident == active_state.ident: 14566657Snate@binkert.org color = "aqua" 14576657Snate@binkert.org elif state == active_state: 14586657Snate@binkert.org color = "yellow" 14596657Snate@binkert.org else: 14606657Snate@binkert.org color = "white" 14616657Snate@binkert.org 14626657Snate@binkert.org code('<TD bgcolor=$color>') 14636657Snate@binkert.org for action in trans.actions: 14646657Snate@binkert.org href = "%s_action_%s.html" % (self.ident, action.ident) 14656657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", 14666657Snate@binkert.org action.short) 14677007Snate@binkert.org code(' $ref') 14686657Snate@binkert.org if next != state: 14696657Snate@binkert.org if trans.actions: 14706657Snate@binkert.org code('/') 14716657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, next.ident) 14726657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, next.ident) 14736657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", next.short) 14746657Snate@binkert.org code("$ref") 14757007Snate@binkert.org code("</TD>") 14766657Snate@binkert.org 14776657Snate@binkert.org # -- Each row 14786657Snate@binkert.org if state == active_state: 14796657Snate@binkert.org color = "yellow" 14806657Snate@binkert.org else: 14816657Snate@binkert.org color = "white" 14826657Snate@binkert.org 14836657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 14846657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 14856657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 14866657Snate@binkert.org code(''' 14876657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 14886657Snate@binkert.org</TR> 14896657Snate@binkert.org''') 14906657Snate@binkert.org code(''' 14917007Snate@binkert.org<!- Column footer-> 14926657Snate@binkert.org<TR> 14936657Snate@binkert.org <TH> </TH> 14946657Snate@binkert.org''') 14956657Snate@binkert.org 14966657Snate@binkert.org for event in self.events.itervalues(): 14976657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 14986657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 14996657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 15006657Snate@binkert.org code(''' 15016657Snate@binkert.org</TR> 15026657Snate@binkert.org</TABLE> 15036657Snate@binkert.org</BODY></HTML> 15046657Snate@binkert.org''') 15056657Snate@binkert.org 15066657Snate@binkert.org 15076657Snate@binkert.org if active_state: 15086657Snate@binkert.org name = "%s_table_%s.html" % (self.ident, active_state.ident) 15096657Snate@binkert.org else: 15106657Snate@binkert.org name = "%s_table.html" % self.ident 15116657Snate@binkert.org code.write(path, name) 15126657Snate@binkert.org 15136657Snate@binkert.org__all__ = [ "StateMachine" ] 1514