Type.py revision 7055
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 326657Snate@binkert.org 336657Snate@binkert.orgclass DataMember(PairContainer): 346657Snate@binkert.org def __init__(self, ident, type, pairs, init_code): 356657Snate@binkert.org super(DataMember, self).__init__(pairs) 366657Snate@binkert.org self.ident = ident 376657Snate@binkert.org self.type = type 386657Snate@binkert.org self.init_code = init_code 396657Snate@binkert.org 406657Snate@binkert.orgclass Enumeration(PairContainer): 416657Snate@binkert.org def __init__(self, ident, pairs): 426657Snate@binkert.org super(Enumeration, self).__init__(pairs) 436657Snate@binkert.org self.ident = ident 446657Snate@binkert.org 456657Snate@binkert.orgclass Method(object): 466657Snate@binkert.org def __init__(self, return_type, param_types): 476657Snate@binkert.org self.return_type = return_type 486657Snate@binkert.org self.param_types = param_types 496657Snate@binkert.org 506657Snate@binkert.orgclass Type(Symbol): 516657Snate@binkert.org def __init__(self, table, ident, location, pairs, machine=None): 526657Snate@binkert.org super(Type, self).__init__(table, ident, location, pairs) 536657Snate@binkert.org self.c_ident = ident 546882SBrad.Beckmann@amd.com self.abstract_ident = "" 556657Snate@binkert.org if machine: 566657Snate@binkert.org if self.isExternal or self.isPrimitive: 576657Snate@binkert.org if "external_name" in self: 586657Snate@binkert.org self.c_ident = self["external_name"] 596657Snate@binkert.org else: 606657Snate@binkert.org # Append with machine name 616657Snate@binkert.org self.c_ident = "%s_%s" % (machine, ident) 626657Snate@binkert.org 636657Snate@binkert.org self.pairs.setdefault("desc", "No description avaliable") 646657Snate@binkert.org 656657Snate@binkert.org # check for interface that this Type implements 666657Snate@binkert.org if "interface" in self: 676657Snate@binkert.org interface = self["interface"] 686657Snate@binkert.org if interface in ("Message", "NetworkMessage"): 696657Snate@binkert.org self["message"] = "yes" 706657Snate@binkert.org if interface == "NetworkMessage": 716657Snate@binkert.org self["networkmessage"] = "yes" 726657Snate@binkert.org 736657Snate@binkert.org # FIXME - all of the following id comparisons are fragile hacks 746657Snate@binkert.org if self.ident in ("CacheMemory", "NewCacheMemory", 756657Snate@binkert.org "TLCCacheMemory", "DNUCACacheMemory", 766657Snate@binkert.org "DNUCABankCacheMemory", "L2BankCacheMemory", 776657Snate@binkert.org "CompressedCacheMemory", "PrefetchCacheMemory"): 786657Snate@binkert.org self["cache"] = "yes" 796657Snate@binkert.org 806657Snate@binkert.org if self.ident in ("TBETable", "DNUCATBETable", "DNUCAStopTable"): 816657Snate@binkert.org self["tbe"] = "yes" 826657Snate@binkert.org 836657Snate@binkert.org if self.ident == "NewTBETable": 846657Snate@binkert.org self["newtbe"] = "yes" 856657Snate@binkert.org 866657Snate@binkert.org if self.ident == "TimerTable": 876657Snate@binkert.org self["timer"] = "yes" 886657Snate@binkert.org 896657Snate@binkert.org if self.ident == "DirectoryMemory": 906657Snate@binkert.org self["dir"] = "yes" 916657Snate@binkert.org 926657Snate@binkert.org if self.ident == "PersistentTable": 936657Snate@binkert.org self["persistent"] = "yes" 946657Snate@binkert.org 956657Snate@binkert.org if self.ident == "Prefetcher": 966657Snate@binkert.org self["prefetcher"] = "yes" 976657Snate@binkert.org 986657Snate@binkert.org if self.ident == "DNUCA_Movement": 996657Snate@binkert.org self["mover"] = "yes" 1006657Snate@binkert.org 1016657Snate@binkert.org self.isMachineType = (ident == "MachineType") 1026657Snate@binkert.org 1036657Snate@binkert.org self.data_members = orderdict() 1046657Snate@binkert.org 1056657Snate@binkert.org # Methods 1066657Snate@binkert.org self.methods = {} 1076657Snate@binkert.org 1086657Snate@binkert.org # Enums 1096657Snate@binkert.org self.enums = orderdict() 1106657Snate@binkert.org 1116657Snate@binkert.org @property 1126657Snate@binkert.org def isPrimitive(self): 1136657Snate@binkert.org return "primitive" in self 1146657Snate@binkert.org @property 1156657Snate@binkert.org def isNetworkMessage(self): 1166657Snate@binkert.org return "networkmessage" in self 1176657Snate@binkert.org @property 1186657Snate@binkert.org def isMessage(self): 1196657Snate@binkert.org return "message" in self 1206657Snate@binkert.org @property 1216657Snate@binkert.org def isBuffer(self): 1226657Snate@binkert.org return "buffer" in self 1236657Snate@binkert.org @property 1246657Snate@binkert.org def isInPort(self): 1256657Snate@binkert.org return "inport" in self 1266657Snate@binkert.org @property 1276657Snate@binkert.org def isOutPort(self): 1286657Snate@binkert.org return "outport" in self 1296657Snate@binkert.org @property 1306657Snate@binkert.org def isEnumeration(self): 1316657Snate@binkert.org return "enumeration" in self 1326657Snate@binkert.org @property 1336657Snate@binkert.org def isExternal(self): 1346657Snate@binkert.org return "external" in self 1356657Snate@binkert.org @property 1366657Snate@binkert.org def isGlobal(self): 1376657Snate@binkert.org return "global" in self 1386657Snate@binkert.org @property 1396657Snate@binkert.org def isInterface(self): 1406657Snate@binkert.org return "interface" in self 1416657Snate@binkert.org 1426657Snate@binkert.org # Return false on error 1436657Snate@binkert.org def dataMemberAdd(self, ident, type, pairs, init_code): 1446657Snate@binkert.org if ident in self.data_members: 1456657Snate@binkert.org return False 1466657Snate@binkert.org 1476657Snate@binkert.org member = DataMember(ident, type, pairs, init_code) 1486657Snate@binkert.org self.data_members[ident] = member 1496657Snate@binkert.org 1506657Snate@binkert.org return True 1516657Snate@binkert.org 1526657Snate@binkert.org def dataMemberType(self, ident): 1536657Snate@binkert.org return self.data_members[ident].type 1546657Snate@binkert.org 1556657Snate@binkert.org def methodId(self, name, param_type_vec): 1566657Snate@binkert.org return '_'.join([name] + [ pt.c_ident for pt in param_type_vec ]) 1576657Snate@binkert.org 1586882SBrad.Beckmann@amd.com def methodIdAbstract(self, name, param_type_vec): 1596882SBrad.Beckmann@amd.com return '_'.join([name] + [ pt.abstract_ident for pt in param_type_vec ]) 1606882SBrad.Beckmann@amd.com 1616657Snate@binkert.org def methodAdd(self, name, return_type, param_type_vec): 1626657Snate@binkert.org ident = self.methodId(name, param_type_vec) 1636657Snate@binkert.org if ident in self.methods: 1646657Snate@binkert.org return False 1656657Snate@binkert.org 1666657Snate@binkert.org self.methods[ident] = Method(return_type, param_type_vec) 1676657Snate@binkert.org return True 1686657Snate@binkert.org 1696657Snate@binkert.org def enumAdd(self, ident, pairs): 1706657Snate@binkert.org if ident in self.enums: 1716657Snate@binkert.org return False 1726657Snate@binkert.org 1736657Snate@binkert.org self.enums[ident] = Enumeration(ident, pairs) 1746657Snate@binkert.org 1756657Snate@binkert.org # Add default 1766657Snate@binkert.org if "default" not in self: 1776657Snate@binkert.org self["default"] = "%s_NUM" % self.c_ident 1786657Snate@binkert.org 1796657Snate@binkert.org return True 1806657Snate@binkert.org 1816657Snate@binkert.org def writeCodeFiles(self, path): 1826657Snate@binkert.org if self.isExternal: 1836657Snate@binkert.org # Do nothing 1846657Snate@binkert.org pass 1856657Snate@binkert.org elif self.isEnumeration: 1866657Snate@binkert.org self.printEnumHH(path) 1876657Snate@binkert.org self.printEnumCC(path) 1886657Snate@binkert.org else: 1896657Snate@binkert.org # User defined structs and messages 1906657Snate@binkert.org self.printTypeHH(path) 1916657Snate@binkert.org self.printTypeCC(path) 1926657Snate@binkert.org 1936657Snate@binkert.org def printTypeHH(self, path): 1946999Snate@binkert.org code = self.symtab.codeFormatter() 1956657Snate@binkert.org code(''' 1966657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 1976657Snate@binkert.org * 1986657Snate@binkert.org * 1996657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 2006657Snate@binkert.org */ 2016657Snate@binkert.org 2027007Snate@binkert.org#ifndef __${{self.c_ident}}_HH__ 2037007Snate@binkert.org#define __${{self.c_ident}}_HH__ 2046657Snate@binkert.org 2057002Snate@binkert.org#include <iostream> 2067002Snate@binkert.org 2076657Snate@binkert.org#include "mem/ruby/common/Global.hh" 2086657Snate@binkert.org#include "mem/gems_common/Allocator.hh" 2096657Snate@binkert.org''') 2106657Snate@binkert.org 2116657Snate@binkert.org for dm in self.data_members.values(): 2126657Snate@binkert.org if not dm.type.isPrimitive: 2136657Snate@binkert.org code('#include "mem/protocol/$0.hh"', dm.type.c_ident) 2146657Snate@binkert.org 2156657Snate@binkert.org parent = "" 2166657Snate@binkert.org if "interface" in self: 2176657Snate@binkert.org code('#include "mem/protocol/$0.hh"', self["interface"]) 2186657Snate@binkert.org parent = " : public %s" % self["interface"] 2196657Snate@binkert.org 2206657Snate@binkert.org code(''' 2217007Snate@binkert.org$klass ${{self.c_ident}}$parent 2227007Snate@binkert.org{ 2236657Snate@binkert.org public: 2246657Snate@binkert.org ${{self.c_ident}}() 2257007Snate@binkert.org { 2266657Snate@binkert.org''', klass="class") 2276657Snate@binkert.org 2286657Snate@binkert.org code.indent() 2296657Snate@binkert.org if not self.isGlobal: 2306657Snate@binkert.org code.indent() 2316657Snate@binkert.org for dm in self.data_members.values(): 2326657Snate@binkert.org ident = dm.ident 2336657Snate@binkert.org if "default" in dm: 2346657Snate@binkert.org # look for default value 2356657Snate@binkert.org code('m_$ident = ${{dm["default"]}}; // default for this field') 2366657Snate@binkert.org elif "default" in dm.type: 2376657Snate@binkert.org # Look for the type default 2386657Snate@binkert.org tid = dm.type.c_ident 2396657Snate@binkert.org code('m_$ident = ${{dm.type["default"]}}; // default value of $tid') 2406657Snate@binkert.org else: 2416657Snate@binkert.org code('// m_$ident has no default') 2426657Snate@binkert.org code.dedent() 2436657Snate@binkert.org code('}') 2446657Snate@binkert.org 2456657Snate@binkert.org # ******** Full init constructor ******** 2466657Snate@binkert.org if not self.isGlobal: 2476657Snate@binkert.org params = [ 'const %s& local_%s' % (dm.type.c_ident, dm.ident) \ 2486657Snate@binkert.org for dm in self.data_members.itervalues() ] 2496657Snate@binkert.org 2506657Snate@binkert.org if self.isMessage: 2516657Snate@binkert.org params.append('const unsigned local_proc_id') 2526657Snate@binkert.org 2536657Snate@binkert.org params = ', '.join(params) 2546657Snate@binkert.org code('${{self.c_ident}}($params)') 2556657Snate@binkert.org 2566657Snate@binkert.org # Call superclass constructor 2576657Snate@binkert.org if "interface" in self: 2586657Snate@binkert.org code(' : ${{self["interface"]}}()') 2596657Snate@binkert.org 2606657Snate@binkert.org code('{') 2616657Snate@binkert.org code.indent() 2626657Snate@binkert.org for dm in self.data_members.values(): 2636657Snate@binkert.org code('m_${{dm.ident}} = local_${{dm.ident}};') 2646657Snate@binkert.org if "nextLineCallHack" in dm: 2656657Snate@binkert.org code('m_${{dm.ident}}${{dm["nextLineCallHack"]}};') 2666657Snate@binkert.org 2676657Snate@binkert.org if self.isMessage: 2686657Snate@binkert.org code('proc_id = local_proc_id;') 2696657Snate@binkert.org 2706657Snate@binkert.org code.dedent() 2716657Snate@binkert.org code('}') 2726657Snate@binkert.org 2736657Snate@binkert.org # create a static factory method 2746657Snate@binkert.org if "interface" in self: 2756657Snate@binkert.org code(''' 2767007Snate@binkert.orgstatic ${{self["interface"]}}* 2777007Snate@binkert.orgcreate() 2787007Snate@binkert.org{ 2796657Snate@binkert.org return new ${{self.c_ident}}(); 2806657Snate@binkert.org} 2816657Snate@binkert.org''') 2826657Snate@binkert.org 2836657Snate@binkert.org # ******** Message member functions ******** 2846657Snate@binkert.org # FIXME: those should be moved into slicc file, slicc should 2856657Snate@binkert.org # support more of the c++ class inheritance 2866657Snate@binkert.org 2876657Snate@binkert.org if self.isMessage: 2886657Snate@binkert.org code(''' 2897007Snate@binkert.orgMessage * 2907007Snate@binkert.orgclone() const 2917007Snate@binkert.org{ 2927007Snate@binkert.org checkAllocator(); 2937007Snate@binkert.org return s_allocator_ptr->allocate(*this); 2947007Snate@binkert.org} 2957007Snate@binkert.org 2967007Snate@binkert.orgvoid 2977007Snate@binkert.orgdestroy() 2987007Snate@binkert.org{ 2997007Snate@binkert.org checkAllocator(); 3007007Snate@binkert.org s_allocator_ptr->deallocate(this); 3017007Snate@binkert.org} 3027007Snate@binkert.org 3036657Snate@binkert.orgstatic Allocator<${{self.c_ident}}>* s_allocator_ptr; 3047007Snate@binkert.org 3057007Snate@binkert.orgstatic void 3067007Snate@binkert.orgcheckAllocator() 3077007Snate@binkert.org{ 3087007Snate@binkert.org if (s_allocator_ptr == NULL) { 3097007Snate@binkert.org s_allocator_ptr = new Allocator<${{self.c_ident}}>; 3107007Snate@binkert.org } 3117007Snate@binkert.org} 3126657Snate@binkert.org''') 3136657Snate@binkert.org 3146657Snate@binkert.org if not self.isGlobal: 3156657Snate@binkert.org # const Get methods for each field 3166657Snate@binkert.org code('// Const accessors methods for each field') 3176657Snate@binkert.org for dm in self.data_members.values(): 3186657Snate@binkert.org code(''' 3196657Snate@binkert.org/** \\brief Const accessor method for ${{dm.ident}} field. 3206657Snate@binkert.org * \\return ${{dm.ident}} field 3216657Snate@binkert.org */ 3227007Snate@binkert.orgconst ${{dm.type.c_ident}}& 3237007Snate@binkert.orgget${{dm.ident}}() const 3247007Snate@binkert.org{ 3257007Snate@binkert.org return m_${{dm.ident}}; 3267007Snate@binkert.org} 3276657Snate@binkert.org''') 3286657Snate@binkert.org 3296657Snate@binkert.org # Non-const Get methods for each field 3306657Snate@binkert.org code('// Non const Accessors methods for each field') 3316657Snate@binkert.org for dm in self.data_members.values(): 3326657Snate@binkert.org code(''' 3336657Snate@binkert.org/** \\brief Non-const accessor method for ${{dm.ident}} field. 3346657Snate@binkert.org * \\return ${{dm.ident}} field 3356657Snate@binkert.org */ 3367007Snate@binkert.org${{dm.type.c_ident}}& 3377007Snate@binkert.orgget${{dm.ident}}() 3387007Snate@binkert.org{ 3397007Snate@binkert.org return m_${{dm.ident}}; 3407007Snate@binkert.org} 3416657Snate@binkert.org''') 3426657Snate@binkert.org 3436657Snate@binkert.org #Set methods for each field 3446657Snate@binkert.org code('// Mutator methods for each field') 3456657Snate@binkert.org for dm in self.data_members.values(): 3466657Snate@binkert.org code(''' 3476657Snate@binkert.org/** \\brief Mutator method for ${{dm.ident}} field */ 3487007Snate@binkert.orgvoid 3497007Snate@binkert.orgset${{dm.ident}}(const ${{dm.type.c_ident}}& local_${{dm.ident}}) 3507007Snate@binkert.org{ 3517007Snate@binkert.org m_${{dm.ident}} = local_${{dm.ident}}; 3527007Snate@binkert.org} 3536657Snate@binkert.org''') 3546657Snate@binkert.org 3557002Snate@binkert.org code('void print(std::ostream& out) const;') 3566657Snate@binkert.org code.dedent() 3576657Snate@binkert.org code(' //private:') 3586657Snate@binkert.org code.indent() 3596657Snate@binkert.org 3606657Snate@binkert.org # Data members for each field 3616657Snate@binkert.org for dm in self.data_members.values(): 3626657Snate@binkert.org if "abstract" not in dm: 3636657Snate@binkert.org const = "" 3646657Snate@binkert.org init = "" 3656657Snate@binkert.org 3666657Snate@binkert.org # global structure 3676657Snate@binkert.org if self.isGlobal: 3686657Snate@binkert.org const = "static const " 3696657Snate@binkert.org 3706657Snate@binkert.org # init value 3716657Snate@binkert.org if dm.init_code: 3726657Snate@binkert.org # only global structure can have init value here 3736657Snate@binkert.org assert self.isGlobal 3746657Snate@binkert.org init = " = %s" % (dm.init_code) 3756657Snate@binkert.org 3766657Snate@binkert.org if "desc" in dm: 3777007Snate@binkert.org code('/** ${{dm["desc"]}} */') 3786657Snate@binkert.org 3797007Snate@binkert.org code('$const${{dm.type.c_ident}} m_${{dm.ident}}$init;') 3806657Snate@binkert.org 3816657Snate@binkert.org if self.isMessage: 3826657Snate@binkert.org code('unsigned proc_id;') 3836657Snate@binkert.org 3846657Snate@binkert.org code.dedent() 3856657Snate@binkert.org code('};') 3866657Snate@binkert.org 3876657Snate@binkert.org code(''' 3887055Snate@binkert.orginline std::ostream& 3897007Snate@binkert.orgoperator<<(std::ostream& out, const ${{self.c_ident}}& obj) 3906657Snate@binkert.org{ 3916657Snate@binkert.org obj.print(out); 3927002Snate@binkert.org out << std::flush; 3936657Snate@binkert.org return out; 3946657Snate@binkert.org} 3956657Snate@binkert.org 3967007Snate@binkert.org#endif // __${{self.c_ident}}_HH__ 3976657Snate@binkert.org''') 3986657Snate@binkert.org 3996657Snate@binkert.org code.write(path, "%s.hh" % self.c_ident) 4006657Snate@binkert.org 4016657Snate@binkert.org def printTypeCC(self, path): 4026999Snate@binkert.org code = self.symtab.codeFormatter() 4036657Snate@binkert.org 4046657Snate@binkert.org code(''' 4056657Snate@binkert.org/** \\file ${{self.c_ident}}.cc 4066657Snate@binkert.org * 4076657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4086657Snate@binkert.org */ 4096657Snate@binkert.org 4107002Snate@binkert.org#include <iostream> 4117002Snate@binkert.org 4126657Snate@binkert.org#include "mem/protocol/${{self.c_ident}}.hh" 4137002Snate@binkert.org 4147002Snate@binkert.orgusing namespace std; 4156657Snate@binkert.org''') 4166657Snate@binkert.org 4176657Snate@binkert.org if self.isMessage: 4186657Snate@binkert.org code('Allocator<${{self.c_ident}}>* ${{self.c_ident}}::s_allocator_ptr = NULL;') 4196657Snate@binkert.org code(''' 4206657Snate@binkert.org/** \\brief Print the state of this object */ 4217007Snate@binkert.orgvoid 4227007Snate@binkert.org${{self.c_ident}}::print(ostream& out) const 4236657Snate@binkert.org{ 4246657Snate@binkert.org out << "[${{self.c_ident}}: "; 4256657Snate@binkert.org''') 4266657Snate@binkert.org 4276657Snate@binkert.org # For each field 4286657Snate@binkert.org code.indent() 4296657Snate@binkert.org for dm in self.data_members.values(): 4306657Snate@binkert.org code('out << "${{dm.ident}} = " << m_${{dm.ident}} << " ";''') 4316657Snate@binkert.org 4326657Snate@binkert.org if self.isMessage: 4336657Snate@binkert.org code('out << "Time = " << getTime() << " ";') 4346657Snate@binkert.org code.dedent() 4356657Snate@binkert.org 4366657Snate@binkert.org # Trailer 4376657Snate@binkert.org code(''' 4386657Snate@binkert.org out << "]"; 4396657Snate@binkert.org}''') 4406657Snate@binkert.org 4416657Snate@binkert.org code.write(path, "%s.cc" % self.c_ident) 4426657Snate@binkert.org 4436657Snate@binkert.org def printEnumHH(self, path): 4446999Snate@binkert.org code = self.symtab.codeFormatter() 4456657Snate@binkert.org code(''' 4466657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 4476657Snate@binkert.org * 4486657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4496657Snate@binkert.org */ 4507007Snate@binkert.org 4517007Snate@binkert.org#ifndef __${{self.c_ident}}_HH__ 4527007Snate@binkert.org#define __${{self.c_ident}}_HH__ 4536657Snate@binkert.org 4547002Snate@binkert.org#include <iostream> 4557002Snate@binkert.org#include <string> 4567002Snate@binkert.org 4576657Snate@binkert.org#include "mem/ruby/common/Global.hh" 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") 4716862Sdrh5@cs.wisc.edu if i == 0: 4726862Sdrh5@cs.wisc.edu 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(): 5016657Snate@binkert.org code('#define MACHINETYPE_${{enum.ident}} 1') 5026657Snate@binkert.org 5036657Snate@binkert.org # Trailer 5046657Snate@binkert.org code(''' 5057002Snate@binkert.orgstd::ostream& operator<<(std::ostream& out, const ${{self.c_ident}}& obj); 5066657Snate@binkert.org 5077007Snate@binkert.org#endif // __${{self.c_ident}}_HH__ 5086657Snate@binkert.org''') 5096657Snate@binkert.org 5106657Snate@binkert.org code.write(path, "%s.hh" % self.c_ident) 5116657Snate@binkert.org 5126657Snate@binkert.org def printEnumCC(self, path): 5136999Snate@binkert.org code = self.symtab.codeFormatter() 5146657Snate@binkert.org code(''' 5156657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 5166657Snate@binkert.org * 5176657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 5186657Snate@binkert.org */ 5196657Snate@binkert.org 5207002Snate@binkert.org#include <iostream> 5217002Snate@binkert.org#include <string> 5227002Snate@binkert.org 5236657Snate@binkert.org#include "mem/protocol/${{self.c_ident}}.hh" 5246657Snate@binkert.org 5257002Snate@binkert.orgusing namespace std; 5267002Snate@binkert.org 5276657Snate@binkert.org''') 5286657Snate@binkert.org 5296657Snate@binkert.org if self.isMachineType: 5306657Snate@binkert.org for enum in self.enums.itervalues(): 5316657Snate@binkert.org code('#include "mem/protocol/${{enum.ident}}_Controller.hh"') 5326657Snate@binkert.org 5336657Snate@binkert.org code(''' 5347007Snate@binkert.org// Code for output operator 5357007Snate@binkert.orgostream& 5367007Snate@binkert.orgoperator<<(ostream& out, const ${{self.c_ident}}& obj) 5376657Snate@binkert.org{ 5386657Snate@binkert.org out << ${{self.c_ident}}_to_string(obj); 5396657Snate@binkert.org out << flush; 5406657Snate@binkert.org return out; 5416657Snate@binkert.org} 5426657Snate@binkert.org 5437007Snate@binkert.org// Code to convert state to a string 5447007Snate@binkert.orgstring 5457007Snate@binkert.org${{self.c_ident}}_to_string(const ${{self.c_ident}}& obj) 5466657Snate@binkert.org{ 5476657Snate@binkert.org switch(obj) { 5486657Snate@binkert.org''') 5496657Snate@binkert.org 5506657Snate@binkert.org # For each field 5516657Snate@binkert.org code.indent() 5526657Snate@binkert.org for enum in self.enums.itervalues(): 5536657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 5546657Snate@binkert.org code(' return "${{enum.ident}}";') 5556657Snate@binkert.org code.dedent() 5566657Snate@binkert.org 5576657Snate@binkert.org # Trailer 5586657Snate@binkert.org code(''' 5596657Snate@binkert.org default: 5606657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 5616657Snate@binkert.org return ""; 5626657Snate@binkert.org } 5636657Snate@binkert.org} 5646657Snate@binkert.org 5657007Snate@binkert.org// Code to convert from a string to the enumeration 5667007Snate@binkert.org${{self.c_ident}} 5677007Snate@binkert.orgstring_to_${{self.c_ident}}(const string& str) 5686657Snate@binkert.org{ 5696657Snate@binkert.org''') 5706657Snate@binkert.org 5716657Snate@binkert.org # For each field 5727007Snate@binkert.org start = "" 5736657Snate@binkert.org code.indent() 5746657Snate@binkert.org for enum in self.enums.itervalues(): 5756657Snate@binkert.org code('${start}if (str == "${{enum.ident}}") {') 5766657Snate@binkert.org code(' return ${{self.c_ident}}_${{enum.ident}};') 5777007Snate@binkert.org start = "} else " 5786657Snate@binkert.org code.dedent() 5796657Snate@binkert.org 5806657Snate@binkert.org code(''' 5816657Snate@binkert.org } else { 5826657Snate@binkert.org WARN_EXPR(str); 5836657Snate@binkert.org ERROR_MSG("Invalid string conversion for type ${{self.c_ident}}"); 5846657Snate@binkert.org } 5856657Snate@binkert.org} 5866657Snate@binkert.org 5877007Snate@binkert.org// Code to increment an enumeration type 5887007Snate@binkert.org${{self.c_ident}}& 5897007Snate@binkert.orgoperator++(${{self.c_ident}}& e) 5907007Snate@binkert.org{ 5916657Snate@binkert.org assert(e < ${{self.c_ident}}_NUM); 5926657Snate@binkert.org return e = ${{self.c_ident}}(e+1); 5936657Snate@binkert.org} 5946657Snate@binkert.org''') 5956657Snate@binkert.org 5966657Snate@binkert.org # MachineType hack used to set the base level and number of 5976657Snate@binkert.org # components for each Machine 5986657Snate@binkert.org if self.isMachineType: 5996657Snate@binkert.org code(''' 6007007Snate@binkert.org/** \\brief returns the base vector index for each machine type to be 6017007Snate@binkert.org * used by NetDest 6026657Snate@binkert.org * 6036657Snate@binkert.org * \\return the base vector index for each machine type to be used by NetDest 6046657Snate@binkert.org * \\see NetDest.hh 6056657Snate@binkert.org */ 6067007Snate@binkert.orgint 6077007Snate@binkert.org${{self.c_ident}}_base_level(const ${{self.c_ident}}& obj) 6086657Snate@binkert.org{ 6096657Snate@binkert.org switch(obj) { 6106657Snate@binkert.org''') 6116657Snate@binkert.org 6126657Snate@binkert.org # For each field 6136657Snate@binkert.org code.indent() 6146657Snate@binkert.org for i,enum in enumerate(self.enums.itervalues()): 6156657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 6166657Snate@binkert.org code(' return $i;') 6176657Snate@binkert.org code.dedent() 6186657Snate@binkert.org 6196657Snate@binkert.org # total num 6206657Snate@binkert.org code(''' 6216657Snate@binkert.org case ${{self.c_ident}}_NUM: 6226657Snate@binkert.org return ${{len(self.enums)}}; 6236657Snate@binkert.org 6246657Snate@binkert.org default: 6256657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 6266657Snate@binkert.org return -1; 6276657Snate@binkert.org } 6286657Snate@binkert.org} 6296657Snate@binkert.org 6306657Snate@binkert.org/** \\brief returns the machine type for each base vector index used by NetDest 6316657Snate@binkert.org * 6327007Snate@binkert.org * \\return the MachineType 6336657Snate@binkert.org */ 6347007Snate@binkert.orgMachineType 6357007Snate@binkert.org${{self.c_ident}}_from_base_level(int type) 6366657Snate@binkert.org{ 6376657Snate@binkert.org switch(type) { 6386657Snate@binkert.org''') 6396657Snate@binkert.org 6406657Snate@binkert.org # For each field 6416657Snate@binkert.org code.indent() 6426657Snate@binkert.org for i,enum in enumerate(self.enums.itervalues()): 6436657Snate@binkert.org code(' case $i:') 6446657Snate@binkert.org code(' return ${{self.c_ident}}_${{enum.ident}};') 6456657Snate@binkert.org code.dedent() 6466657Snate@binkert.org 6476657Snate@binkert.org # Trailer 6486657Snate@binkert.org code(''' 6496657Snate@binkert.org default: 6506657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 6516657Snate@binkert.org return MachineType_NUM; 6526657Snate@binkert.org } 6536657Snate@binkert.org} 6546657Snate@binkert.org 6556657Snate@binkert.org/** \\brief The return value indicates the number of components created 6566657Snate@binkert.org * before a particular machine\'s components 6576657Snate@binkert.org * 6586657Snate@binkert.org * \\return the base number of components for each machine 6596657Snate@binkert.org */ 6607007Snate@binkert.orgint 6617007Snate@binkert.org${{self.c_ident}}_base_number(const ${{self.c_ident}}& obj) 6626657Snate@binkert.org{ 6636657Snate@binkert.org int base = 0; 6646657Snate@binkert.org switch(obj) { 6656657Snate@binkert.org''') 6666657Snate@binkert.org 6676657Snate@binkert.org # For each field 6686657Snate@binkert.org code.indent() 6696657Snate@binkert.org code(' case ${{self.c_ident}}_NUM:') 6706657Snate@binkert.org for enum in reversed(self.enums.values()): 6716657Snate@binkert.org code(' base += ${{enum.ident}}_Controller::getNumControllers();') 6726657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 6736657Snate@binkert.org code(' break;') 6746657Snate@binkert.org code.dedent() 6756657Snate@binkert.org 6766657Snate@binkert.org code(''' 6776657Snate@binkert.org default: 6786657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 6796657Snate@binkert.org return -1; 6806657Snate@binkert.org } 6816657Snate@binkert.org 6826657Snate@binkert.org return base; 6836657Snate@binkert.org} 6846657Snate@binkert.org 6856657Snate@binkert.org/** \\brief returns the total number of components for each machine 6866657Snate@binkert.org * \\return the total number of components for each machine 6876657Snate@binkert.org */ 6887007Snate@binkert.orgint 6897007Snate@binkert.org${{self.c_ident}}_base_count(const ${{self.c_ident}}& obj) 6906657Snate@binkert.org{ 6916657Snate@binkert.org switch(obj) { 6926657Snate@binkert.org''') 6936657Snate@binkert.org 6946657Snate@binkert.org # For each field 6956657Snate@binkert.org for enum in self.enums.itervalues(): 6966657Snate@binkert.org code(''' 6976657Snate@binkert.org case ${{self.c_ident}}_${{enum.ident}}: 6986657Snate@binkert.org return ${{enum.ident}}_Controller::getNumControllers(); 6996657Snate@binkert.org''') 7006657Snate@binkert.org 7016657Snate@binkert.org # total num 7026657Snate@binkert.org code(''' 7036657Snate@binkert.org case ${{self.c_ident}}_NUM: 7046657Snate@binkert.org default: 7056657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 7066657Snate@binkert.org return -1; 7076657Snate@binkert.org } 7086657Snate@binkert.org} 7096657Snate@binkert.org''') 7106657Snate@binkert.org 7116657Snate@binkert.org # Write the file 7126657Snate@binkert.org code.write(path, "%s.cc" % self.c_ident) 7136657Snate@binkert.org 7146657Snate@binkert.org__all__ = [ "Type" ] 715