StateMachine.py revision 10311
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 5410311Snilay@cs.wisc.edu 5510311Snilay@cs.wisc.edu # Data members in the State Machine that have been declared before 5610311Snilay@cs.wisc.edu # the opening brace '{' of the machine. Note that these along with 5710311Snilay@cs.wisc.edu # the members in self.objects form the entire set of data members. 586657Snate@binkert.org self.config_parameters = config_parameters 5910311Snilay@cs.wisc.edu 609366Snilay@cs.wisc.edu self.prefetchers = [] 617839Snilay@cs.wisc.edu 626657Snate@binkert.org for param in config_parameters: 636882SBrad.Beckmann@amd.com if param.pointer: 6410308Snilay@cs.wisc.edu var = Var(symtab, param.ident, location, param.type_ast.type, 6510308Snilay@cs.wisc.edu "(*m_%s_ptr)" % param.ident, {}, self) 666882SBrad.Beckmann@amd.com else: 6710308Snilay@cs.wisc.edu var = Var(symtab, param.ident, location, param.type_ast.type, 6810308Snilay@cs.wisc.edu "m_%s" % param.ident, {}, self) 6910308Snilay@cs.wisc.edu 7010308Snilay@cs.wisc.edu self.symtab.registerSym(param.ident, var) 7110308Snilay@cs.wisc.edu 729366Snilay@cs.wisc.edu if str(param.type_ast.type) == "Prefetcher": 739366Snilay@cs.wisc.edu self.prefetchers.append(var) 746657Snate@binkert.org 756657Snate@binkert.org self.states = orderdict() 766657Snate@binkert.org self.events = orderdict() 776657Snate@binkert.org self.actions = orderdict() 789104Shestness@cs.utexas.edu self.request_types = orderdict() 796657Snate@binkert.org self.transitions = [] 806657Snate@binkert.org self.in_ports = [] 816657Snate@binkert.org self.functions = [] 8210311Snilay@cs.wisc.edu 8310311Snilay@cs.wisc.edu # Data members in the State Machine that have been declared inside 8410311Snilay@cs.wisc.edu # the {} machine. Note that these along with the config params 8510311Snilay@cs.wisc.edu # form the entire set of data members of the machine. 866657Snate@binkert.org self.objects = [] 877839Snilay@cs.wisc.edu self.TBEType = None 887839Snilay@cs.wisc.edu self.EntryType = None 896657Snate@binkert.org 906657Snate@binkert.org def __repr__(self): 916657Snate@binkert.org return "[StateMachine: %s]" % self.ident 926657Snate@binkert.org 936657Snate@binkert.org def addState(self, state): 946657Snate@binkert.org assert self.table is None 956657Snate@binkert.org self.states[state.ident] = state 966657Snate@binkert.org 976657Snate@binkert.org def addEvent(self, event): 986657Snate@binkert.org assert self.table is None 996657Snate@binkert.org self.events[event.ident] = event 1006657Snate@binkert.org 1016657Snate@binkert.org def addAction(self, action): 1026657Snate@binkert.org assert self.table is None 1036657Snate@binkert.org 1046657Snate@binkert.org # Check for duplicate action 1056657Snate@binkert.org for other in self.actions.itervalues(): 1066657Snate@binkert.org if action.ident == other.ident: 1076779SBrad.Beckmann@amd.com action.warning("Duplicate action definition: %s" % action.ident) 1086657Snate@binkert.org action.error("Duplicate action definition: %s" % action.ident) 1096657Snate@binkert.org if action.short == other.short: 1106657Snate@binkert.org other.warning("Duplicate action shorthand: %s" % other.ident) 1116657Snate@binkert.org other.warning(" shorthand = %s" % other.short) 1126657Snate@binkert.org action.warning("Duplicate action shorthand: %s" % action.ident) 1136657Snate@binkert.org action.error(" shorthand = %s" % action.short) 1146657Snate@binkert.org 1156657Snate@binkert.org self.actions[action.ident] = action 1166657Snate@binkert.org 1179104Shestness@cs.utexas.edu def addRequestType(self, request_type): 1189104Shestness@cs.utexas.edu assert self.table is None 1199104Shestness@cs.utexas.edu self.request_types[request_type.ident] = request_type 1209104Shestness@cs.utexas.edu 1216657Snate@binkert.org def addTransition(self, trans): 1226657Snate@binkert.org assert self.table is None 1236657Snate@binkert.org self.transitions.append(trans) 1246657Snate@binkert.org 1256657Snate@binkert.org def addInPort(self, var): 1266657Snate@binkert.org self.in_ports.append(var) 1276657Snate@binkert.org 1286657Snate@binkert.org def addFunc(self, func): 1296657Snate@binkert.org # register func in the symbol table 1306657Snate@binkert.org self.symtab.registerSym(str(func), func) 1316657Snate@binkert.org self.functions.append(func) 1326657Snate@binkert.org 1336657Snate@binkert.org def addObject(self, obj): 13410307Snilay@cs.wisc.edu self.symtab.registerSym(str(obj), obj) 1356657Snate@binkert.org self.objects.append(obj) 1366657Snate@binkert.org 1377839Snilay@cs.wisc.edu def addType(self, type): 1387839Snilay@cs.wisc.edu type_ident = '%s' % type.c_ident 1397839Snilay@cs.wisc.edu 1407839Snilay@cs.wisc.edu if type_ident == "%s_TBE" %self.ident: 1417839Snilay@cs.wisc.edu if self.TBEType != None: 1427839Snilay@cs.wisc.edu self.error("Multiple Transaction Buffer types in a " \ 1437839Snilay@cs.wisc.edu "single machine."); 1447839Snilay@cs.wisc.edu self.TBEType = type 1457839Snilay@cs.wisc.edu 1467839Snilay@cs.wisc.edu elif "interface" in type and "AbstractCacheEntry" == type["interface"]: 1477839Snilay@cs.wisc.edu if self.EntryType != None: 1487839Snilay@cs.wisc.edu self.error("Multiple AbstractCacheEntry types in a " \ 1497839Snilay@cs.wisc.edu "single machine."); 1507839Snilay@cs.wisc.edu self.EntryType = type 1517839Snilay@cs.wisc.edu 1526657Snate@binkert.org # Needs to be called before accessing the table 1536657Snate@binkert.org def buildTable(self): 1546657Snate@binkert.org assert self.table is None 1556657Snate@binkert.org 1566657Snate@binkert.org table = {} 1576657Snate@binkert.org 1586657Snate@binkert.org for trans in self.transitions: 1596657Snate@binkert.org # Track which actions we touch so we know if we use them 1606657Snate@binkert.org # all -- really this should be done for all symbols as 1616657Snate@binkert.org # part of the symbol table, then only trigger it for 1626657Snate@binkert.org # Actions, States, Events, etc. 1636657Snate@binkert.org 1646657Snate@binkert.org for action in trans.actions: 1656657Snate@binkert.org action.used = True 1666657Snate@binkert.org 1676657Snate@binkert.org index = (trans.state, trans.event) 1686657Snate@binkert.org if index in table: 1696657Snate@binkert.org table[index].warning("Duplicate transition: %s" % table[index]) 1706657Snate@binkert.org trans.error("Duplicate transition: %s" % trans) 1716657Snate@binkert.org table[index] = trans 1726657Snate@binkert.org 1736657Snate@binkert.org # Look at all actions to make sure we used them all 1746657Snate@binkert.org for action in self.actions.itervalues(): 1756657Snate@binkert.org if not action.used: 1766657Snate@binkert.org error_msg = "Unused action: %s" % action.ident 1776657Snate@binkert.org if "desc" in action: 1786657Snate@binkert.org error_msg += ", " + action.desc 1796657Snate@binkert.org action.warning(error_msg) 1806657Snate@binkert.org self.table = table 1816657Snate@binkert.org 1829219Spower.jg@gmail.com def writeCodeFiles(self, path, includes): 1836877Ssteve.reinhardt@amd.com self.printControllerPython(path) 1846657Snate@binkert.org self.printControllerHH(path) 1859219Spower.jg@gmail.com self.printControllerCC(path, includes) 1866657Snate@binkert.org self.printCSwitch(path) 1879219Spower.jg@gmail.com self.printCWakeup(path, includes) 1886657Snate@binkert.org 1896877Ssteve.reinhardt@amd.com def printControllerPython(self, path): 1906999Snate@binkert.org code = self.symtab.codeFormatter() 1916877Ssteve.reinhardt@amd.com ident = self.ident 19210308Snilay@cs.wisc.edu 1936877Ssteve.reinhardt@amd.com py_ident = "%s_Controller" % ident 1946877Ssteve.reinhardt@amd.com c_ident = "%s_Controller" % self.ident 19510308Snilay@cs.wisc.edu 1966877Ssteve.reinhardt@amd.com code(''' 1976877Ssteve.reinhardt@amd.comfrom m5.params import * 1986877Ssteve.reinhardt@amd.comfrom m5.SimObject import SimObject 1996877Ssteve.reinhardt@amd.comfrom Controller import RubyController 2006877Ssteve.reinhardt@amd.com 2016877Ssteve.reinhardt@amd.comclass $py_ident(RubyController): 2026877Ssteve.reinhardt@amd.com type = '$py_ident' 2039338SAndreas.Sandberg@arm.com cxx_header = 'mem/protocol/${c_ident}.hh' 2046877Ssteve.reinhardt@amd.com''') 2056877Ssteve.reinhardt@amd.com code.indent() 2066877Ssteve.reinhardt@amd.com for param in self.config_parameters: 2076877Ssteve.reinhardt@amd.com dflt_str = '' 20810308Snilay@cs.wisc.edu 20910308Snilay@cs.wisc.edu if param.rvalue is not None: 21010308Snilay@cs.wisc.edu dflt_str = str(param.rvalue.inline()) + ', ' 21110308Snilay@cs.wisc.edu 21210311Snilay@cs.wisc.edu if param.type_ast.type.c_ident == "MessageBuffer": 21310311Snilay@cs.wisc.edu if param["network"] == "To": 21410311Snilay@cs.wisc.edu code('${{param.ident}} = MasterPort(${dflt_str}"")') 21510311Snilay@cs.wisc.edu else: 21610311Snilay@cs.wisc.edu code('${{param.ident}} = SlavePort(${dflt_str}"")') 21710311Snilay@cs.wisc.edu 21810311Snilay@cs.wisc.edu elif python_class_map.has_key(param.type_ast.type.c_ident): 2196882SBrad.Beckmann@amd.com python_type = python_class_map[param.type_ast.type.c_ident] 22010308Snilay@cs.wisc.edu code('${{param.ident}} = Param.${{python_type}}(${dflt_str}"")') 22110308Snilay@cs.wisc.edu 2226882SBrad.Beckmann@amd.com else: 2236882SBrad.Beckmann@amd.com self.error("Unknown c++ to python class conversion for c++ " \ 2246882SBrad.Beckmann@amd.com "type: '%s'. Please update the python_class_map " \ 2256882SBrad.Beckmann@amd.com "in StateMachine.py", param.type_ast.type.c_ident) 2266877Ssteve.reinhardt@amd.com code.dedent() 2276877Ssteve.reinhardt@amd.com code.write(path, '%s.py' % py_ident) 2286877Ssteve.reinhardt@amd.com 2296877Ssteve.reinhardt@amd.com 2306657Snate@binkert.org def printControllerHH(self, path): 2316657Snate@binkert.org '''Output the method declarations for the class declaration''' 2326999Snate@binkert.org code = self.symtab.codeFormatter() 2336657Snate@binkert.org ident = self.ident 2346657Snate@binkert.org c_ident = "%s_Controller" % self.ident 2356657Snate@binkert.org 2366657Snate@binkert.org code(''' 2377007Snate@binkert.org/** \\file $c_ident.hh 2386657Snate@binkert.org * 2396657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 2406657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 2416657Snate@binkert.org */ 2426657Snate@binkert.org 2437007Snate@binkert.org#ifndef __${ident}_CONTROLLER_HH__ 2447007Snate@binkert.org#define __${ident}_CONTROLLER_HH__ 2456657Snate@binkert.org 2467002Snate@binkert.org#include <iostream> 2477002Snate@binkert.org#include <sstream> 2487002Snate@binkert.org#include <string> 2497002Snate@binkert.org 2506657Snate@binkert.org#include "mem/protocol/TransitionResult.hh" 2516657Snate@binkert.org#include "mem/protocol/Types.hh" 2528229Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 2538229Snate@binkert.org#include "mem/ruby/common/Global.hh" 2548229Snate@binkert.org#include "mem/ruby/slicc_interface/AbstractController.hh" 2558229Snate@binkert.org#include "params/$c_ident.hh" 2566657Snate@binkert.org''') 2576657Snate@binkert.org 2586657Snate@binkert.org seen_types = set() 2596657Snate@binkert.org for var in self.objects: 2606793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 2616657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 26210311Snilay@cs.wisc.edu seen_types.add(var.type.ident) 2636657Snate@binkert.org 2646657Snate@binkert.org # for adding information to the protocol debug trace 2656657Snate@binkert.org code(''' 2667002Snate@binkert.orgextern std::stringstream ${ident}_transitionComment; 2676657Snate@binkert.org 2687007Snate@binkert.orgclass $c_ident : public AbstractController 2697007Snate@binkert.org{ 2709271Snilay@cs.wisc.edu public: 2716877Ssteve.reinhardt@amd.com typedef ${c_ident}Params Params; 2726877Ssteve.reinhardt@amd.com $c_ident(const Params *p); 2736657Snate@binkert.org static int getNumControllers(); 2746877Ssteve.reinhardt@amd.com void init(); 27510311Snilay@cs.wisc.edu 2766657Snate@binkert.org MessageBuffer* getMandatoryQueue() const; 27710311Snilay@cs.wisc.edu void setNetQueue(const std::string& name, MessageBuffer *b); 2789745Snilay@cs.wisc.edu 2797002Snate@binkert.org void print(std::ostream& out) const; 2806657Snate@binkert.org void wakeup(); 28110012Snilay@cs.wisc.edu void resetStats(); 2829745Snilay@cs.wisc.edu void regStats(); 2839745Snilay@cs.wisc.edu void collateStats(); 2849745Snilay@cs.wisc.edu 2858683Snilay@cs.wisc.edu void recordCacheTrace(int cntrl, CacheRecorder* tr); 2868683Snilay@cs.wisc.edu Sequencer* getSequencer() const; 2877007Snate@binkert.org 2889302Snilay@cs.wisc.edu bool functionalReadBuffers(PacketPtr&); 2899302Snilay@cs.wisc.edu uint32_t functionalWriteBuffers(PacketPtr&); 2909302Snilay@cs.wisc.edu 2919745Snilay@cs.wisc.edu void countTransition(${ident}_State state, ${ident}_Event event); 2929745Snilay@cs.wisc.edu void possibleTransition(${ident}_State state, ${ident}_Event event); 2939745Snilay@cs.wisc.edu uint64 getEventCount(${ident}_Event event); 2949745Snilay@cs.wisc.edu bool isPossible(${ident}_State state, ${ident}_Event event); 2959745Snilay@cs.wisc.edu uint64 getTransitionCount(${ident}_State state, ${ident}_Event event); 2969745Snilay@cs.wisc.edu 2976657Snate@binkert.orgprivate: 2986657Snate@binkert.org''') 2996657Snate@binkert.org 3006657Snate@binkert.org code.indent() 3016657Snate@binkert.org # added by SS 3026657Snate@binkert.org for param in self.config_parameters: 3036882SBrad.Beckmann@amd.com if param.pointer: 3046882SBrad.Beckmann@amd.com code('${{param.type_ast.type}}* m_${{param.ident}}_ptr;') 3056882SBrad.Beckmann@amd.com else: 3066882SBrad.Beckmann@amd.com code('${{param.type_ast.type}} m_${{param.ident}};') 3076657Snate@binkert.org 3086657Snate@binkert.org code(''' 3097007Snate@binkert.orgTransitionResult doTransition(${ident}_Event event, 3107839Snilay@cs.wisc.edu''') 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 if self.TBEType != None: 3177839Snilay@cs.wisc.edu code(''' 3187839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}* m_tbe_ptr, 3197839Snilay@cs.wisc.edu''') 3207839Snilay@cs.wisc.edu 3217839Snilay@cs.wisc.edu code(''' 32210010Snilay@cs.wisc.edu const Address addr); 3237007Snate@binkert.org 3247007Snate@binkert.orgTransitionResult doTransitionWorker(${ident}_Event event, 3257007Snate@binkert.org ${ident}_State state, 3267007Snate@binkert.org ${ident}_State& next_state, 3277839Snilay@cs.wisc.edu''') 3287839Snilay@cs.wisc.edu 3297839Snilay@cs.wisc.edu if self.TBEType != None: 3307839Snilay@cs.wisc.edu code(''' 3317839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}*& m_tbe_ptr, 3327839Snilay@cs.wisc.edu''') 3337839Snilay@cs.wisc.edu if self.EntryType != None: 3347839Snilay@cs.wisc.edu code(''' 3357839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, 3367839Snilay@cs.wisc.edu''') 3377839Snilay@cs.wisc.edu 3387839Snilay@cs.wisc.edu code(''' 3397007Snate@binkert.org const Address& addr); 3407007Snate@binkert.org 3419745Snilay@cs.wisc.eduint m_counters[${ident}_State_NUM][${ident}_Event_NUM]; 3429745Snilay@cs.wisc.eduint m_event_counters[${ident}_Event_NUM]; 3439745Snilay@cs.wisc.edubool m_possible[${ident}_State_NUM][${ident}_Event_NUM]; 3449745Snilay@cs.wisc.edu 3459745Snilay@cs.wisc.edustatic std::vector<Stats::Vector *> eventVec; 3469745Snilay@cs.wisc.edustatic std::vector<std::vector<Stats::Vector *> > transVec; 3476657Snate@binkert.orgstatic int m_num_controllers; 3487007Snate@binkert.org 3496657Snate@binkert.org// Internal functions 3506657Snate@binkert.org''') 3516657Snate@binkert.org 3526657Snate@binkert.org for func in self.functions: 3536657Snate@binkert.org proto = func.prototype 3546657Snate@binkert.org if proto: 3556657Snate@binkert.org code('$proto') 3566657Snate@binkert.org 3577839Snilay@cs.wisc.edu if self.EntryType != None: 3587839Snilay@cs.wisc.edu code(''' 3597839Snilay@cs.wisc.edu 3607839Snilay@cs.wisc.edu// Set and Reset for cache_entry variable 3617839Snilay@cs.wisc.eduvoid set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry); 3627839Snilay@cs.wisc.eduvoid unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr); 3637839Snilay@cs.wisc.edu''') 3647839Snilay@cs.wisc.edu 3657839Snilay@cs.wisc.edu if self.TBEType != None: 3667839Snilay@cs.wisc.edu code(''' 3677839Snilay@cs.wisc.edu 3687839Snilay@cs.wisc.edu// Set and Reset for tbe variable 3697839Snilay@cs.wisc.eduvoid set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${ident}_TBE* m_new_tbe); 3707839Snilay@cs.wisc.eduvoid unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr); 3717839Snilay@cs.wisc.edu''') 3727839Snilay@cs.wisc.edu 37310121Snilay@cs.wisc.edu # Prototype the actions that the controller can take 3746657Snate@binkert.org code(''' 3756657Snate@binkert.org 3766657Snate@binkert.org// Actions 3776657Snate@binkert.org''') 3787839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 3797839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3807839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 38110121Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& ' 38210121Snilay@cs.wisc.edu 'm_tbe_ptr, ${{self.EntryType.c_ident}}*& ' 38310121Snilay@cs.wisc.edu 'm_cache_entry_ptr, const Address& addr);') 3847839Snilay@cs.wisc.edu elif self.TBEType != None: 3857839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3867839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 38710121Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& ' 38810121Snilay@cs.wisc.edu 'm_tbe_ptr, const Address& addr);') 3897839Snilay@cs.wisc.edu elif self.EntryType != None: 3907839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3917839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 39210121Snilay@cs.wisc.edu code('void ${{action.ident}}(${{self.EntryType.c_ident}}*& ' 39310121Snilay@cs.wisc.edu 'm_cache_entry_ptr, const Address& addr);') 3947839Snilay@cs.wisc.edu else: 3957839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 3967839Snilay@cs.wisc.edu code('/** \\brief ${{action.desc}} */') 3977839Snilay@cs.wisc.edu code('void ${{action.ident}}(const Address& addr);') 3986657Snate@binkert.org 3996657Snate@binkert.org # the controller internal variables 4006657Snate@binkert.org code(''' 4016657Snate@binkert.org 4027007Snate@binkert.org// Objects 4036657Snate@binkert.org''') 4046657Snate@binkert.org for var in self.objects: 4059273Snilay@cs.wisc.edu th = var.get("template", "") 40610305Snilay@cs.wisc.edu code('${{var.type.c_ident}}$th* m_${{var.ident}}_ptr;') 4076657Snate@binkert.org 4086657Snate@binkert.org code.dedent() 4096657Snate@binkert.org code('};') 4107007Snate@binkert.org code('#endif // __${ident}_CONTROLLER_H__') 4116657Snate@binkert.org code.write(path, '%s.hh' % c_ident) 4126657Snate@binkert.org 4139219Spower.jg@gmail.com def printControllerCC(self, path, includes): 4146657Snate@binkert.org '''Output the actions for performing the actions''' 4156657Snate@binkert.org 4166999Snate@binkert.org code = self.symtab.codeFormatter() 4176657Snate@binkert.org ident = self.ident 4186657Snate@binkert.org c_ident = "%s_Controller" % self.ident 4196657Snate@binkert.org 4206657Snate@binkert.org code(''' 4217007Snate@binkert.org/** \\file $c_ident.cc 4226657Snate@binkert.org * 4236657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4246657Snate@binkert.org * Created by slicc definition of Module "${{self.short}}" 4256657Snate@binkert.org */ 4266657Snate@binkert.org 4278946Sandreas.hansson@arm.com#include <sys/types.h> 4288946Sandreas.hansson@arm.com#include <unistd.h> 4298946Sandreas.hansson@arm.com 4307832Snate@binkert.org#include <cassert> 4317002Snate@binkert.org#include <sstream> 4327002Snate@binkert.org#include <string> 4337002Snate@binkert.org 4348641Snate@binkert.org#include "base/compiler.hh" 4357056Snate@binkert.org#include "base/cprintf.hh" 4368232Snate@binkert.org#include "debug/RubyGenerated.hh" 4378232Snate@binkert.org#include "debug/RubySlicc.hh" 4386657Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 4398229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 4406657Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 4416657Snate@binkert.org#include "mem/protocol/Types.hh" 4427056Snate@binkert.org#include "mem/ruby/common/Global.hh" 4436657Snate@binkert.org#include "mem/ruby/system/System.hh" 4449219Spower.jg@gmail.com''') 4459219Spower.jg@gmail.com for include_path in includes: 4469219Spower.jg@gmail.com code('#include "${{include_path}}"') 4479219Spower.jg@gmail.com 4489219Spower.jg@gmail.com code(''' 4497002Snate@binkert.org 4507002Snate@binkert.orgusing namespace std; 4516657Snate@binkert.org''') 4526657Snate@binkert.org 4536657Snate@binkert.org # include object classes 4546657Snate@binkert.org seen_types = set() 4556657Snate@binkert.org for var in self.objects: 4566793SBrad.Beckmann@amd.com if var.type.ident not in seen_types and not var.type.isPrimitive: 4576657Snate@binkert.org code('#include "mem/protocol/${{var.type.c_ident}}.hh"') 4586657Snate@binkert.org seen_types.add(var.type.ident) 4596657Snate@binkert.org 46010121Snilay@cs.wisc.edu num_in_ports = len(self.in_ports) 46110121Snilay@cs.wisc.edu 4626657Snate@binkert.org code(''' 4636877Ssteve.reinhardt@amd.com$c_ident * 4646877Ssteve.reinhardt@amd.com${c_ident}Params::create() 4656877Ssteve.reinhardt@amd.com{ 4666877Ssteve.reinhardt@amd.com return new $c_ident(this); 4676877Ssteve.reinhardt@amd.com} 4686877Ssteve.reinhardt@amd.com 4696657Snate@binkert.orgint $c_ident::m_num_controllers = 0; 4709745Snilay@cs.wisc.edustd::vector<Stats::Vector *> $c_ident::eventVec; 4719745Snilay@cs.wisc.edustd::vector<std::vector<Stats::Vector *> > $c_ident::transVec; 4726657Snate@binkert.org 4737007Snate@binkert.org// for adding information to the protocol debug trace 4746657Snate@binkert.orgstringstream ${ident}_transitionComment; 4759801Snilay@cs.wisc.edu 4769801Snilay@cs.wisc.edu#ifndef NDEBUG 4776657Snate@binkert.org#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str) 4789801Snilay@cs.wisc.edu#else 4799801Snilay@cs.wisc.edu#define APPEND_TRANSITION_COMMENT(str) do {} while (0) 4809801Snilay@cs.wisc.edu#endif 4817007Snate@binkert.org 4826657Snate@binkert.org/** \\brief constructor */ 4836877Ssteve.reinhardt@amd.com$c_ident::$c_ident(const Params *p) 4846877Ssteve.reinhardt@amd.com : AbstractController(p) 4856657Snate@binkert.org{ 48610078Snilay@cs.wisc.edu m_machineID.type = MachineType_${ident}; 48710078Snilay@cs.wisc.edu m_machineID.num = m_version; 48810121Snilay@cs.wisc.edu m_num_controllers++; 48910121Snilay@cs.wisc.edu 49010121Snilay@cs.wisc.edu m_in_ports = $num_in_ports; 4916657Snate@binkert.org''') 4926657Snate@binkert.org code.indent() 4936882SBrad.Beckmann@amd.com 4946882SBrad.Beckmann@amd.com # 4956882SBrad.Beckmann@amd.com # After initializing the universal machine parameters, initialize the 49610121Snilay@cs.wisc.edu # this machines config parameters. Also if these configuration params 49710121Snilay@cs.wisc.edu # include a sequencer, connect the it to the controller. 4986882SBrad.Beckmann@amd.com # 4996877Ssteve.reinhardt@amd.com for param in self.config_parameters: 50010311Snilay@cs.wisc.edu 50110311Snilay@cs.wisc.edu # Do not initialize messgage buffers since they are initialized 50210311Snilay@cs.wisc.edu # when the port based connections are made. 50310311Snilay@cs.wisc.edu if param.type_ast.type.c_ident == "MessageBuffer": 50410311Snilay@cs.wisc.edu continue 50510311Snilay@cs.wisc.edu 5066882SBrad.Beckmann@amd.com if param.pointer: 50710308Snilay@cs.wisc.edu code('m_${{param.ident}}_ptr = p->${{param.ident}};') 5086882SBrad.Beckmann@amd.com else: 50910308Snilay@cs.wisc.edu code('m_${{param.ident}} = p->${{param.ident}};') 51010311Snilay@cs.wisc.edu 51110308Snilay@cs.wisc.edu if re.compile("sequencer").search(param.ident): 51210308Snilay@cs.wisc.edu code('m_${{param.ident}}_ptr->setController(this);') 5136888SBrad.Beckmann@amd.com 5146657Snate@binkert.org for var in self.objects: 5156657Snate@binkert.org if var.ident.find("mandatoryQueue") >= 0: 5169508Snilay@cs.wisc.edu code(''' 51710305Snilay@cs.wisc.edum_${{var.ident}}_ptr = new ${{var.type.c_ident}}(); 51810305Snilay@cs.wisc.edum_${{var.ident}}_ptr->setReceiver(this); 5199508Snilay@cs.wisc.edu''') 5206657Snate@binkert.org 5219595Snilay@cs.wisc.edu code(''' 5229745Snilay@cs.wisc.edu 5239745Snilay@cs.wisc.edufor (int state = 0; state < ${ident}_State_NUM; state++) { 5249745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 5259745Snilay@cs.wisc.edu m_possible[state][event] = false; 5269745Snilay@cs.wisc.edu m_counters[state][event] = 0; 5279745Snilay@cs.wisc.edu } 5289745Snilay@cs.wisc.edu} 5299745Snilay@cs.wisc.edufor (int event = 0; event < ${ident}_Event_NUM; event++) { 5309745Snilay@cs.wisc.edu m_event_counters[event] = 0; 5319745Snilay@cs.wisc.edu} 5329595Snilay@cs.wisc.edu''') 5336657Snate@binkert.org code.dedent() 5346657Snate@binkert.org code(''' 5356657Snate@binkert.org} 5366657Snate@binkert.org 5377007Snate@binkert.orgvoid 53810311Snilay@cs.wisc.edu$c_ident::setNetQueue(const std::string& name, MessageBuffer *b) 53910311Snilay@cs.wisc.edu{ 54010311Snilay@cs.wisc.edu MachineType machine_type = string_to_MachineType("${{self.ident}}"); 54110311Snilay@cs.wisc.edu int base M5_VAR_USED = MachineType_base_number(machine_type); 54210311Snilay@cs.wisc.edu 54310311Snilay@cs.wisc.edu''') 54410311Snilay@cs.wisc.edu code.indent() 54510311Snilay@cs.wisc.edu 54610311Snilay@cs.wisc.edu # set for maintaining the vnet, direction pairs already seen for this 54710311Snilay@cs.wisc.edu # machine. This map helps in implementing the check for avoiding 54810311Snilay@cs.wisc.edu # multiple message buffers being mapped to the same vnet. 54910311Snilay@cs.wisc.edu vnet_dir_set = set() 55010311Snilay@cs.wisc.edu 55110311Snilay@cs.wisc.edu for var in self.config_parameters: 55210311Snilay@cs.wisc.edu if "network" in var: 55310311Snilay@cs.wisc.edu vtype = var.type_ast.type 55410311Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.ident 55510311Snilay@cs.wisc.edu 55610311Snilay@cs.wisc.edu code(''' 55710311Snilay@cs.wisc.eduif ("${{var.ident}}" == name) { 55810311Snilay@cs.wisc.edu $vid = b; 55910311Snilay@cs.wisc.edu assert($vid != NULL); 56010311Snilay@cs.wisc.edu''') 56110311Snilay@cs.wisc.edu code.indent() 56210311Snilay@cs.wisc.edu # Network port object 56310311Snilay@cs.wisc.edu network = var["network"] 56410311Snilay@cs.wisc.edu ordered = var["ordered"] 56510311Snilay@cs.wisc.edu 56610311Snilay@cs.wisc.edu if "virtual_network" in var: 56710311Snilay@cs.wisc.edu vnet = var["virtual_network"] 56810311Snilay@cs.wisc.edu vnet_type = var["vnet_type"] 56910311Snilay@cs.wisc.edu 57010311Snilay@cs.wisc.edu assert (vnet, network) not in vnet_dir_set 57110311Snilay@cs.wisc.edu vnet_dir_set.add((vnet,network)) 57210311Snilay@cs.wisc.edu 57310311Snilay@cs.wisc.edu code(''' 57410311Snilay@cs.wisc.edum_net_ptr->set${network}NetQueue(m_version + base, $ordered, $vnet, 57510311Snilay@cs.wisc.edu "$vnet_type", b); 57610311Snilay@cs.wisc.edu''') 57710311Snilay@cs.wisc.edu # Set the end 57810311Snilay@cs.wisc.edu if network == "To": 57910311Snilay@cs.wisc.edu code('$vid->setSender(this);') 58010311Snilay@cs.wisc.edu else: 58110311Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 58210311Snilay@cs.wisc.edu 58310311Snilay@cs.wisc.edu # Set ordering 58410311Snilay@cs.wisc.edu code('$vid->setOrdering(${{var["ordered"]}});') 58510311Snilay@cs.wisc.edu 58610311Snilay@cs.wisc.edu # Set randomization 58710311Snilay@cs.wisc.edu if "random" in var: 58810311Snilay@cs.wisc.edu # A buffer 58910311Snilay@cs.wisc.edu code('$vid->setRandomization(${{var["random"]}});') 59010311Snilay@cs.wisc.edu 59110311Snilay@cs.wisc.edu # Set Priority 59210311Snilay@cs.wisc.edu if "rank" in var: 59310311Snilay@cs.wisc.edu code('$vid->setPriority(${{var["rank"]}})') 59410311Snilay@cs.wisc.edu 59510311Snilay@cs.wisc.edu # Set buffer size 59610311Snilay@cs.wisc.edu code('$vid->resize(m_buffer_size);') 59710311Snilay@cs.wisc.edu 59810311Snilay@cs.wisc.edu if "recycle_latency" in var: 59910311Snilay@cs.wisc.edu code('$vid->setRecycleLatency( ' \ 60010311Snilay@cs.wisc.edu 'Cycles(${{var["recycle_latency"]}}));') 60110311Snilay@cs.wisc.edu else: 60210311Snilay@cs.wisc.edu code('$vid->setRecycleLatency(m_recycle_latency);') 60310311Snilay@cs.wisc.edu 60410311Snilay@cs.wisc.edu # set description (may be overriden later by port def) 60510311Snilay@cs.wisc.edu code(''' 60610311Snilay@cs.wisc.edu$vid->setDescription("[Version " + to_string(m_version) + ", ${ident}, name=${{var.ident}}]"); 60710311Snilay@cs.wisc.edu''') 60810311Snilay@cs.wisc.edu code.dedent() 60910311Snilay@cs.wisc.edu code('}\n') 61010311Snilay@cs.wisc.edu 61110311Snilay@cs.wisc.edu code.dedent() 61210311Snilay@cs.wisc.edu code(''' 61310311Snilay@cs.wisc.edu} 61410311Snilay@cs.wisc.edu 61510311Snilay@cs.wisc.eduvoid 6167007Snate@binkert.org$c_ident::init() 6176657Snate@binkert.org{ 6187007Snate@binkert.org // initialize objects 6197007Snate@binkert.org 6206657Snate@binkert.org''') 6216657Snate@binkert.org 6226657Snate@binkert.org code.indent() 62310311Snilay@cs.wisc.edu 6246657Snate@binkert.org for var in self.objects: 6256657Snate@binkert.org vtype = var.type 62610305Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.ident 6276657Snate@binkert.org if "network" not in var: 6286657Snate@binkert.org # Not a network port object 6296657Snate@binkert.org if "primitive" in vtype: 6306657Snate@binkert.org code('$vid = new ${{vtype.c_ident}};') 6316657Snate@binkert.org if "default" in var: 6326657Snate@binkert.org code('(*$vid) = ${{var["default"]}};') 6336657Snate@binkert.org else: 6346657Snate@binkert.org # Normal Object 6359595Snilay@cs.wisc.edu if var.ident.find("mandatoryQueue") < 0: 6369273Snilay@cs.wisc.edu th = var.get("template", "") 6376657Snate@binkert.org expr = "%s = new %s%s" % (vid, vtype.c_ident, th) 6386657Snate@binkert.org args = "" 6396657Snate@binkert.org if "non_obj" not in vtype and not vtype.isEnumeration: 6409364Snilay@cs.wisc.edu args = var.get("constructor", "") 6417007Snate@binkert.org code('$expr($args);') 6426657Snate@binkert.org 6436657Snate@binkert.org code('assert($vid != NULL);') 6446657Snate@binkert.org 6456657Snate@binkert.org if "default" in var: 6467007Snate@binkert.org code('*$vid = ${{var["default"]}}; // Object default') 6476657Snate@binkert.org elif "default" in vtype: 6487007Snate@binkert.org comment = "Type %s default" % vtype.ident 6497007Snate@binkert.org code('*$vid = ${{vtype["default"]}}; // $comment') 6506657Snate@binkert.org 6516657Snate@binkert.org # Set ordering 6529508Snilay@cs.wisc.edu if "ordered" in var: 6536657Snate@binkert.org # A buffer 6546657Snate@binkert.org code('$vid->setOrdering(${{var["ordered"]}});') 6556657Snate@binkert.org 6566657Snate@binkert.org # Set randomization 6576657Snate@binkert.org if "random" in var: 6586657Snate@binkert.org # A buffer 6596657Snate@binkert.org code('$vid->setRandomization(${{var["random"]}});') 6606657Snate@binkert.org 6616657Snate@binkert.org # Set Priority 6629508Snilay@cs.wisc.edu if vtype.isBuffer and "rank" in var: 6636657Snate@binkert.org code('$vid->setPriority(${{var["rank"]}});') 6647566SBrad.Beckmann@amd.com 6659508Snilay@cs.wisc.edu # Set sender and receiver for trigger queue 6669508Snilay@cs.wisc.edu if var.ident.find("triggerQueue") >= 0: 6679508Snilay@cs.wisc.edu code('$vid->setSender(this);') 6689508Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 6699508Snilay@cs.wisc.edu elif vtype.c_ident == "TimerTable": 6709508Snilay@cs.wisc.edu code('$vid->setClockObj(this);') 6719604Snilay@cs.wisc.edu elif var.ident.find("optionalQueue") >= 0: 6729604Snilay@cs.wisc.edu code('$vid->setSender(this);') 6739604Snilay@cs.wisc.edu code('$vid->setReceiver(this);') 6749508Snilay@cs.wisc.edu 6757566SBrad.Beckmann@amd.com if vtype.isBuffer: 6767566SBrad.Beckmann@amd.com if "recycle_latency" in var: 6779499Snilay@cs.wisc.edu code('$vid->setRecycleLatency( ' \ 6789499Snilay@cs.wisc.edu 'Cycles(${{var["recycle_latency"]}}));') 6797566SBrad.Beckmann@amd.com else: 6807566SBrad.Beckmann@amd.com code('$vid->setRecycleLatency(m_recycle_latency);') 6817566SBrad.Beckmann@amd.com 6829366Snilay@cs.wisc.edu # Set the prefetchers 6839366Snilay@cs.wisc.edu code() 6849366Snilay@cs.wisc.edu for prefetcher in self.prefetchers: 6859366Snilay@cs.wisc.edu code('${{prefetcher.code}}.setController(this);') 6867566SBrad.Beckmann@amd.com 6877672Snate@binkert.org code() 6886657Snate@binkert.org for port in self.in_ports: 6899465Snilay@cs.wisc.edu # Set the queue consumers 6906657Snate@binkert.org code('${{port.code}}.setConsumer(this);') 6919465Snilay@cs.wisc.edu # Set the queue descriptions 6927056Snate@binkert.org code('${{port.code}}.setDescription("[Version " + to_string(m_version) + ", $ident, $port]");') 6936657Snate@binkert.org 6946657Snate@binkert.org # Initialize the transition profiling 6957672Snate@binkert.org code() 6966657Snate@binkert.org for trans in self.transitions: 6976657Snate@binkert.org # Figure out if we stall 6986657Snate@binkert.org stall = False 6996657Snate@binkert.org for action in trans.actions: 7006657Snate@binkert.org if action.ident == "z_stall": 7016657Snate@binkert.org stall = True 7026657Snate@binkert.org 7036657Snate@binkert.org # Only possible if it is not a 'z' case 7046657Snate@binkert.org if not stall: 7056657Snate@binkert.org state = "%s_State_%s" % (self.ident, trans.state.ident) 7066657Snate@binkert.org event = "%s_Event_%s" % (self.ident, trans.event.ident) 7079745Snilay@cs.wisc.edu code('possibleTransition($state, $event);') 7086657Snate@binkert.org 7096657Snate@binkert.org code.dedent() 7109496Snilay@cs.wisc.edu code(''' 7119496Snilay@cs.wisc.edu AbstractController::init(); 71210012Snilay@cs.wisc.edu resetStats(); 7139496Snilay@cs.wisc.edu} 7149496Snilay@cs.wisc.edu''') 7156657Snate@binkert.org 71610121Snilay@cs.wisc.edu mq_ident = "NULL" 7176657Snate@binkert.org for port in self.in_ports: 7186657Snate@binkert.org if port.code.find("mandatoryQueue_ptr") >= 0: 71910305Snilay@cs.wisc.edu mq_ident = "m_mandatoryQueue_ptr" 7206657Snate@binkert.org 7218683Snilay@cs.wisc.edu seq_ident = "NULL" 7228683Snilay@cs.wisc.edu for param in self.config_parameters: 72310308Snilay@cs.wisc.edu if param.ident == "sequencer": 7248683Snilay@cs.wisc.edu assert(param.pointer) 72510308Snilay@cs.wisc.edu seq_ident = "m_%s_ptr" % param.ident 7268683Snilay@cs.wisc.edu 7276657Snate@binkert.org code(''' 7289745Snilay@cs.wisc.edu 7299745Snilay@cs.wisc.eduvoid 7309745Snilay@cs.wisc.edu$c_ident::regStats() 7319745Snilay@cs.wisc.edu{ 73210012Snilay@cs.wisc.edu AbstractController::regStats(); 73310012Snilay@cs.wisc.edu 7349745Snilay@cs.wisc.edu if (m_version == 0) { 7359745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7369745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7379745Snilay@cs.wisc.edu Stats::Vector *t = new Stats::Vector(); 7389745Snilay@cs.wisc.edu t->init(m_num_controllers); 73910012Snilay@cs.wisc.edu t->name(g_system_ptr->name() + ".${c_ident}." + 74010012Snilay@cs.wisc.edu ${ident}_Event_to_string(event)); 7419745Snilay@cs.wisc.edu t->flags(Stats::pdf | Stats::total | Stats::oneline | 7429745Snilay@cs.wisc.edu Stats::nozero); 7439745Snilay@cs.wisc.edu 7449745Snilay@cs.wisc.edu eventVec.push_back(t); 7459745Snilay@cs.wisc.edu } 7469745Snilay@cs.wisc.edu 7479745Snilay@cs.wisc.edu for (${ident}_State state = ${ident}_State_FIRST; 7489745Snilay@cs.wisc.edu state < ${ident}_State_NUM; ++state) { 7499745Snilay@cs.wisc.edu 7509745Snilay@cs.wisc.edu transVec.push_back(std::vector<Stats::Vector *>()); 7519745Snilay@cs.wisc.edu 7529745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7539745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7549745Snilay@cs.wisc.edu 7559745Snilay@cs.wisc.edu Stats::Vector *t = new Stats::Vector(); 7569745Snilay@cs.wisc.edu t->init(m_num_controllers); 75710012Snilay@cs.wisc.edu t->name(g_system_ptr->name() + ".${c_ident}." + 75810012Snilay@cs.wisc.edu ${ident}_State_to_string(state) + 7599745Snilay@cs.wisc.edu "." + ${ident}_Event_to_string(event)); 7609745Snilay@cs.wisc.edu 7619745Snilay@cs.wisc.edu t->flags(Stats::pdf | Stats::total | Stats::oneline | 7629745Snilay@cs.wisc.edu Stats::nozero); 7639745Snilay@cs.wisc.edu transVec[state].push_back(t); 7649745Snilay@cs.wisc.edu } 7659745Snilay@cs.wisc.edu } 7669745Snilay@cs.wisc.edu } 7679745Snilay@cs.wisc.edu} 7689745Snilay@cs.wisc.edu 7699745Snilay@cs.wisc.eduvoid 7709745Snilay@cs.wisc.edu$c_ident::collateStats() 7719745Snilay@cs.wisc.edu{ 7729745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7739745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7749745Snilay@cs.wisc.edu for (unsigned int i = 0; i < m_num_controllers; ++i) { 7759745Snilay@cs.wisc.edu std::map<uint32_t, AbstractController *>::iterator it = 7769745Snilay@cs.wisc.edu g_abs_controls[MachineType_${ident}].find(i); 7779745Snilay@cs.wisc.edu assert(it != g_abs_controls[MachineType_${ident}].end()); 7789745Snilay@cs.wisc.edu (*eventVec[event])[i] = 7799745Snilay@cs.wisc.edu (($c_ident *)(*it).second)->getEventCount(event); 7809745Snilay@cs.wisc.edu } 7819745Snilay@cs.wisc.edu } 7829745Snilay@cs.wisc.edu 7839745Snilay@cs.wisc.edu for (${ident}_State state = ${ident}_State_FIRST; 7849745Snilay@cs.wisc.edu state < ${ident}_State_NUM; ++state) { 7859745Snilay@cs.wisc.edu 7869745Snilay@cs.wisc.edu for (${ident}_Event event = ${ident}_Event_FIRST; 7879745Snilay@cs.wisc.edu event < ${ident}_Event_NUM; ++event) { 7889745Snilay@cs.wisc.edu 7899745Snilay@cs.wisc.edu for (unsigned int i = 0; i < m_num_controllers; ++i) { 7909745Snilay@cs.wisc.edu std::map<uint32_t, AbstractController *>::iterator it = 7919745Snilay@cs.wisc.edu g_abs_controls[MachineType_${ident}].find(i); 7929745Snilay@cs.wisc.edu assert(it != g_abs_controls[MachineType_${ident}].end()); 7939745Snilay@cs.wisc.edu (*transVec[state][event])[i] = 7949745Snilay@cs.wisc.edu (($c_ident *)(*it).second)->getTransitionCount(state, event); 7959745Snilay@cs.wisc.edu } 7969745Snilay@cs.wisc.edu } 7979745Snilay@cs.wisc.edu } 7989745Snilay@cs.wisc.edu} 7999745Snilay@cs.wisc.edu 8009745Snilay@cs.wisc.eduvoid 8019745Snilay@cs.wisc.edu$c_ident::countTransition(${ident}_State state, ${ident}_Event event) 8029745Snilay@cs.wisc.edu{ 8039745Snilay@cs.wisc.edu assert(m_possible[state][event]); 8049745Snilay@cs.wisc.edu m_counters[state][event]++; 8059745Snilay@cs.wisc.edu m_event_counters[event]++; 8069745Snilay@cs.wisc.edu} 8079745Snilay@cs.wisc.eduvoid 8089745Snilay@cs.wisc.edu$c_ident::possibleTransition(${ident}_State state, 8099745Snilay@cs.wisc.edu ${ident}_Event event) 8109745Snilay@cs.wisc.edu{ 8119745Snilay@cs.wisc.edu m_possible[state][event] = true; 8129745Snilay@cs.wisc.edu} 8139745Snilay@cs.wisc.edu 8149745Snilay@cs.wisc.eduuint64 8159745Snilay@cs.wisc.edu$c_ident::getEventCount(${ident}_Event event) 8169745Snilay@cs.wisc.edu{ 8179745Snilay@cs.wisc.edu return m_event_counters[event]; 8189745Snilay@cs.wisc.edu} 8199745Snilay@cs.wisc.edu 8209745Snilay@cs.wisc.edubool 8219745Snilay@cs.wisc.edu$c_ident::isPossible(${ident}_State state, ${ident}_Event event) 8229745Snilay@cs.wisc.edu{ 8239745Snilay@cs.wisc.edu return m_possible[state][event]; 8249745Snilay@cs.wisc.edu} 8259745Snilay@cs.wisc.edu 8269745Snilay@cs.wisc.eduuint64 8279745Snilay@cs.wisc.edu$c_ident::getTransitionCount(${ident}_State state, 8289745Snilay@cs.wisc.edu ${ident}_Event event) 8299745Snilay@cs.wisc.edu{ 8309745Snilay@cs.wisc.edu return m_counters[state][event]; 8319745Snilay@cs.wisc.edu} 8329745Snilay@cs.wisc.edu 8337007Snate@binkert.orgint 8347007Snate@binkert.org$c_ident::getNumControllers() 8357007Snate@binkert.org{ 8366657Snate@binkert.org return m_num_controllers; 8376657Snate@binkert.org} 8386657Snate@binkert.org 8397007Snate@binkert.orgMessageBuffer* 8407007Snate@binkert.org$c_ident::getMandatoryQueue() const 8417007Snate@binkert.org{ 8426657Snate@binkert.org return $mq_ident; 8436657Snate@binkert.org} 8446657Snate@binkert.org 8458683Snilay@cs.wisc.eduSequencer* 8468683Snilay@cs.wisc.edu$c_ident::getSequencer() const 8478683Snilay@cs.wisc.edu{ 8488683Snilay@cs.wisc.edu return $seq_ident; 8498683Snilay@cs.wisc.edu} 8508683Snilay@cs.wisc.edu 8517007Snate@binkert.orgvoid 8527007Snate@binkert.org$c_ident::print(ostream& out) const 8537007Snate@binkert.org{ 8547007Snate@binkert.org out << "[$c_ident " << m_version << "]"; 8557007Snate@binkert.org} 8566657Snate@binkert.org 85710012Snilay@cs.wisc.eduvoid $c_ident::resetStats() 8589745Snilay@cs.wisc.edu{ 8599745Snilay@cs.wisc.edu for (int state = 0; state < ${ident}_State_NUM; state++) { 8609745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 8619745Snilay@cs.wisc.edu m_counters[state][event] = 0; 8629745Snilay@cs.wisc.edu } 8639745Snilay@cs.wisc.edu } 8646902SBrad.Beckmann@amd.com 8659745Snilay@cs.wisc.edu for (int event = 0; event < ${ident}_Event_NUM; event++) { 8669745Snilay@cs.wisc.edu m_event_counters[event] = 0; 8679745Snilay@cs.wisc.edu } 8689745Snilay@cs.wisc.edu 86910012Snilay@cs.wisc.edu AbstractController::resetStats(); 8706902SBrad.Beckmann@amd.com} 8717839Snilay@cs.wisc.edu''') 8727839Snilay@cs.wisc.edu 8737839Snilay@cs.wisc.edu if self.EntryType != None: 8747839Snilay@cs.wisc.edu code(''' 8757839Snilay@cs.wisc.edu 8767839Snilay@cs.wisc.edu// Set and Reset for cache_entry variable 8777839Snilay@cs.wisc.eduvoid 8787839Snilay@cs.wisc.edu$c_ident::set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry) 8797839Snilay@cs.wisc.edu{ 8807839Snilay@cs.wisc.edu m_cache_entry_ptr = (${{self.EntryType.c_ident}}*)m_new_cache_entry; 8817839Snilay@cs.wisc.edu} 8827839Snilay@cs.wisc.edu 8837839Snilay@cs.wisc.eduvoid 8847839Snilay@cs.wisc.edu$c_ident::unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr) 8857839Snilay@cs.wisc.edu{ 8867839Snilay@cs.wisc.edu m_cache_entry_ptr = 0; 8877839Snilay@cs.wisc.edu} 8887839Snilay@cs.wisc.edu''') 8897839Snilay@cs.wisc.edu 8907839Snilay@cs.wisc.edu if self.TBEType != None: 8917839Snilay@cs.wisc.edu code(''' 8927839Snilay@cs.wisc.edu 8937839Snilay@cs.wisc.edu// Set and Reset for tbe variable 8947839Snilay@cs.wisc.eduvoid 8957839Snilay@cs.wisc.edu$c_ident::set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.TBEType.c_ident}}* m_new_tbe) 8967839Snilay@cs.wisc.edu{ 8977839Snilay@cs.wisc.edu m_tbe_ptr = m_new_tbe; 8987839Snilay@cs.wisc.edu} 8997839Snilay@cs.wisc.edu 9007839Snilay@cs.wisc.eduvoid 9017839Snilay@cs.wisc.edu$c_ident::unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr) 9027839Snilay@cs.wisc.edu{ 9037839Snilay@cs.wisc.edu m_tbe_ptr = NULL; 9047839Snilay@cs.wisc.edu} 9057839Snilay@cs.wisc.edu''') 9067839Snilay@cs.wisc.edu 9077839Snilay@cs.wisc.edu code(''' 9086902SBrad.Beckmann@amd.com 9098683Snilay@cs.wisc.eduvoid 9108683Snilay@cs.wisc.edu$c_ident::recordCacheTrace(int cntrl, CacheRecorder* tr) 9118683Snilay@cs.wisc.edu{ 9128683Snilay@cs.wisc.edu''') 9138683Snilay@cs.wisc.edu # 9148683Snilay@cs.wisc.edu # Record cache contents for all associated caches. 9158683Snilay@cs.wisc.edu # 9168683Snilay@cs.wisc.edu code.indent() 9178683Snilay@cs.wisc.edu for param in self.config_parameters: 9188683Snilay@cs.wisc.edu if param.type_ast.type.ident == "CacheMemory": 9198683Snilay@cs.wisc.edu assert(param.pointer) 9208683Snilay@cs.wisc.edu code('m_${{param.ident}}_ptr->recordCacheContents(cntrl, tr);') 9218683Snilay@cs.wisc.edu 9228683Snilay@cs.wisc.edu code.dedent() 9238683Snilay@cs.wisc.edu code(''' 9248683Snilay@cs.wisc.edu} 9258683Snilay@cs.wisc.edu 9266657Snate@binkert.org// Actions 9276657Snate@binkert.org''') 9287839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 9297839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9307839Snilay@cs.wisc.edu if "c_code" not in action: 9317839Snilay@cs.wisc.edu continue 9326657Snate@binkert.org 9337839Snilay@cs.wisc.edu code(''' 9347839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9357839Snilay@cs.wisc.eduvoid 9367839Snilay@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) 9377839Snilay@cs.wisc.edu{ 9388055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9397839Snilay@cs.wisc.edu ${{action["c_code"]}} 9407839Snilay@cs.wisc.edu} 9416657Snate@binkert.org 9427839Snilay@cs.wisc.edu''') 9437839Snilay@cs.wisc.edu elif self.TBEType != None: 9447839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9457839Snilay@cs.wisc.edu if "c_code" not in action: 9467839Snilay@cs.wisc.edu continue 9477839Snilay@cs.wisc.edu 9487839Snilay@cs.wisc.edu code(''' 9497839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9507839Snilay@cs.wisc.eduvoid 9517839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr) 9527839Snilay@cs.wisc.edu{ 9538055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9547839Snilay@cs.wisc.edu ${{action["c_code"]}} 9557839Snilay@cs.wisc.edu} 9567839Snilay@cs.wisc.edu 9577839Snilay@cs.wisc.edu''') 9587839Snilay@cs.wisc.edu elif self.EntryType != None: 9597839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9607839Snilay@cs.wisc.edu if "c_code" not in action: 9617839Snilay@cs.wisc.edu continue 9627839Snilay@cs.wisc.edu 9637839Snilay@cs.wisc.edu code(''' 9647839Snilay@cs.wisc.edu/** \\brief ${{action.desc}} */ 9657839Snilay@cs.wisc.eduvoid 9667839Snilay@cs.wisc.edu$c_ident::${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr) 9677839Snilay@cs.wisc.edu{ 9688055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9697839Snilay@cs.wisc.edu ${{action["c_code"]}} 9707839Snilay@cs.wisc.edu} 9717839Snilay@cs.wisc.edu 9727839Snilay@cs.wisc.edu''') 9737839Snilay@cs.wisc.edu else: 9747839Snilay@cs.wisc.edu for action in self.actions.itervalues(): 9757839Snilay@cs.wisc.edu if "c_code" not in action: 9767839Snilay@cs.wisc.edu continue 9777839Snilay@cs.wisc.edu 9787839Snilay@cs.wisc.edu code(''' 9796657Snate@binkert.org/** \\brief ${{action.desc}} */ 9807007Snate@binkert.orgvoid 9817007Snate@binkert.org$c_ident::${{action.ident}}(const Address& addr) 9826657Snate@binkert.org{ 9838055Sksewell@umich.edu DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n"); 9846657Snate@binkert.org ${{action["c_code"]}} 9856657Snate@binkert.org} 9866657Snate@binkert.org 9876657Snate@binkert.org''') 9888478Snilay@cs.wisc.edu for func in self.functions: 9898478Snilay@cs.wisc.edu code(func.generateCode()) 9908478Snilay@cs.wisc.edu 9919302Snilay@cs.wisc.edu # Function for functional reads from messages buffered in the controller 9929302Snilay@cs.wisc.edu code(''' 9939302Snilay@cs.wisc.edubool 9949302Snilay@cs.wisc.edu$c_ident::functionalReadBuffers(PacketPtr& pkt) 9959302Snilay@cs.wisc.edu{ 9969302Snilay@cs.wisc.edu''') 9979302Snilay@cs.wisc.edu for var in self.objects: 9989302Snilay@cs.wisc.edu vtype = var.type 9999302Snilay@cs.wisc.edu if vtype.isBuffer: 100010305Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.ident 10019302Snilay@cs.wisc.edu code('if ($vid->functionalRead(pkt)) { return true; }') 100210311Snilay@cs.wisc.edu 100310311Snilay@cs.wisc.edu for var in self.config_parameters: 100410311Snilay@cs.wisc.edu vtype = var.type_ast.type 100510311Snilay@cs.wisc.edu if vtype.isBuffer: 100610311Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.ident 100710311Snilay@cs.wisc.edu code('if ($vid->functionalRead(pkt)) { return true; }') 100810311Snilay@cs.wisc.edu 10099302Snilay@cs.wisc.edu code(''' 10109302Snilay@cs.wisc.edu return false; 10119302Snilay@cs.wisc.edu} 10129302Snilay@cs.wisc.edu''') 10139302Snilay@cs.wisc.edu 10149302Snilay@cs.wisc.edu # Function for functional writes to messages buffered in the controller 10159302Snilay@cs.wisc.edu code(''' 10169302Snilay@cs.wisc.eduuint32_t 10179302Snilay@cs.wisc.edu$c_ident::functionalWriteBuffers(PacketPtr& pkt) 10189302Snilay@cs.wisc.edu{ 10199302Snilay@cs.wisc.edu uint32_t num_functional_writes = 0; 10209302Snilay@cs.wisc.edu''') 10219302Snilay@cs.wisc.edu for var in self.objects: 10229302Snilay@cs.wisc.edu vtype = var.type 10239302Snilay@cs.wisc.edu if vtype.isBuffer: 102410305Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.ident 10259302Snilay@cs.wisc.edu code('num_functional_writes += $vid->functionalWrite(pkt);') 102610311Snilay@cs.wisc.edu 102710311Snilay@cs.wisc.edu for var in self.config_parameters: 102810311Snilay@cs.wisc.edu vtype = var.type_ast.type 102910311Snilay@cs.wisc.edu if vtype.isBuffer: 103010311Snilay@cs.wisc.edu vid = "m_%s_ptr" % var.ident 103110311Snilay@cs.wisc.edu code('num_functional_writes += $vid->functionalWrite(pkt);') 103210311Snilay@cs.wisc.edu 10339302Snilay@cs.wisc.edu code(''' 10349302Snilay@cs.wisc.edu return num_functional_writes; 10359302Snilay@cs.wisc.edu} 10369302Snilay@cs.wisc.edu''') 10379302Snilay@cs.wisc.edu 10386657Snate@binkert.org code.write(path, "%s.cc" % c_ident) 10396657Snate@binkert.org 10409219Spower.jg@gmail.com def printCWakeup(self, path, includes): 10416657Snate@binkert.org '''Output the wakeup loop for the events''' 10426657Snate@binkert.org 10436999Snate@binkert.org code = self.symtab.codeFormatter() 10446657Snate@binkert.org ident = self.ident 10456657Snate@binkert.org 10469104Shestness@cs.utexas.edu outputRequest_types = True 10479104Shestness@cs.utexas.edu if len(self.request_types) == 0: 10489104Shestness@cs.utexas.edu outputRequest_types = False 10499104Shestness@cs.utexas.edu 10506657Snate@binkert.org code(''' 10516657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 10526657Snate@binkert.org// ${ident}: ${{self.short}} 10536657Snate@binkert.org 10548946Sandreas.hansson@arm.com#include <sys/types.h> 10558946Sandreas.hansson@arm.com#include <unistd.h> 10568946Sandreas.hansson@arm.com 10577832Snate@binkert.org#include <cassert> 10587832Snate@binkert.org 10597007Snate@binkert.org#include "base/misc.hh" 10608232Snate@binkert.org#include "debug/RubySlicc.hh" 10618229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 10628229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 10638229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 10649104Shestness@cs.utexas.edu''') 10659104Shestness@cs.utexas.edu 10669104Shestness@cs.utexas.edu if outputRequest_types: 10679104Shestness@cs.utexas.edu code('''#include "mem/protocol/${ident}_RequestType.hh"''') 10689104Shestness@cs.utexas.edu 10699104Shestness@cs.utexas.edu code(''' 10708229Snate@binkert.org#include "mem/protocol/Types.hh" 10716657Snate@binkert.org#include "mem/ruby/common/Global.hh" 10726657Snate@binkert.org#include "mem/ruby/system/System.hh" 10739219Spower.jg@gmail.com''') 10749219Spower.jg@gmail.com 10759219Spower.jg@gmail.com 10769219Spower.jg@gmail.com for include_path in includes: 10779219Spower.jg@gmail.com code('#include "${{include_path}}"') 10789219Spower.jg@gmail.com 10799219Spower.jg@gmail.com code(''' 10806657Snate@binkert.org 10817055Snate@binkert.orgusing namespace std; 10827055Snate@binkert.org 10837007Snate@binkert.orgvoid 10847007Snate@binkert.org${ident}_Controller::wakeup() 10856657Snate@binkert.org{ 10866657Snate@binkert.org int counter = 0; 10876657Snate@binkert.org while (true) { 10886657Snate@binkert.org // Some cases will put us into an infinite loop without this limit 10896657Snate@binkert.org assert(counter <= m_transitions_per_cycle); 10906657Snate@binkert.org if (counter == m_transitions_per_cycle) { 10917007Snate@binkert.org // Count how often we are fully utilized 10929496Snilay@cs.wisc.edu m_fully_busy_cycles++; 10937007Snate@binkert.org 10947007Snate@binkert.org // Wakeup in another cycle and try again 10959499Snilay@cs.wisc.edu scheduleEvent(Cycles(1)); 10966657Snate@binkert.org break; 10976657Snate@binkert.org } 10986657Snate@binkert.org''') 10996657Snate@binkert.org 11006657Snate@binkert.org code.indent() 11016657Snate@binkert.org code.indent() 11026657Snate@binkert.org 11036657Snate@binkert.org # InPorts 11046657Snate@binkert.org # 11056657Snate@binkert.org for port in self.in_ports: 11066657Snate@binkert.org code.indent() 11076657Snate@binkert.org code('// ${ident}InPort $port') 11087567SBrad.Beckmann@amd.com if port.pairs.has_key("rank"): 11099996Snilay@cs.wisc.edu code('m_cur_in_port = ${{port.pairs["rank"]}};') 11107567SBrad.Beckmann@amd.com else: 11119996Snilay@cs.wisc.edu code('m_cur_in_port = 0;') 11126657Snate@binkert.org code('${{port["c_code_in_port"]}}') 11136657Snate@binkert.org code.dedent() 11146657Snate@binkert.org 11156657Snate@binkert.org code('') 11166657Snate@binkert.org 11176657Snate@binkert.org code.dedent() 11186657Snate@binkert.org code.dedent() 11196657Snate@binkert.org code(''' 11206657Snate@binkert.org break; // If we got this far, we have nothing left todo 11216657Snate@binkert.org } 11226657Snate@binkert.org} 11236657Snate@binkert.org''') 11246657Snate@binkert.org 11256657Snate@binkert.org code.write(path, "%s_Wakeup.cc" % self.ident) 11266657Snate@binkert.org 11276657Snate@binkert.org def printCSwitch(self, path): 11286657Snate@binkert.org '''Output switch statement for transition table''' 11296657Snate@binkert.org 11306999Snate@binkert.org code = self.symtab.codeFormatter() 11316657Snate@binkert.org ident = self.ident 11326657Snate@binkert.org 11336657Snate@binkert.org code(''' 11346657Snate@binkert.org// Auto generated C++ code started by $__file__:$__line__ 11356657Snate@binkert.org// ${ident}: ${{self.short}} 11366657Snate@binkert.org 11377832Snate@binkert.org#include <cassert> 11387832Snate@binkert.org 11397805Snilay@cs.wisc.edu#include "base/misc.hh" 11407832Snate@binkert.org#include "base/trace.hh" 11418232Snate@binkert.org#include "debug/ProtocolTrace.hh" 11428232Snate@binkert.org#include "debug/RubyGenerated.hh" 11438229Snate@binkert.org#include "mem/protocol/${ident}_Controller.hh" 11448229Snate@binkert.org#include "mem/protocol/${ident}_Event.hh" 11458229Snate@binkert.org#include "mem/protocol/${ident}_State.hh" 11468229Snate@binkert.org#include "mem/protocol/Types.hh" 11476657Snate@binkert.org#include "mem/ruby/common/Global.hh" 11486657Snate@binkert.org#include "mem/ruby/system/System.hh" 11496657Snate@binkert.org 11506657Snate@binkert.org#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event)) 11516657Snate@binkert.org 11526657Snate@binkert.org#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str()) 11536657Snate@binkert.org#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str("")) 11546657Snate@binkert.org 11557007Snate@binkert.orgTransitionResult 11567007Snate@binkert.org${ident}_Controller::doTransition(${ident}_Event event, 11577839Snilay@cs.wisc.edu''') 11587839Snilay@cs.wisc.edu if self.EntryType != None: 11597839Snilay@cs.wisc.edu code(''' 11607839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}* m_cache_entry_ptr, 11617839Snilay@cs.wisc.edu''') 11627839Snilay@cs.wisc.edu if self.TBEType != None: 11637839Snilay@cs.wisc.edu code(''' 11647839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}* m_tbe_ptr, 11657839Snilay@cs.wisc.edu''') 11667839Snilay@cs.wisc.edu code(''' 116710010Snilay@cs.wisc.edu const Address addr) 11686657Snate@binkert.org{ 11697839Snilay@cs.wisc.edu''') 117010305Snilay@cs.wisc.edu code.indent() 117110305Snilay@cs.wisc.edu 11727839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11738337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, m_cache_entry_ptr, addr);') 11747839Snilay@cs.wisc.edu elif self.TBEType != None: 11758337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_tbe_ptr, addr);') 11767839Snilay@cs.wisc.edu elif self.EntryType != None: 11778337Snilay@cs.wisc.edu code('${ident}_State state = getState(m_cache_entry_ptr, addr);') 11787839Snilay@cs.wisc.edu else: 11798337Snilay@cs.wisc.edu code('${ident}_State state = getState(addr);') 11807839Snilay@cs.wisc.edu 11817839Snilay@cs.wisc.edu code(''' 118210305Snilay@cs.wisc.edu${ident}_State next_state = state; 11836657Snate@binkert.org 118410305Snilay@cs.wisc.eduDPRINTF(RubyGenerated, "%s, Time: %lld, state: %s, event: %s, addr: %s\\n", 118510305Snilay@cs.wisc.edu *this, curCycle(), ${ident}_State_to_string(state), 118610305Snilay@cs.wisc.edu ${ident}_Event_to_string(event), addr); 11876657Snate@binkert.org 118810305Snilay@cs.wisc.eduTransitionResult result = 11897839Snilay@cs.wisc.edu''') 11907839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 11917839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, m_cache_entry_ptr, addr);') 11927839Snilay@cs.wisc.edu elif self.TBEType != None: 11937839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_tbe_ptr, addr);') 11947839Snilay@cs.wisc.edu elif self.EntryType != None: 11957839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, m_cache_entry_ptr, addr);') 11967839Snilay@cs.wisc.edu else: 11977839Snilay@cs.wisc.edu code('doTransitionWorker(event, state, next_state, addr);') 11986657Snate@binkert.org 11997839Snilay@cs.wisc.edu code(''' 12006657Snate@binkert.org 120110305Snilay@cs.wisc.eduif (result == TransitionResult_Valid) { 120210305Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "next_state: %s\\n", 120310305Snilay@cs.wisc.edu ${ident}_State_to_string(next_state)); 120410305Snilay@cs.wisc.edu countTransition(state, event); 120510305Snilay@cs.wisc.edu 120610305Snilay@cs.wisc.edu DPRINTFR(ProtocolTrace, "%15d %3s %10s%20s %6s>%-6s %s %s\\n", 120710305Snilay@cs.wisc.edu curTick(), m_version, "${ident}", 120810305Snilay@cs.wisc.edu ${ident}_Event_to_string(event), 120910305Snilay@cs.wisc.edu ${ident}_State_to_string(state), 121010305Snilay@cs.wisc.edu ${ident}_State_to_string(next_state), 121110305Snilay@cs.wisc.edu addr, GET_TRANSITION_COMMENT()); 121210305Snilay@cs.wisc.edu 121310305Snilay@cs.wisc.edu CLEAR_TRANSITION_COMMENT(); 12147839Snilay@cs.wisc.edu''') 12157839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 12168337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, m_cache_entry_ptr, addr, next_state);') 12178341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 12187839Snilay@cs.wisc.edu elif self.TBEType != None: 12198337Snilay@cs.wisc.edu code('setState(m_tbe_ptr, addr, next_state);') 12208341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 12217839Snilay@cs.wisc.edu elif self.EntryType != None: 12228337Snilay@cs.wisc.edu code('setState(m_cache_entry_ptr, addr, next_state);') 12238341Snilay@cs.wisc.edu code('setAccessPermission(m_cache_entry_ptr, addr, next_state);') 12247839Snilay@cs.wisc.edu else: 12258337Snilay@cs.wisc.edu code('setState(addr, next_state);') 12268341Snilay@cs.wisc.edu code('setAccessPermission(addr, next_state);') 12277839Snilay@cs.wisc.edu 12287839Snilay@cs.wisc.edu code(''' 122910305Snilay@cs.wisc.edu} else if (result == TransitionResult_ResourceStall) { 123010305Snilay@cs.wisc.edu DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n", 123110305Snilay@cs.wisc.edu curTick(), m_version, "${ident}", 123210305Snilay@cs.wisc.edu ${ident}_Event_to_string(event), 123310305Snilay@cs.wisc.edu ${ident}_State_to_string(state), 123410305Snilay@cs.wisc.edu ${ident}_State_to_string(next_state), 123510305Snilay@cs.wisc.edu addr, "Resource Stall"); 123610305Snilay@cs.wisc.edu} else if (result == TransitionResult_ProtocolStall) { 123710305Snilay@cs.wisc.edu DPRINTF(RubyGenerated, "stalling\\n"); 123810305Snilay@cs.wisc.edu DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n", 123910305Snilay@cs.wisc.edu curTick(), m_version, "${ident}", 124010305Snilay@cs.wisc.edu ${ident}_Event_to_string(event), 124110305Snilay@cs.wisc.edu ${ident}_State_to_string(state), 124210305Snilay@cs.wisc.edu ${ident}_State_to_string(next_state), 124310305Snilay@cs.wisc.edu addr, "Protocol Stall"); 124410305Snilay@cs.wisc.edu} 12456657Snate@binkert.org 124610305Snilay@cs.wisc.edureturn result; 124710305Snilay@cs.wisc.edu''') 124810305Snilay@cs.wisc.edu code.dedent() 124910305Snilay@cs.wisc.edu code(''' 12506657Snate@binkert.org} 12516657Snate@binkert.org 12527007Snate@binkert.orgTransitionResult 12537007Snate@binkert.org${ident}_Controller::doTransitionWorker(${ident}_Event event, 12547007Snate@binkert.org ${ident}_State state, 12557007Snate@binkert.org ${ident}_State& next_state, 12567839Snilay@cs.wisc.edu''') 12577839Snilay@cs.wisc.edu 12587839Snilay@cs.wisc.edu if self.TBEType != None: 12597839Snilay@cs.wisc.edu code(''' 12607839Snilay@cs.wisc.edu ${{self.TBEType.c_ident}}*& m_tbe_ptr, 12617839Snilay@cs.wisc.edu''') 12627839Snilay@cs.wisc.edu if self.EntryType != None: 12637839Snilay@cs.wisc.edu code(''' 12647839Snilay@cs.wisc.edu ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, 12657839Snilay@cs.wisc.edu''') 12667839Snilay@cs.wisc.edu code(''' 12677007Snate@binkert.org const Address& addr) 12686657Snate@binkert.org{ 12696657Snate@binkert.org switch(HASH_FUN(state, event)) { 12706657Snate@binkert.org''') 12716657Snate@binkert.org 12726657Snate@binkert.org # This map will allow suppress generating duplicate code 12736657Snate@binkert.org cases = orderdict() 12746657Snate@binkert.org 12756657Snate@binkert.org for trans in self.transitions: 12766657Snate@binkert.org case_string = "%s_State_%s, %s_Event_%s" % \ 12776657Snate@binkert.org (self.ident, trans.state.ident, self.ident, trans.event.ident) 12786657Snate@binkert.org 12796999Snate@binkert.org case = self.symtab.codeFormatter() 12806657Snate@binkert.org # Only set next_state if it changes 12816657Snate@binkert.org if trans.state != trans.nextState: 12826657Snate@binkert.org ns_ident = trans.nextState.ident 12836657Snate@binkert.org case('next_state = ${ident}_State_${ns_ident};') 12846657Snate@binkert.org 12856657Snate@binkert.org actions = trans.actions 12869104Shestness@cs.utexas.edu request_types = trans.request_types 12876657Snate@binkert.org 12886657Snate@binkert.org # Check for resources 12896657Snate@binkert.org case_sorter = [] 12906657Snate@binkert.org res = trans.resources 12916657Snate@binkert.org for key,val in res.iteritems(): 129210228Snilay@cs.wisc.edu val = ''' 12937007Snate@binkert.orgif (!%s.areNSlotsAvailable(%s)) 12946657Snate@binkert.org return TransitionResult_ResourceStall; 12956657Snate@binkert.org''' % (key.code, val) 12966657Snate@binkert.org case_sorter.append(val) 12976657Snate@binkert.org 12989105SBrad.Beckmann@amd.com # Check all of the request_types for resource constraints 12999105SBrad.Beckmann@amd.com for request_type in request_types: 13009105SBrad.Beckmann@amd.com val = ''' 13019105SBrad.Beckmann@amd.comif (!checkResourceAvailable(%s_RequestType_%s, addr)) { 13029105SBrad.Beckmann@amd.com return TransitionResult_ResourceStall; 13039105SBrad.Beckmann@amd.com} 13049105SBrad.Beckmann@amd.com''' % (self.ident, request_type.ident) 13059105SBrad.Beckmann@amd.com case_sorter.append(val) 13066657Snate@binkert.org 13076657Snate@binkert.org # Emit the code sequences in a sorted order. This makes the 13086657Snate@binkert.org # output deterministic (without this the output order can vary 13096657Snate@binkert.org # since Map's keys() on a vector of pointers is not deterministic 13106657Snate@binkert.org for c in sorted(case_sorter): 13116657Snate@binkert.org case("$c") 13126657Snate@binkert.org 13139104Shestness@cs.utexas.edu # Record access types for this transition 13149104Shestness@cs.utexas.edu for request_type in request_types: 13159104Shestness@cs.utexas.edu case('recordRequestType(${ident}_RequestType_${{request_type.ident}}, addr);') 13169104Shestness@cs.utexas.edu 13176657Snate@binkert.org # Figure out if we stall 13186657Snate@binkert.org stall = False 13196657Snate@binkert.org for action in actions: 13206657Snate@binkert.org if action.ident == "z_stall": 13216657Snate@binkert.org stall = True 13226657Snate@binkert.org break 13236657Snate@binkert.org 13246657Snate@binkert.org if stall: 13256657Snate@binkert.org case('return TransitionResult_ProtocolStall;') 13266657Snate@binkert.org else: 13277839Snilay@cs.wisc.edu if self.TBEType != None and self.EntryType != None: 13287839Snilay@cs.wisc.edu for action in actions: 13297839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, m_cache_entry_ptr, addr);') 13307839Snilay@cs.wisc.edu elif self.TBEType != None: 13317839Snilay@cs.wisc.edu for action in actions: 13327839Snilay@cs.wisc.edu case('${{action.ident}}(m_tbe_ptr, addr);') 13337839Snilay@cs.wisc.edu elif self.EntryType != None: 13347839Snilay@cs.wisc.edu for action in actions: 13357839Snilay@cs.wisc.edu case('${{action.ident}}(m_cache_entry_ptr, addr);') 13367839Snilay@cs.wisc.edu else: 13377839Snilay@cs.wisc.edu for action in actions: 13387839Snilay@cs.wisc.edu case('${{action.ident}}(addr);') 13396657Snate@binkert.org case('return TransitionResult_Valid;') 13406657Snate@binkert.org 13416657Snate@binkert.org case = str(case) 13426657Snate@binkert.org 13436657Snate@binkert.org # Look to see if this transition code is unique. 13446657Snate@binkert.org if case not in cases: 13456657Snate@binkert.org cases[case] = [] 13466657Snate@binkert.org 13476657Snate@binkert.org cases[case].append(case_string) 13486657Snate@binkert.org 13496657Snate@binkert.org # Walk through all of the unique code blocks and spit out the 13506657Snate@binkert.org # corresponding case statement elements 13516657Snate@binkert.org for case,transitions in cases.iteritems(): 13526657Snate@binkert.org # Iterative over all the multiple transitions that share 13536657Snate@binkert.org # the same code 13546657Snate@binkert.org for trans in transitions: 13556657Snate@binkert.org code(' case HASH_FUN($trans):') 135610305Snilay@cs.wisc.edu code(' $case\n') 13576657Snate@binkert.org 13586657Snate@binkert.org code(''' 13596657Snate@binkert.org default: 13607805Snilay@cs.wisc.edu fatal("Invalid transition\\n" 13618159SBrad.Beckmann@amd.com "%s time: %d addr: %s event: %s state: %s\\n", 13629465Snilay@cs.wisc.edu name(), curCycle(), addr, event, state); 13636657Snate@binkert.org } 136410305Snilay@cs.wisc.edu 13656657Snate@binkert.org return TransitionResult_Valid; 13666657Snate@binkert.org} 13676657Snate@binkert.org''') 13686657Snate@binkert.org code.write(path, "%s_Transitions.cc" % self.ident) 13696657Snate@binkert.org 13706657Snate@binkert.org 13716657Snate@binkert.org # ************************** 13726657Snate@binkert.org # ******* HTML Files ******* 13736657Snate@binkert.org # ************************** 13747007Snate@binkert.org def frameRef(self, click_href, click_target, over_href, over_num, text): 13756999Snate@binkert.org code = self.symtab.codeFormatter(fix_newlines=False) 13767007Snate@binkert.org code("""<A href=\"$click_href\" target=\"$click_target\" onmouseover=\" 13777007Snate@binkert.org if (parent.frames[$over_num].location != parent.location + '$over_href') { 13787007Snate@binkert.org parent.frames[$over_num].location='$over_href' 13797007Snate@binkert.org }\"> 13807007Snate@binkert.org ${{html.formatShorthand(text)}} 13817007Snate@binkert.org </A>""") 13826657Snate@binkert.org return str(code) 13836657Snate@binkert.org 13846657Snate@binkert.org def writeHTMLFiles(self, path): 13856657Snate@binkert.org # Create table with no row hilighted 13866657Snate@binkert.org self.printHTMLTransitions(path, None) 13876657Snate@binkert.org 13886657Snate@binkert.org # Generate transition tables 13896657Snate@binkert.org for state in self.states.itervalues(): 13906657Snate@binkert.org self.printHTMLTransitions(path, state) 13916657Snate@binkert.org 13926657Snate@binkert.org # Generate action descriptions 13936657Snate@binkert.org for action in self.actions.itervalues(): 13946657Snate@binkert.org name = "%s_action_%s.html" % (self.ident, action.ident) 13956657Snate@binkert.org code = html.createSymbol(action, "Action") 13966657Snate@binkert.org code.write(path, name) 13976657Snate@binkert.org 13986657Snate@binkert.org # Generate state descriptions 13996657Snate@binkert.org for state in self.states.itervalues(): 14006657Snate@binkert.org name = "%s_State_%s.html" % (self.ident, state.ident) 14016657Snate@binkert.org code = html.createSymbol(state, "State") 14026657Snate@binkert.org code.write(path, name) 14036657Snate@binkert.org 14046657Snate@binkert.org # Generate event descriptions 14056657Snate@binkert.org for event in self.events.itervalues(): 14066657Snate@binkert.org name = "%s_Event_%s.html" % (self.ident, event.ident) 14076657Snate@binkert.org code = html.createSymbol(event, "Event") 14086657Snate@binkert.org code.write(path, name) 14096657Snate@binkert.org 14106657Snate@binkert.org def printHTMLTransitions(self, path, active_state): 14116999Snate@binkert.org code = self.symtab.codeFormatter() 14126657Snate@binkert.org 14136657Snate@binkert.org code(''' 14147007Snate@binkert.org<HTML> 14157007Snate@binkert.org<BODY link="blue" vlink="blue"> 14166657Snate@binkert.org 14176657Snate@binkert.org<H1 align="center">${{html.formatShorthand(self.short)}}: 14186657Snate@binkert.org''') 14196657Snate@binkert.org code.indent() 14206657Snate@binkert.org for i,machine in enumerate(self.symtab.getAllType(StateMachine)): 14216657Snate@binkert.org mid = machine.ident 14226657Snate@binkert.org if i != 0: 14236657Snate@binkert.org extra = " - " 14246657Snate@binkert.org else: 14256657Snate@binkert.org extra = "" 14266657Snate@binkert.org if machine == self: 14276657Snate@binkert.org code('$extra$mid') 14286657Snate@binkert.org else: 14296657Snate@binkert.org code('$extra<A target="Table" href="${mid}_table.html">$mid</A>') 14306657Snate@binkert.org code.dedent() 14316657Snate@binkert.org 14326657Snate@binkert.org code(""" 14336657Snate@binkert.org</H1> 14346657Snate@binkert.org 14356657Snate@binkert.org<TABLE border=1> 14366657Snate@binkert.org<TR> 14376657Snate@binkert.org <TH> </TH> 14386657Snate@binkert.org""") 14396657Snate@binkert.org 14406657Snate@binkert.org for event in self.events.itervalues(): 14416657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 14426657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 14436657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 14446657Snate@binkert.org 14456657Snate@binkert.org code('</TR>') 14466657Snate@binkert.org # -- Body of table 14476657Snate@binkert.org for state in self.states.itervalues(): 14486657Snate@binkert.org # -- Each row 14496657Snate@binkert.org if state == active_state: 14506657Snate@binkert.org color = "yellow" 14516657Snate@binkert.org else: 14526657Snate@binkert.org color = "white" 14536657Snate@binkert.org 14546657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 14556657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 14566657Snate@binkert.org text = html.formatShorthand(state.short) 14576657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 14586657Snate@binkert.org code(''' 14596657Snate@binkert.org<TR> 14606657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 14616657Snate@binkert.org''') 14626657Snate@binkert.org 14636657Snate@binkert.org # -- One column for each event 14646657Snate@binkert.org for event in self.events.itervalues(): 14656657Snate@binkert.org trans = self.table.get((state,event), None) 14666657Snate@binkert.org if trans is None: 14676657Snate@binkert.org # This is the no transition case 14686657Snate@binkert.org if state == active_state: 14696657Snate@binkert.org color = "#C0C000" 14706657Snate@binkert.org else: 14716657Snate@binkert.org color = "lightgrey" 14726657Snate@binkert.org 14736657Snate@binkert.org code('<TD bgcolor=$color> </TD>') 14746657Snate@binkert.org continue 14756657Snate@binkert.org 14766657Snate@binkert.org next = trans.nextState 14776657Snate@binkert.org stall_action = False 14786657Snate@binkert.org 14796657Snate@binkert.org # -- Get the actions 14806657Snate@binkert.org for action in trans.actions: 14816657Snate@binkert.org if action.ident == "z_stall" or \ 14826657Snate@binkert.org action.ident == "zz_recycleMandatoryQueue": 14836657Snate@binkert.org stall_action = True 14846657Snate@binkert.org 14856657Snate@binkert.org # -- Print out "actions/next-state" 14866657Snate@binkert.org if stall_action: 14876657Snate@binkert.org if state == active_state: 14886657Snate@binkert.org color = "#C0C000" 14896657Snate@binkert.org else: 14906657Snate@binkert.org color = "lightgrey" 14916657Snate@binkert.org 14926657Snate@binkert.org elif active_state and next.ident == active_state.ident: 14936657Snate@binkert.org color = "aqua" 14946657Snate@binkert.org elif state == active_state: 14956657Snate@binkert.org color = "yellow" 14966657Snate@binkert.org else: 14976657Snate@binkert.org color = "white" 14986657Snate@binkert.org 14996657Snate@binkert.org code('<TD bgcolor=$color>') 15006657Snate@binkert.org for action in trans.actions: 15016657Snate@binkert.org href = "%s_action_%s.html" % (self.ident, action.ident) 15026657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", 15036657Snate@binkert.org action.short) 15047007Snate@binkert.org code(' $ref') 15056657Snate@binkert.org if next != state: 15066657Snate@binkert.org if trans.actions: 15076657Snate@binkert.org code('/') 15086657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, next.ident) 15096657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, next.ident) 15106657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", next.short) 15116657Snate@binkert.org code("$ref") 15127007Snate@binkert.org code("</TD>") 15136657Snate@binkert.org 15146657Snate@binkert.org # -- Each row 15156657Snate@binkert.org if state == active_state: 15166657Snate@binkert.org color = "yellow" 15176657Snate@binkert.org else: 15186657Snate@binkert.org color = "white" 15196657Snate@binkert.org 15206657Snate@binkert.org click = "%s_table_%s.html" % (self.ident, state.ident) 15216657Snate@binkert.org over = "%s_State_%s.html" % (self.ident, state.ident) 15226657Snate@binkert.org ref = self.frameRef(click, "Table", over, "1", state.short) 15236657Snate@binkert.org code(''' 15246657Snate@binkert.org <TH bgcolor=$color>$ref</TH> 15256657Snate@binkert.org</TR> 15266657Snate@binkert.org''') 15276657Snate@binkert.org code(''' 15287007Snate@binkert.org<!- Column footer-> 15296657Snate@binkert.org<TR> 15306657Snate@binkert.org <TH> </TH> 15316657Snate@binkert.org''') 15326657Snate@binkert.org 15336657Snate@binkert.org for event in self.events.itervalues(): 15346657Snate@binkert.org href = "%s_Event_%s.html" % (self.ident, event.ident) 15356657Snate@binkert.org ref = self.frameRef(href, "Status", href, "1", event.short) 15366657Snate@binkert.org code('<TH bgcolor=white>$ref</TH>') 15376657Snate@binkert.org code(''' 15386657Snate@binkert.org</TR> 15396657Snate@binkert.org</TABLE> 15406657Snate@binkert.org</BODY></HTML> 15416657Snate@binkert.org''') 15426657Snate@binkert.org 15436657Snate@binkert.org 15446657Snate@binkert.org if active_state: 15456657Snate@binkert.org name = "%s_table_%s.html" % (self.ident, active_state.ident) 15466657Snate@binkert.org else: 15476657Snate@binkert.org name = "%s_table.html" % self.ident 15486657Snate@binkert.org code.write(path, name) 15496657Snate@binkert.org 15506657Snate@binkert.org__all__ = [ "StateMachine" ] 1551