Type.py revision 11025
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.util import PairContainer 316657Snate@binkert.orgfrom slicc.symbols.Symbol import Symbol 329302Snilay@cs.wisc.edufrom slicc.symbols.Var import Var 336657Snate@binkert.org 346657Snate@binkert.orgclass DataMember(PairContainer): 356657Snate@binkert.org def __init__(self, ident, type, pairs, init_code): 366657Snate@binkert.org super(DataMember, self).__init__(pairs) 376657Snate@binkert.org self.ident = ident 386657Snate@binkert.org self.type = type 396657Snate@binkert.org self.init_code = init_code 406657Snate@binkert.org 416657Snate@binkert.orgclass Enumeration(PairContainer): 426657Snate@binkert.org def __init__(self, ident, pairs): 436657Snate@binkert.org super(Enumeration, self).__init__(pairs) 446657Snate@binkert.org self.ident = ident 456657Snate@binkert.org 466657Snate@binkert.orgclass Type(Symbol): 476657Snate@binkert.org def __init__(self, table, ident, location, pairs, machine=None): 486657Snate@binkert.org super(Type, self).__init__(table, ident, location, pairs) 496657Snate@binkert.org self.c_ident = ident 506882SBrad.Beckmann@amd.com self.abstract_ident = "" 516657Snate@binkert.org if machine: 526657Snate@binkert.org if self.isExternal or self.isPrimitive: 536657Snate@binkert.org if "external_name" in self: 546657Snate@binkert.org self.c_ident = self["external_name"] 556657Snate@binkert.org else: 566657Snate@binkert.org # Append with machine name 576657Snate@binkert.org self.c_ident = "%s_%s" % (machine, ident) 586657Snate@binkert.org 596657Snate@binkert.org self.pairs.setdefault("desc", "No description avaliable") 606657Snate@binkert.org 616657Snate@binkert.org # check for interface that this Type implements 626657Snate@binkert.org if "interface" in self: 636657Snate@binkert.org interface = self["interface"] 6410895Snilay@cs.wisc.edu if interface in ("Message"): 656657Snate@binkert.org self["message"] = "yes" 666657Snate@binkert.org 676657Snate@binkert.org # FIXME - all of the following id comparisons are fragile hacks 6810228Snilay@cs.wisc.edu if self.ident in ("CacheMemory"): 696657Snate@binkert.org self["cache"] = "yes" 706657Snate@binkert.org 7110228Snilay@cs.wisc.edu if self.ident in ("TBETable"): 726657Snate@binkert.org self["tbe"] = "yes" 736657Snate@binkert.org 746657Snate@binkert.org if self.ident == "TimerTable": 756657Snate@binkert.org self["timer"] = "yes" 766657Snate@binkert.org 776657Snate@binkert.org if self.ident == "DirectoryMemory": 786657Snate@binkert.org self["dir"] = "yes" 796657Snate@binkert.org 806657Snate@binkert.org if self.ident == "PersistentTable": 816657Snate@binkert.org self["persistent"] = "yes" 826657Snate@binkert.org 836657Snate@binkert.org if self.ident == "Prefetcher": 846657Snate@binkert.org self["prefetcher"] = "yes" 856657Snate@binkert.org 866657Snate@binkert.org self.isMachineType = (ident == "MachineType") 876657Snate@binkert.org 888086SBrad.Beckmann@amd.com self.isStateDecl = ("state_decl" in self) 898086SBrad.Beckmann@amd.com self.statePermPairs = [] 908086SBrad.Beckmann@amd.com 916657Snate@binkert.org self.data_members = orderdict() 926657Snate@binkert.org self.methods = {} 936657Snate@binkert.org self.enums = orderdict() 946657Snate@binkert.org 956657Snate@binkert.org @property 966657Snate@binkert.org def isPrimitive(self): 976657Snate@binkert.org return "primitive" in self 9810895Snilay@cs.wisc.edu 996657Snate@binkert.org @property 1006657Snate@binkert.org def isMessage(self): 1016657Snate@binkert.org return "message" in self 1026657Snate@binkert.org @property 1036657Snate@binkert.org def isBuffer(self): 1046657Snate@binkert.org return "buffer" in self 1056657Snate@binkert.org @property 1066657Snate@binkert.org def isInPort(self): 1076657Snate@binkert.org return "inport" in self 1086657Snate@binkert.org @property 1096657Snate@binkert.org def isOutPort(self): 1106657Snate@binkert.org return "outport" in self 1116657Snate@binkert.org @property 1126657Snate@binkert.org def isEnumeration(self): 1136657Snate@binkert.org return "enumeration" in self 1146657Snate@binkert.org @property 1156657Snate@binkert.org def isExternal(self): 1166657Snate@binkert.org return "external" in self 1176657Snate@binkert.org @property 1186657Snate@binkert.org def isGlobal(self): 1196657Snate@binkert.org return "global" in self 1206657Snate@binkert.org @property 1216657Snate@binkert.org def isInterface(self): 1226657Snate@binkert.org return "interface" in self 1236657Snate@binkert.org 1246657Snate@binkert.org # Return false on error 1259298Snilay@cs.wisc.edu def addDataMember(self, ident, type, pairs, init_code): 1266657Snate@binkert.org if ident in self.data_members: 1276657Snate@binkert.org return False 1286657Snate@binkert.org 1296657Snate@binkert.org member = DataMember(ident, type, pairs, init_code) 1306657Snate@binkert.org self.data_members[ident] = member 1316657Snate@binkert.org 1329302Snilay@cs.wisc.edu var = Var(self.symtab, ident, self.location, type, 1339302Snilay@cs.wisc.edu "m_%s" % ident, {}, None) 1349302Snilay@cs.wisc.edu self.symtab.registerSym(ident, var) 1356657Snate@binkert.org return True 1366657Snate@binkert.org 1376657Snate@binkert.org def dataMemberType(self, ident): 1386657Snate@binkert.org return self.data_members[ident].type 1396657Snate@binkert.org 1406657Snate@binkert.org def methodId(self, name, param_type_vec): 1416657Snate@binkert.org return '_'.join([name] + [ pt.c_ident for pt in param_type_vec ]) 1426657Snate@binkert.org 1436882SBrad.Beckmann@amd.com def methodIdAbstract(self, name, param_type_vec): 1446882SBrad.Beckmann@amd.com return '_'.join([name] + [ pt.abstract_ident for pt in param_type_vec ]) 1456882SBrad.Beckmann@amd.com 1468086SBrad.Beckmann@amd.com def statePermPairAdd(self, state_name, perm_name): 1478086SBrad.Beckmann@amd.com self.statePermPairs.append([state_name, perm_name]) 1488086SBrad.Beckmann@amd.com 14910307Snilay@cs.wisc.edu def addFunc(self, func): 15010307Snilay@cs.wisc.edu ident = self.methodId(func.ident, func.param_types) 1516657Snate@binkert.org if ident in self.methods: 1526657Snate@binkert.org return False 1536657Snate@binkert.org 15410307Snilay@cs.wisc.edu self.methods[ident] = func 1559298Snilay@cs.wisc.edu return True 1569298Snilay@cs.wisc.edu 1579298Snilay@cs.wisc.edu def addEnum(self, ident, pairs): 1586657Snate@binkert.org if ident in self.enums: 1596657Snate@binkert.org return False 1606657Snate@binkert.org 1616657Snate@binkert.org self.enums[ident] = Enumeration(ident, pairs) 1626657Snate@binkert.org 1636657Snate@binkert.org # Add default 1646657Snate@binkert.org if "default" not in self: 1656657Snate@binkert.org self["default"] = "%s_NUM" % self.c_ident 1666657Snate@binkert.org 1676657Snate@binkert.org return True 1686657Snate@binkert.org 1699219Spower.jg@gmail.com def writeCodeFiles(self, path, includes): 1706657Snate@binkert.org if self.isExternal: 1716657Snate@binkert.org # Do nothing 1726657Snate@binkert.org pass 1736657Snate@binkert.org elif self.isEnumeration: 1746657Snate@binkert.org self.printEnumHH(path) 1756657Snate@binkert.org self.printEnumCC(path) 1766657Snate@binkert.org else: 1776657Snate@binkert.org # User defined structs and messages 1786657Snate@binkert.org self.printTypeHH(path) 1796657Snate@binkert.org self.printTypeCC(path) 1806657Snate@binkert.org 1816657Snate@binkert.org def printTypeHH(self, path): 1826999Snate@binkert.org code = self.symtab.codeFormatter() 1836657Snate@binkert.org code(''' 1846657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 1856657Snate@binkert.org * 1866657Snate@binkert.org * 1876657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 1886657Snate@binkert.org */ 1896657Snate@binkert.org 1907007Snate@binkert.org#ifndef __${{self.c_ident}}_HH__ 1917007Snate@binkert.org#define __${{self.c_ident}}_HH__ 1926657Snate@binkert.org 1937002Snate@binkert.org#include <iostream> 1947002Snate@binkert.org 1959466Snilay@cs.wisc.edu#include "mem/ruby/slicc_interface/RubySlicc_Util.hh" 1966657Snate@binkert.org''') 1976657Snate@binkert.org 1986657Snate@binkert.org for dm in self.data_members.values(): 1996657Snate@binkert.org if not dm.type.isPrimitive: 2006657Snate@binkert.org code('#include "mem/protocol/$0.hh"', dm.type.c_ident) 2016657Snate@binkert.org 2026657Snate@binkert.org parent = "" 2036657Snate@binkert.org if "interface" in self: 2046657Snate@binkert.org code('#include "mem/protocol/$0.hh"', self["interface"]) 2056657Snate@binkert.org parent = " : public %s" % self["interface"] 2066657Snate@binkert.org 2076657Snate@binkert.org code(''' 2087007Snate@binkert.org$klass ${{self.c_ident}}$parent 2097007Snate@binkert.org{ 2106657Snate@binkert.org public: 2119466Snilay@cs.wisc.edu ${{self.c_ident}} 2126657Snate@binkert.org''', klass="class") 2136657Snate@binkert.org 2149466Snilay@cs.wisc.edu if self.isMessage: 2159508Snilay@cs.wisc.edu code('(Tick curTime) : %s(curTime) {' % self["interface"]) 2169466Snilay@cs.wisc.edu else: 2179466Snilay@cs.wisc.edu code('()\n\t\t{') 2189466Snilay@cs.wisc.edu 2196657Snate@binkert.org code.indent() 2206657Snate@binkert.org if not self.isGlobal: 2216657Snate@binkert.org code.indent() 2226657Snate@binkert.org for dm in self.data_members.values(): 2236657Snate@binkert.org ident = dm.ident 2246657Snate@binkert.org if "default" in dm: 2256657Snate@binkert.org # look for default value 2266657Snate@binkert.org code('m_$ident = ${{dm["default"]}}; // default for this field') 2276657Snate@binkert.org elif "default" in dm.type: 2286657Snate@binkert.org # Look for the type default 2296657Snate@binkert.org tid = dm.type.c_ident 2306657Snate@binkert.org code('m_$ident = ${{dm.type["default"]}}; // default value of $tid') 2316657Snate@binkert.org else: 2326657Snate@binkert.org code('// m_$ident has no default') 2336657Snate@binkert.org code.dedent() 2346657Snate@binkert.org code('}') 2356657Snate@binkert.org 2367453Snate@binkert.org # ******** Copy constructor ******** 2377453Snate@binkert.org if not self.isGlobal: 2387453Snate@binkert.org code('${{self.c_ident}}(const ${{self.c_ident}}&other)') 2397453Snate@binkert.org 2407453Snate@binkert.org # Call superclass constructor 2417453Snate@binkert.org if "interface" in self: 2427453Snate@binkert.org code(' : ${{self["interface"]}}(other)') 2437453Snate@binkert.org 2447453Snate@binkert.org code('{') 2457453Snate@binkert.org code.indent() 2467453Snate@binkert.org 2477453Snate@binkert.org for dm in self.data_members.values(): 2487453Snate@binkert.org code('m_${{dm.ident}} = other.m_${{dm.ident}};') 2497453Snate@binkert.org 2507453Snate@binkert.org code.dedent() 2517453Snate@binkert.org code('}') 2527453Snate@binkert.org 2536657Snate@binkert.org # ******** Full init constructor ******** 2546657Snate@binkert.org if not self.isGlobal: 2556657Snate@binkert.org params = [ 'const %s& local_%s' % (dm.type.c_ident, dm.ident) \ 2566657Snate@binkert.org for dm in self.data_members.itervalues() ] 2579466Snilay@cs.wisc.edu params = ', '.join(params) 2586657Snate@binkert.org 2599466Snilay@cs.wisc.edu if self.isMessage: 2609508Snilay@cs.wisc.edu params = "const Tick curTime, " + params 2619466Snilay@cs.wisc.edu 2626657Snate@binkert.org code('${{self.c_ident}}($params)') 2636657Snate@binkert.org 2646657Snate@binkert.org # Call superclass constructor 2656657Snate@binkert.org if "interface" in self: 2669466Snilay@cs.wisc.edu if self.isMessage: 2679466Snilay@cs.wisc.edu code(' : ${{self["interface"]}}(curTime)') 2689466Snilay@cs.wisc.edu else: 2699466Snilay@cs.wisc.edu code(' : ${{self["interface"]}}()') 2706657Snate@binkert.org 2716657Snate@binkert.org code('{') 2726657Snate@binkert.org code.indent() 2736657Snate@binkert.org for dm in self.data_members.values(): 2746657Snate@binkert.org code('m_${{dm.ident}} = local_${{dm.ident}};') 2756657Snate@binkert.org if "nextLineCallHack" in dm: 2766657Snate@binkert.org code('m_${{dm.ident}}${{dm["nextLineCallHack"]}};') 2776657Snate@binkert.org 2786657Snate@binkert.org code.dedent() 2796657Snate@binkert.org code('}') 2806657Snate@binkert.org 2819466Snilay@cs.wisc.edu # create a clone member 28210472Sandreas.hansson@arm.com if self.isMessage: 28310472Sandreas.hansson@arm.com code(''' 28410472Sandreas.hansson@arm.comMsgPtr 28510472Sandreas.hansson@arm.comclone() const 28610472Sandreas.hansson@arm.com{ 28710472Sandreas.hansson@arm.com return std::shared_ptr<Message>(new ${{self.c_ident}}(*this)); 28810472Sandreas.hansson@arm.com} 28910472Sandreas.hansson@arm.com''') 29010472Sandreas.hansson@arm.com else: 29110472Sandreas.hansson@arm.com code(''' 2927453Snate@binkert.org${{self.c_ident}}* 2937007Snate@binkert.orgclone() const 2947007Snate@binkert.org{ 2957453Snate@binkert.org return new ${{self.c_ident}}(*this); 2967007Snate@binkert.org} 2976657Snate@binkert.org''') 2986657Snate@binkert.org 2996657Snate@binkert.org if not self.isGlobal: 3006657Snate@binkert.org # const Get methods for each field 3016657Snate@binkert.org code('// Const accessors methods for each field') 3026657Snate@binkert.org for dm in self.data_members.values(): 3036657Snate@binkert.org code(''' 3046657Snate@binkert.org/** \\brief Const accessor method for ${{dm.ident}} field. 3056657Snate@binkert.org * \\return ${{dm.ident}} field 3066657Snate@binkert.org */ 3077007Snate@binkert.orgconst ${{dm.type.c_ident}}& 3087007Snate@binkert.orgget${{dm.ident}}() const 3097007Snate@binkert.org{ 3107007Snate@binkert.org return m_${{dm.ident}}; 3117007Snate@binkert.org} 3126657Snate@binkert.org''') 3136657Snate@binkert.org 3146657Snate@binkert.org # Non-const Get methods for each field 3156657Snate@binkert.org code('// Non const Accessors methods for each field') 3166657Snate@binkert.org for dm in self.data_members.values(): 3176657Snate@binkert.org code(''' 3186657Snate@binkert.org/** \\brief Non-const accessor method for ${{dm.ident}} field. 3196657Snate@binkert.org * \\return ${{dm.ident}} field 3206657Snate@binkert.org */ 3217007Snate@binkert.org${{dm.type.c_ident}}& 3227007Snate@binkert.orgget${{dm.ident}}() 3237007Snate@binkert.org{ 3247007Snate@binkert.org return m_${{dm.ident}}; 3257007Snate@binkert.org} 3266657Snate@binkert.org''') 3276657Snate@binkert.org 3286657Snate@binkert.org #Set methods for each field 3296657Snate@binkert.org code('// Mutator methods for each field') 3306657Snate@binkert.org for dm in self.data_members.values(): 3316657Snate@binkert.org code(''' 3326657Snate@binkert.org/** \\brief Mutator method for ${{dm.ident}} field */ 3337007Snate@binkert.orgvoid 3347007Snate@binkert.orgset${{dm.ident}}(const ${{dm.type.c_ident}}& local_${{dm.ident}}) 3357007Snate@binkert.org{ 3367007Snate@binkert.org m_${{dm.ident}} = local_${{dm.ident}}; 3377007Snate@binkert.org} 3386657Snate@binkert.org''') 3396657Snate@binkert.org 3407002Snate@binkert.org code('void print(std::ostream& out) const;') 3416657Snate@binkert.org code.dedent() 3426657Snate@binkert.org code(' //private:') 3436657Snate@binkert.org code.indent() 3446657Snate@binkert.org 3456657Snate@binkert.org # Data members for each field 3466657Snate@binkert.org for dm in self.data_members.values(): 3476657Snate@binkert.org if "abstract" not in dm: 3486657Snate@binkert.org const = "" 3496657Snate@binkert.org init = "" 3506657Snate@binkert.org 3516657Snate@binkert.org # global structure 3526657Snate@binkert.org if self.isGlobal: 3536657Snate@binkert.org const = "static const " 3546657Snate@binkert.org 3556657Snate@binkert.org # init value 3566657Snate@binkert.org if dm.init_code: 3576657Snate@binkert.org # only global structure can have init value here 3586657Snate@binkert.org assert self.isGlobal 3596657Snate@binkert.org init = " = %s" % (dm.init_code) 3606657Snate@binkert.org 3616657Snate@binkert.org if "desc" in dm: 3627007Snate@binkert.org code('/** ${{dm["desc"]}} */') 3636657Snate@binkert.org 3647007Snate@binkert.org code('$const${{dm.type.c_ident}} m_${{dm.ident}}$init;') 3656657Snate@binkert.org 36610307Snilay@cs.wisc.edu # Prototypes for methods defined for the Type 36710307Snilay@cs.wisc.edu for item in self.methods: 36810307Snilay@cs.wisc.edu proto = self.methods[item].prototype 3699298Snilay@cs.wisc.edu if proto: 3709298Snilay@cs.wisc.edu code('$proto') 3719298Snilay@cs.wisc.edu 3726657Snate@binkert.org code.dedent() 3736657Snate@binkert.org code('};') 3746657Snate@binkert.org 3756657Snate@binkert.org code(''' 3767055Snate@binkert.orginline std::ostream& 3777007Snate@binkert.orgoperator<<(std::ostream& out, const ${{self.c_ident}}& obj) 3786657Snate@binkert.org{ 3796657Snate@binkert.org obj.print(out); 3807002Snate@binkert.org out << std::flush; 3816657Snate@binkert.org return out; 3826657Snate@binkert.org} 3836657Snate@binkert.org 3847007Snate@binkert.org#endif // __${{self.c_ident}}_HH__ 3856657Snate@binkert.org''') 3866657Snate@binkert.org 3876657Snate@binkert.org code.write(path, "%s.hh" % self.c_ident) 3886657Snate@binkert.org 3896657Snate@binkert.org def printTypeCC(self, path): 3906999Snate@binkert.org code = self.symtab.codeFormatter() 3916657Snate@binkert.org 3926657Snate@binkert.org code(''' 3936657Snate@binkert.org/** \\file ${{self.c_ident}}.cc 3946657Snate@binkert.org * 3956657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 3966657Snate@binkert.org */ 3976657Snate@binkert.org 3987002Snate@binkert.org#include <iostream> 39910472Sandreas.hansson@arm.com#include <memory> 4007002Snate@binkert.org 4016657Snate@binkert.org#include "mem/protocol/${{self.c_ident}}.hh" 4029499Snilay@cs.wisc.edu#include "mem/ruby/system/System.hh" 4037002Snate@binkert.org 4047002Snate@binkert.orgusing namespace std; 4056657Snate@binkert.org''') 4066657Snate@binkert.org 4076657Snate@binkert.org code(''' 4086657Snate@binkert.org/** \\brief Print the state of this object */ 4097007Snate@binkert.orgvoid 4107007Snate@binkert.org${{self.c_ident}}::print(ostream& out) const 4116657Snate@binkert.org{ 4126657Snate@binkert.org out << "[${{self.c_ident}}: "; 4136657Snate@binkert.org''') 4146657Snate@binkert.org 4156657Snate@binkert.org # For each field 4166657Snate@binkert.org code.indent() 4176657Snate@binkert.org for dm in self.data_members.values(): 4186657Snate@binkert.org code('out << "${{dm.ident}} = " << m_${{dm.ident}} << " ";''') 4196657Snate@binkert.org 4206657Snate@binkert.org code.dedent() 4216657Snate@binkert.org 4226657Snate@binkert.org # Trailer 4236657Snate@binkert.org code(''' 4246657Snate@binkert.org out << "]"; 4256657Snate@binkert.org}''') 4266657Snate@binkert.org 42710307Snilay@cs.wisc.edu # print the code for the methods in the type 42810307Snilay@cs.wisc.edu for item in self.methods: 42910307Snilay@cs.wisc.edu code(self.methods[item].generateCode()) 4309298Snilay@cs.wisc.edu 4316657Snate@binkert.org code.write(path, "%s.cc" % self.c_ident) 4326657Snate@binkert.org 4336657Snate@binkert.org def printEnumHH(self, path): 4346999Snate@binkert.org code = self.symtab.codeFormatter() 4356657Snate@binkert.org code(''' 4366657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 4376657Snate@binkert.org * 4386657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4396657Snate@binkert.org */ 4407007Snate@binkert.org 4417007Snate@binkert.org#ifndef __${{self.c_ident}}_HH__ 4427007Snate@binkert.org#define __${{self.c_ident}}_HH__ 4436657Snate@binkert.org 4447002Snate@binkert.org#include <iostream> 4457002Snate@binkert.org#include <string> 4467002Snate@binkert.org 4478086SBrad.Beckmann@amd.com''') 4488086SBrad.Beckmann@amd.com if self.isStateDecl: 4498086SBrad.Beckmann@amd.com code('#include "mem/protocol/AccessPermission.hh"') 4508086SBrad.Beckmann@amd.com 4518602Snilay@cs.wisc.edu if self.isMachineType: 4528602Snilay@cs.wisc.edu code('#include "base/misc.hh"') 4538602Snilay@cs.wisc.edu code('#include "mem/ruby/common/Address.hh"') 45411025Snilay@cs.wisc.edu code('#include "mem/ruby/common/TypeDefines.hh"') 4558602Snilay@cs.wisc.edu code('struct MachineID;') 4568602Snilay@cs.wisc.edu 4578086SBrad.Beckmann@amd.com code(''' 4586657Snate@binkert.org 4597007Snate@binkert.org// Class definition 4606657Snate@binkert.org/** \\enum ${{self.c_ident}} 4616657Snate@binkert.org * \\brief ${{self.desc}} 4626657Snate@binkert.org */ 4636657Snate@binkert.orgenum ${{self.c_ident}} { 4646657Snate@binkert.org ${{self.c_ident}}_FIRST, 4656657Snate@binkert.org''') 4666657Snate@binkert.org 4676657Snate@binkert.org code.indent() 4686657Snate@binkert.org # For each field 4696657Snate@binkert.org for i,(ident,enum) in enumerate(self.enums.iteritems()): 4706657Snate@binkert.org desc = enum.get("desc", "No description avaliable") 47110917Sbrandon.potter@amd.com if i == 0: 47210917Sbrandon.potter@amd.com init = ' = %s_FIRST' % self.c_ident 4736862Sdrh5@cs.wisc.edu else: 4746862Sdrh5@cs.wisc.edu init = '' 4756657Snate@binkert.org code('${{self.c_ident}}_${{enum.ident}}$init, /**< $desc */') 4766657Snate@binkert.org code.dedent() 4776657Snate@binkert.org code(''' 4786657Snate@binkert.org ${{self.c_ident}}_NUM 4796657Snate@binkert.org}; 4807007Snate@binkert.org 4817007Snate@binkert.org// Code to convert from a string to the enumeration 4827002Snate@binkert.org${{self.c_ident}} string_to_${{self.c_ident}}(const std::string& str); 4837007Snate@binkert.org 4847007Snate@binkert.org// Code to convert state to a string 4857002Snate@binkert.orgstd::string ${{self.c_ident}}_to_string(const ${{self.c_ident}}& obj); 4867007Snate@binkert.org 4877007Snate@binkert.org// Code to increment an enumeration type 4886657Snate@binkert.org${{self.c_ident}} &operator++(${{self.c_ident}} &e); 4896657Snate@binkert.org''') 4906657Snate@binkert.org 4916657Snate@binkert.org # MachineType hack used to set the base component id for each Machine 4926657Snate@binkert.org if self.isMachineType: 4936657Snate@binkert.org code(''' 4946657Snate@binkert.orgint ${{self.c_ident}}_base_level(const ${{self.c_ident}}& obj); 4956657Snate@binkert.orgMachineType ${{self.c_ident}}_from_base_level(int); 4966657Snate@binkert.orgint ${{self.c_ident}}_base_number(const ${{self.c_ident}}& obj); 4976657Snate@binkert.orgint ${{self.c_ident}}_base_count(const ${{self.c_ident}}& obj); 4986657Snate@binkert.org''') 4996657Snate@binkert.org 5006657Snate@binkert.org for enum in self.enums.itervalues(): 5018602Snilay@cs.wisc.edu if enum.ident == "DMA": 5028602Snilay@cs.wisc.edu code(''' 50311025Snilay@cs.wisc.eduMachineID map_Address_to_DMA(const Addr &addr); 5048602Snilay@cs.wisc.edu''') 5058602Snilay@cs.wisc.edu code(''' 5068602Snilay@cs.wisc.edu 5078602Snilay@cs.wisc.eduMachineID get${{enum.ident}}MachineID(NodeID RubyNode); 5088602Snilay@cs.wisc.edu''') 5098602Snilay@cs.wisc.edu 5108086SBrad.Beckmann@amd.com if self.isStateDecl: 5118086SBrad.Beckmann@amd.com code(''' 5128086SBrad.Beckmann@amd.com 5138086SBrad.Beckmann@amd.com// Code to convert the current state to an access permission 5148086SBrad.Beckmann@amd.comAccessPermission ${{self.c_ident}}_to_permission(const ${{self.c_ident}}& obj); 5158086SBrad.Beckmann@amd.com 5168086SBrad.Beckmann@amd.com''') 5178086SBrad.Beckmann@amd.com 5186657Snate@binkert.org # Trailer 5196657Snate@binkert.org code(''' 5207002Snate@binkert.orgstd::ostream& operator<<(std::ostream& out, const ${{self.c_ident}}& obj); 5216657Snate@binkert.org 5227007Snate@binkert.org#endif // __${{self.c_ident}}_HH__ 5236657Snate@binkert.org''') 5246657Snate@binkert.org 5256657Snate@binkert.org code.write(path, "%s.hh" % self.c_ident) 5266657Snate@binkert.org 5276657Snate@binkert.org def printEnumCC(self, path): 5286999Snate@binkert.org code = self.symtab.codeFormatter() 5296657Snate@binkert.org code(''' 5306657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 5316657Snate@binkert.org * 5326657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 5336657Snate@binkert.org */ 5346657Snate@binkert.org 5357832Snate@binkert.org#include <cassert> 5367002Snate@binkert.org#include <iostream> 5377002Snate@binkert.org#include <string> 5387002Snate@binkert.org 5397805Snilay@cs.wisc.edu#include "base/misc.hh" 5406657Snate@binkert.org#include "mem/protocol/${{self.c_ident}}.hh" 5416657Snate@binkert.org 5427002Snate@binkert.orgusing namespace std; 5437002Snate@binkert.org 5446657Snate@binkert.org''') 5456657Snate@binkert.org 5468086SBrad.Beckmann@amd.com if self.isStateDecl: 5478086SBrad.Beckmann@amd.com code(''' 5488086SBrad.Beckmann@amd.com// Code to convert the current state to an access permission 5498086SBrad.Beckmann@amd.comAccessPermission ${{self.c_ident}}_to_permission(const ${{self.c_ident}}& obj) 5508086SBrad.Beckmann@amd.com{ 5518086SBrad.Beckmann@amd.com switch(obj) { 5528086SBrad.Beckmann@amd.com''') 5538086SBrad.Beckmann@amd.com # For each case 5548086SBrad.Beckmann@amd.com code.indent() 5558086SBrad.Beckmann@amd.com for statePerm in self.statePermPairs: 5568086SBrad.Beckmann@amd.com code(' case ${{self.c_ident}}_${{statePerm[0]}}:') 5578086SBrad.Beckmann@amd.com code(' return AccessPermission_${{statePerm[1]}};') 5588086SBrad.Beckmann@amd.com code.dedent() 5598086SBrad.Beckmann@amd.com code (''' 5608086SBrad.Beckmann@amd.com default: 5618086SBrad.Beckmann@amd.com panic("Unknown state access permission converstion for ${{self.c_ident}}"); 5628086SBrad.Beckmann@amd.com } 5638086SBrad.Beckmann@amd.com} 5648086SBrad.Beckmann@amd.com 5658086SBrad.Beckmann@amd.com''') 5668086SBrad.Beckmann@amd.com 5676657Snate@binkert.org if self.isMachineType: 5686657Snate@binkert.org for enum in self.enums.itervalues(): 5699773Snilay@cs.wisc.edu if enum.get("Primary"): 5709773Snilay@cs.wisc.edu code('#include "mem/protocol/${{enum.ident}}_Controller.hh"') 57110301Snilay@cs.wisc.edu code('#include "mem/ruby/common/MachineID.hh"') 5726657Snate@binkert.org 5736657Snate@binkert.org code(''' 5747007Snate@binkert.org// Code for output operator 5757007Snate@binkert.orgostream& 5767007Snate@binkert.orgoperator<<(ostream& out, const ${{self.c_ident}}& obj) 5776657Snate@binkert.org{ 5786657Snate@binkert.org out << ${{self.c_ident}}_to_string(obj); 5796657Snate@binkert.org out << flush; 5806657Snate@binkert.org return out; 5816657Snate@binkert.org} 5826657Snate@binkert.org 5837007Snate@binkert.org// Code to convert state to a string 5847007Snate@binkert.orgstring 5857007Snate@binkert.org${{self.c_ident}}_to_string(const ${{self.c_ident}}& obj) 5866657Snate@binkert.org{ 5876657Snate@binkert.org switch(obj) { 5886657Snate@binkert.org''') 5896657Snate@binkert.org 5906657Snate@binkert.org # For each field 5916657Snate@binkert.org code.indent() 5926657Snate@binkert.org for enum in self.enums.itervalues(): 5936657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 5946657Snate@binkert.org code(' return "${{enum.ident}}";') 5956657Snate@binkert.org code.dedent() 5966657Snate@binkert.org 5976657Snate@binkert.org # Trailer 5986657Snate@binkert.org code(''' 5996657Snate@binkert.org default: 6007805Snilay@cs.wisc.edu panic("Invalid range for type ${{self.c_ident}}"); 6016657Snate@binkert.org } 6026657Snate@binkert.org} 6036657Snate@binkert.org 6047007Snate@binkert.org// Code to convert from a string to the enumeration 6057007Snate@binkert.org${{self.c_ident}} 6067007Snate@binkert.orgstring_to_${{self.c_ident}}(const string& str) 6076657Snate@binkert.org{ 6086657Snate@binkert.org''') 6096657Snate@binkert.org 6106657Snate@binkert.org # For each field 6117007Snate@binkert.org start = "" 6126657Snate@binkert.org code.indent() 6136657Snate@binkert.org for enum in self.enums.itervalues(): 6146657Snate@binkert.org code('${start}if (str == "${{enum.ident}}") {') 6156657Snate@binkert.org code(' return ${{self.c_ident}}_${{enum.ident}};') 6167007Snate@binkert.org start = "} else " 6176657Snate@binkert.org code.dedent() 6186657Snate@binkert.org 6196657Snate@binkert.org code(''' 6206657Snate@binkert.org } else { 6217805Snilay@cs.wisc.edu panic("Invalid string conversion for %s, type ${{self.c_ident}}", str); 6226657Snate@binkert.org } 6236657Snate@binkert.org} 6246657Snate@binkert.org 6257007Snate@binkert.org// Code to increment an enumeration type 6267007Snate@binkert.org${{self.c_ident}}& 6277007Snate@binkert.orgoperator++(${{self.c_ident}}& e) 6287007Snate@binkert.org{ 6296657Snate@binkert.org assert(e < ${{self.c_ident}}_NUM); 6306657Snate@binkert.org return e = ${{self.c_ident}}(e+1); 6316657Snate@binkert.org} 6326657Snate@binkert.org''') 6336657Snate@binkert.org 6346657Snate@binkert.org # MachineType hack used to set the base level and number of 6356657Snate@binkert.org # components for each Machine 6366657Snate@binkert.org if self.isMachineType: 6376657Snate@binkert.org code(''' 6387007Snate@binkert.org/** \\brief returns the base vector index for each machine type to be 6397007Snate@binkert.org * used by NetDest 6406657Snate@binkert.org * 6416657Snate@binkert.org * \\return the base vector index for each machine type to be used by NetDest 6426657Snate@binkert.org * \\see NetDest.hh 6436657Snate@binkert.org */ 6447007Snate@binkert.orgint 6457007Snate@binkert.org${{self.c_ident}}_base_level(const ${{self.c_ident}}& obj) 6466657Snate@binkert.org{ 6476657Snate@binkert.org switch(obj) { 6486657Snate@binkert.org''') 6496657Snate@binkert.org 6506657Snate@binkert.org # For each field 6516657Snate@binkert.org code.indent() 6526657Snate@binkert.org for i,enum in enumerate(self.enums.itervalues()): 6536657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 6546657Snate@binkert.org code(' return $i;') 6556657Snate@binkert.org code.dedent() 6566657Snate@binkert.org 6576657Snate@binkert.org # total num 6586657Snate@binkert.org code(''' 6596657Snate@binkert.org case ${{self.c_ident}}_NUM: 6606657Snate@binkert.org return ${{len(self.enums)}}; 6616657Snate@binkert.org 6626657Snate@binkert.org default: 6637805Snilay@cs.wisc.edu panic("Invalid range for type ${{self.c_ident}}"); 6646657Snate@binkert.org } 6656657Snate@binkert.org} 6666657Snate@binkert.org 6676657Snate@binkert.org/** \\brief returns the machine type for each base vector index used by NetDest 6686657Snate@binkert.org * 6697007Snate@binkert.org * \\return the MachineType 6706657Snate@binkert.org */ 6717007Snate@binkert.orgMachineType 6727007Snate@binkert.org${{self.c_ident}}_from_base_level(int type) 6736657Snate@binkert.org{ 6746657Snate@binkert.org switch(type) { 6756657Snate@binkert.org''') 6766657Snate@binkert.org 6776657Snate@binkert.org # For each field 6786657Snate@binkert.org code.indent() 6796657Snate@binkert.org for i,enum in enumerate(self.enums.itervalues()): 6806657Snate@binkert.org code(' case $i:') 6816657Snate@binkert.org code(' return ${{self.c_ident}}_${{enum.ident}};') 6826657Snate@binkert.org code.dedent() 6836657Snate@binkert.org 6846657Snate@binkert.org # Trailer 6856657Snate@binkert.org code(''' 6866657Snate@binkert.org default: 6877805Snilay@cs.wisc.edu panic("Invalid range for type ${{self.c_ident}}"); 6886657Snate@binkert.org } 6896657Snate@binkert.org} 6906657Snate@binkert.org 6916657Snate@binkert.org/** \\brief The return value indicates the number of components created 6926657Snate@binkert.org * before a particular machine\'s components 6936657Snate@binkert.org * 6946657Snate@binkert.org * \\return the base number of components for each machine 6956657Snate@binkert.org */ 6967007Snate@binkert.orgint 6977007Snate@binkert.org${{self.c_ident}}_base_number(const ${{self.c_ident}}& obj) 6986657Snate@binkert.org{ 6996657Snate@binkert.org int base = 0; 7006657Snate@binkert.org switch(obj) { 7016657Snate@binkert.org''') 7026657Snate@binkert.org 7036657Snate@binkert.org # For each field 7046657Snate@binkert.org code.indent() 7056657Snate@binkert.org code(' case ${{self.c_ident}}_NUM:') 7066657Snate@binkert.org for enum in reversed(self.enums.values()): 7079773Snilay@cs.wisc.edu # Check if there is a defined machine with this type 7089773Snilay@cs.wisc.edu if enum.get("Primary"): 7099773Snilay@cs.wisc.edu code(' base += ${{enum.ident}}_Controller::getNumControllers();') 7109773Snilay@cs.wisc.edu else: 7119773Snilay@cs.wisc.edu code(' base += 0;') 7126657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 7136657Snate@binkert.org code(' break;') 7146657Snate@binkert.org code.dedent() 7156657Snate@binkert.org 7166657Snate@binkert.org code(''' 7176657Snate@binkert.org default: 7187805Snilay@cs.wisc.edu panic("Invalid range for type ${{self.c_ident}}"); 7196657Snate@binkert.org } 7206657Snate@binkert.org 7216657Snate@binkert.org return base; 7226657Snate@binkert.org} 7236657Snate@binkert.org 7246657Snate@binkert.org/** \\brief returns the total number of components for each machine 7256657Snate@binkert.org * \\return the total number of components for each machine 7266657Snate@binkert.org */ 7277007Snate@binkert.orgint 7287007Snate@binkert.org${{self.c_ident}}_base_count(const ${{self.c_ident}}& obj) 7296657Snate@binkert.org{ 7306657Snate@binkert.org switch(obj) { 7316657Snate@binkert.org''') 7326657Snate@binkert.org 7336657Snate@binkert.org # For each field 7346657Snate@binkert.org for enum in self.enums.itervalues(): 7359773Snilay@cs.wisc.edu code('case ${{self.c_ident}}_${{enum.ident}}:') 7369773Snilay@cs.wisc.edu if enum.get("Primary"): 7379773Snilay@cs.wisc.edu code('return ${{enum.ident}}_Controller::getNumControllers();') 7389773Snilay@cs.wisc.edu else: 7399773Snilay@cs.wisc.edu code('return 0;') 7406657Snate@binkert.org 7416657Snate@binkert.org # total num 7426657Snate@binkert.org code(''' 7436657Snate@binkert.org case ${{self.c_ident}}_NUM: 7446657Snate@binkert.org default: 7457805Snilay@cs.wisc.edu panic("Invalid range for type ${{self.c_ident}}"); 7466657Snate@binkert.org } 7476657Snate@binkert.org} 7486657Snate@binkert.org''') 7496657Snate@binkert.org 7508602Snilay@cs.wisc.edu for enum in self.enums.itervalues(): 7518602Snilay@cs.wisc.edu if enum.ident == "DMA": 7528602Snilay@cs.wisc.edu code(''' 7538602Snilay@cs.wisc.eduMachineID 75411025Snilay@cs.wisc.edumap_Address_to_DMA(const Addr &addr) 7558602Snilay@cs.wisc.edu{ 7568602Snilay@cs.wisc.edu MachineID dma = {MachineType_DMA, 0}; 7578602Snilay@cs.wisc.edu return dma; 7588602Snilay@cs.wisc.edu} 7598602Snilay@cs.wisc.edu''') 7608602Snilay@cs.wisc.edu 7618602Snilay@cs.wisc.edu code(''' 7628602Snilay@cs.wisc.edu 7638602Snilay@cs.wisc.eduMachineID 7648602Snilay@cs.wisc.eduget${{enum.ident}}MachineID(NodeID RubyNode) 7658602Snilay@cs.wisc.edu{ 7668602Snilay@cs.wisc.edu MachineID mach = {MachineType_${{enum.ident}}, RubyNode}; 7678602Snilay@cs.wisc.edu return mach; 7688602Snilay@cs.wisc.edu} 7698602Snilay@cs.wisc.edu''') 7708602Snilay@cs.wisc.edu 7716657Snate@binkert.org # Write the file 7726657Snate@binkert.org code.write(path, "%s.cc" % self.c_ident) 7736657Snate@binkert.org 7746657Snate@binkert.org__all__ = [ "Type" ] 775