Type.py revision 6882
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 286657Snate@binkert.orgfrom m5.util import code_formatter, 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): 1946657Snate@binkert.org code = code_formatter() 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 2026657Snate@binkert.org#ifndef ${{self.c_ident}}_H 2036657Snate@binkert.org#define ${{self.c_ident}}_H 2046657Snate@binkert.org 2056657Snate@binkert.org#include "mem/ruby/common/Global.hh" 2066657Snate@binkert.org#include "mem/gems_common/Allocator.hh" 2076657Snate@binkert.org''') 2086657Snate@binkert.org 2096657Snate@binkert.org for dm in self.data_members.values(): 2106657Snate@binkert.org if not dm.type.isPrimitive: 2116657Snate@binkert.org code('#include "mem/protocol/$0.hh"', dm.type.c_ident) 2126657Snate@binkert.org 2136657Snate@binkert.org parent = "" 2146657Snate@binkert.org if "interface" in self: 2156657Snate@binkert.org code('#include "mem/protocol/$0.hh"', self["interface"]) 2166657Snate@binkert.org parent = " : public %s" % self["interface"] 2176657Snate@binkert.org 2186657Snate@binkert.org code(''' 2196657Snate@binkert.org$klass ${{self.c_ident}}$parent { 2206657Snate@binkert.org public: 2216657Snate@binkert.org ${{self.c_ident}}() 2226657Snate@binkert.org''', klass="class") 2236657Snate@binkert.org 2246657Snate@binkert.org # Call superclass constructor 2256657Snate@binkert.org if "interface" in self: 2266657Snate@binkert.org code(' : ${{self["interface"]}}()') 2276657Snate@binkert.org 2286657Snate@binkert.org code.indent() 2296657Snate@binkert.org code("{") 2306657Snate@binkert.org if not self.isGlobal: 2316657Snate@binkert.org code.indent() 2326657Snate@binkert.org for dm in self.data_members.values(): 2336657Snate@binkert.org ident = dm.ident 2346657Snate@binkert.org if "default" in dm: 2356657Snate@binkert.org # look for default value 2366657Snate@binkert.org code('m_$ident = ${{dm["default"]}}; // default for this field') 2376657Snate@binkert.org elif "default" in dm.type: 2386657Snate@binkert.org # Look for the type default 2396657Snate@binkert.org tid = dm.type.c_ident 2406657Snate@binkert.org code('m_$ident = ${{dm.type["default"]}}; // default value of $tid') 2416657Snate@binkert.org else: 2426657Snate@binkert.org code('// m_$ident has no default') 2436657Snate@binkert.org code.dedent() 2446657Snate@binkert.org code('}') 2456657Snate@binkert.org 2466657Snate@binkert.org # ******** Default destructor ******** 2476657Snate@binkert.org code('~${{self.c_ident}}() { };') 2486657Snate@binkert.org 2496657Snate@binkert.org # ******** Full init constructor ******** 2506657Snate@binkert.org if not self.isGlobal: 2516657Snate@binkert.org params = [ 'const %s& local_%s' % (dm.type.c_ident, dm.ident) \ 2526657Snate@binkert.org for dm in self.data_members.itervalues() ] 2536657Snate@binkert.org 2546657Snate@binkert.org if self.isMessage: 2556657Snate@binkert.org params.append('const unsigned local_proc_id') 2566657Snate@binkert.org 2576657Snate@binkert.org params = ', '.join(params) 2586657Snate@binkert.org code('${{self.c_ident}}($params)') 2596657Snate@binkert.org 2606657Snate@binkert.org # Call superclass constructor 2616657Snate@binkert.org if "interface" in self: 2626657Snate@binkert.org code(' : ${{self["interface"]}}()') 2636657Snate@binkert.org 2646657Snate@binkert.org code('{') 2656657Snate@binkert.org code.indent() 2666657Snate@binkert.org for dm in self.data_members.values(): 2676657Snate@binkert.org code('m_${{dm.ident}} = local_${{dm.ident}};') 2686657Snate@binkert.org if "nextLineCallHack" in dm: 2696657Snate@binkert.org code('m_${{dm.ident}}${{dm["nextLineCallHack"]}};') 2706657Snate@binkert.org 2716657Snate@binkert.org if self.isMessage: 2726657Snate@binkert.org code('proc_id = local_proc_id;') 2736657Snate@binkert.org 2746657Snate@binkert.org code.dedent() 2756657Snate@binkert.org code('}') 2766657Snate@binkert.org 2776657Snate@binkert.org # create a static factory method 2786657Snate@binkert.org if "interface" in self: 2796657Snate@binkert.org code(''' 2806657Snate@binkert.orgstatic ${{self["interface"]}}* create() { 2816657Snate@binkert.org return new ${{self.c_ident}}(); 2826657Snate@binkert.org} 2836657Snate@binkert.org''') 2846657Snate@binkert.org 2856657Snate@binkert.org # ******** Message member functions ******** 2866657Snate@binkert.org # FIXME: those should be moved into slicc file, slicc should 2876657Snate@binkert.org # support more of the c++ class inheritance 2886657Snate@binkert.org 2896657Snate@binkert.org if self.isMessage: 2906657Snate@binkert.org code(''' 2916657Snate@binkert.orgMessage* clone() const { checkAllocator(); return s_allocator_ptr->allocate(*this); } 2926657Snate@binkert.orgvoid destroy() { checkAllocator(); s_allocator_ptr->deallocate(this); } 2936657Snate@binkert.orgstatic Allocator<${{self.c_ident}}>* s_allocator_ptr; 2946657Snate@binkert.orgstatic void checkAllocator() { if (s_allocator_ptr == NULL) { s_allocator_ptr = new Allocator<${{self.c_ident}}>; }} 2956657Snate@binkert.org''') 2966657Snate@binkert.org 2976657Snate@binkert.org if not self.isGlobal: 2986657Snate@binkert.org # const Get methods for each field 2996657Snate@binkert.org code('// Const accessors methods for each field') 3006657Snate@binkert.org for dm in self.data_members.values(): 3016657Snate@binkert.org code(''' 3026657Snate@binkert.org/** \\brief Const accessor method for ${{dm.ident}} field. 3036657Snate@binkert.org * \\return ${{dm.ident}} field 3046657Snate@binkert.org */ 3056657Snate@binkert.orgconst ${{dm.type.c_ident}}& get${{dm.ident}}() const { return m_${{dm.ident}}; } 3066657Snate@binkert.org''') 3076657Snate@binkert.org 3086657Snate@binkert.org # Non-const Get methods for each field 3096657Snate@binkert.org code('// Non const Accessors methods for each field') 3106657Snate@binkert.org for dm in self.data_members.values(): 3116657Snate@binkert.org code(''' 3126657Snate@binkert.org/** \\brief Non-const accessor method for ${{dm.ident}} field. 3136657Snate@binkert.org * \\return ${{dm.ident}} field 3146657Snate@binkert.org */ 3156657Snate@binkert.org${{dm.type.c_ident}}& get${{dm.ident}}() { return m_${{dm.ident}}; } 3166657Snate@binkert.org''') 3176657Snate@binkert.org 3186657Snate@binkert.org #Set methods for each field 3196657Snate@binkert.org code('// Mutator methods for each field') 3206657Snate@binkert.org for dm in self.data_members.values(): 3216657Snate@binkert.org code(''' 3226657Snate@binkert.org/** \\brief Mutator method for ${{dm.ident}} field */ 3236657Snate@binkert.orgvoid set${{dm.ident}}(const ${{dm.type.c_ident}}& local_${{dm.ident}}) { m_${{dm.ident}} = local_${{dm.ident}}; } 3246657Snate@binkert.org''') 3256657Snate@binkert.org 3266657Snate@binkert.org code('void print(ostream& out) const;') 3276657Snate@binkert.org code.dedent() 3286657Snate@binkert.org code(' //private:') 3296657Snate@binkert.org code.indent() 3306657Snate@binkert.org 3316657Snate@binkert.org # Data members for each field 3326657Snate@binkert.org for dm in self.data_members.values(): 3336657Snate@binkert.org if "abstract" not in dm: 3346657Snate@binkert.org const = "" 3356657Snate@binkert.org init = "" 3366657Snate@binkert.org 3376657Snate@binkert.org # global structure 3386657Snate@binkert.org if self.isGlobal: 3396657Snate@binkert.org const = "static const " 3406657Snate@binkert.org 3416657Snate@binkert.org # init value 3426657Snate@binkert.org if dm.init_code: 3436657Snate@binkert.org # only global structure can have init value here 3446657Snate@binkert.org assert self.isGlobal 3456657Snate@binkert.org init = " = %s" % (dm.init_code) 3466657Snate@binkert.org 3476657Snate@binkert.org desc = "" 3486657Snate@binkert.org if "desc" in dm: 3496657Snate@binkert.org desc = '/**< %s */' % dm["desc"] 3506657Snate@binkert.org 3516657Snate@binkert.org code('$const${{dm.type.c_ident}} m_${{dm.ident}}$init; $desc') 3526657Snate@binkert.org 3536657Snate@binkert.org if self.isMessage: 3546657Snate@binkert.org code('unsigned proc_id;') 3556657Snate@binkert.org 3566657Snate@binkert.org code.dedent() 3576657Snate@binkert.org code('};') 3586657Snate@binkert.org 3596657Snate@binkert.org code(''' 3606657Snate@binkert.org// Output operator declaration 3616657Snate@binkert.orgostream& operator<<(ostream& out, const ${{self.c_ident}}& obj); 3626657Snate@binkert.org 3636657Snate@binkert.org// Output operator definition 3646657Snate@binkert.orgextern inline 3656657Snate@binkert.orgostream& operator<<(ostream& out, const ${{self.c_ident}}& obj) 3666657Snate@binkert.org{ 3676657Snate@binkert.org obj.print(out); 3686657Snate@binkert.org out << flush; 3696657Snate@binkert.org return out; 3706657Snate@binkert.org} 3716657Snate@binkert.org 3726657Snate@binkert.org#endif // ${{self.c_ident}}_H 3736657Snate@binkert.org''') 3746657Snate@binkert.org 3756657Snate@binkert.org code.write(path, "%s.hh" % self.c_ident) 3766657Snate@binkert.org 3776657Snate@binkert.org def printTypeCC(self, path): 3786657Snate@binkert.org code = code_formatter() 3796657Snate@binkert.org 3806657Snate@binkert.org code(''' 3816657Snate@binkert.org/** \\file ${{self.c_ident}}.cc 3826657Snate@binkert.org * 3836657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 3846657Snate@binkert.org */ 3856657Snate@binkert.org 3866657Snate@binkert.org#include "mem/protocol/${{self.c_ident}}.hh" 3876657Snate@binkert.org''') 3886657Snate@binkert.org 3896657Snate@binkert.org if self.isMessage: 3906657Snate@binkert.org code('Allocator<${{self.c_ident}}>* ${{self.c_ident}}::s_allocator_ptr = NULL;') 3916657Snate@binkert.org code(''' 3926657Snate@binkert.org/** \\brief Print the state of this object */ 3936657Snate@binkert.orgvoid ${{self.c_ident}}::print(ostream& out) const 3946657Snate@binkert.org{ 3956657Snate@binkert.org out << "[${{self.c_ident}}: "; 3966657Snate@binkert.org''') 3976657Snate@binkert.org 3986657Snate@binkert.org # For each field 3996657Snate@binkert.org code.indent() 4006657Snate@binkert.org for dm in self.data_members.values(): 4016657Snate@binkert.org code('out << "${{dm.ident}} = " << m_${{dm.ident}} << " ";''') 4026657Snate@binkert.org 4036657Snate@binkert.org if self.isMessage: 4046657Snate@binkert.org code('out << "Time = " << getTime() << " ";') 4056657Snate@binkert.org code.dedent() 4066657Snate@binkert.org 4076657Snate@binkert.org # Trailer 4086657Snate@binkert.org code(''' 4096657Snate@binkert.org out << "]"; 4106657Snate@binkert.org}''') 4116657Snate@binkert.org 4126657Snate@binkert.org code.write(path, "%s.cc" % self.c_ident) 4136657Snate@binkert.org 4146657Snate@binkert.org def printEnumHH(self, path): 4156657Snate@binkert.org code = code_formatter() 4166657Snate@binkert.org code(''' 4176657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 4186657Snate@binkert.org * 4196657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4206657Snate@binkert.org */ 4216657Snate@binkert.org#ifndef ${{self.c_ident}}_H 4226657Snate@binkert.org#define ${{self.c_ident}}_H 4236657Snate@binkert.org 4246657Snate@binkert.org#include "mem/ruby/common/Global.hh" 4256657Snate@binkert.org 4266657Snate@binkert.org/** \\enum ${{self.c_ident}} 4276657Snate@binkert.org * \\brief ${{self.desc}} 4286657Snate@binkert.org */ 4296657Snate@binkert.orgenum ${{self.c_ident}} { 4306657Snate@binkert.org ${{self.c_ident}}_FIRST, 4316657Snate@binkert.org''') 4326657Snate@binkert.org 4336657Snate@binkert.org code.indent() 4346657Snate@binkert.org # For each field 4356657Snate@binkert.org for i,(ident,enum) in enumerate(self.enums.iteritems()): 4366657Snate@binkert.org desc = enum.get("desc", "No description avaliable") 4376862Sdrh5@cs.wisc.edu if i == 0: 4386862Sdrh5@cs.wisc.edu init = ' = %s_FIRST' % self.c_ident 4396862Sdrh5@cs.wisc.edu else: 4406862Sdrh5@cs.wisc.edu init = '' 4416657Snate@binkert.org code('${{self.c_ident}}_${{enum.ident}}$init, /**< $desc */') 4426657Snate@binkert.org code.dedent() 4436657Snate@binkert.org code(''' 4446657Snate@binkert.org ${{self.c_ident}}_NUM 4456657Snate@binkert.org}; 4466657Snate@binkert.org${{self.c_ident}} string_to_${{self.c_ident}}(const string& str); 4476657Snate@binkert.orgstring ${{self.c_ident}}_to_string(const ${{self.c_ident}}& obj); 4486657Snate@binkert.org${{self.c_ident}} &operator++(${{self.c_ident}} &e); 4496657Snate@binkert.org''') 4506657Snate@binkert.org 4516657Snate@binkert.org # MachineType hack used to set the base component id for each Machine 4526657Snate@binkert.org if self.isMachineType: 4536657Snate@binkert.org code(''' 4546657Snate@binkert.orgint ${{self.c_ident}}_base_level(const ${{self.c_ident}}& obj); 4556657Snate@binkert.orgMachineType ${{self.c_ident}}_from_base_level(int); 4566657Snate@binkert.orgint ${{self.c_ident}}_base_number(const ${{self.c_ident}}& obj); 4576657Snate@binkert.orgint ${{self.c_ident}}_base_count(const ${{self.c_ident}}& obj); 4586657Snate@binkert.org''') 4596657Snate@binkert.org 4606657Snate@binkert.org for enum in self.enums.itervalues(): 4616657Snate@binkert.org code('#define MACHINETYPE_${{enum.ident}} 1') 4626657Snate@binkert.org 4636657Snate@binkert.org # Trailer 4646657Snate@binkert.org code(''' 4656657Snate@binkert.orgostream& operator<<(ostream& out, const ${{self.c_ident}}& obj); 4666657Snate@binkert.org 4676657Snate@binkert.org#endif // ${{self.c_ident}}_H 4686657Snate@binkert.org''') 4696657Snate@binkert.org 4706657Snate@binkert.org code.write(path, "%s.hh" % self.c_ident) 4716657Snate@binkert.org 4726657Snate@binkert.org def printEnumCC(self, path): 4736657Snate@binkert.org code = code_formatter() 4746657Snate@binkert.org code(''' 4756657Snate@binkert.org/** \\file ${{self.c_ident}}.hh 4766657Snate@binkert.org * 4776657Snate@binkert.org * Auto generated C++ code started by $__file__:$__line__ 4786657Snate@binkert.org */ 4796657Snate@binkert.org 4806657Snate@binkert.org#include "mem/protocol/${{self.c_ident}}.hh" 4816657Snate@binkert.org 4826657Snate@binkert.org''') 4836657Snate@binkert.org 4846657Snate@binkert.org if self.isMachineType: 4856657Snate@binkert.org for enum in self.enums.itervalues(): 4866657Snate@binkert.org code('#include "mem/protocol/${{enum.ident}}_Controller.hh"') 4876657Snate@binkert.org 4886657Snate@binkert.org code(''' 4896657Snate@binkert.orgostream& operator<<(ostream& out, const ${{self.c_ident}}& obj) 4906657Snate@binkert.org{ 4916657Snate@binkert.org out << ${{self.c_ident}}_to_string(obj); 4926657Snate@binkert.org out << flush; 4936657Snate@binkert.org return out; 4946657Snate@binkert.org} 4956657Snate@binkert.org 4966657Snate@binkert.orgstring ${{self.c_ident}}_to_string(const ${{self.c_ident}}& obj) 4976657Snate@binkert.org{ 4986657Snate@binkert.org switch(obj) { 4996657Snate@binkert.org''') 5006657Snate@binkert.org 5016657Snate@binkert.org # For each field 5026657Snate@binkert.org code.indent() 5036657Snate@binkert.org for enum in self.enums.itervalues(): 5046657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 5056657Snate@binkert.org code(' return "${{enum.ident}}";') 5066657Snate@binkert.org code.dedent() 5076657Snate@binkert.org 5086657Snate@binkert.org # Trailer 5096657Snate@binkert.org code(''' 5106657Snate@binkert.org default: 5116657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 5126657Snate@binkert.org return ""; 5136657Snate@binkert.org } 5146657Snate@binkert.org} 5156657Snate@binkert.org 5166657Snate@binkert.org${{self.c_ident}} string_to_${{self.c_ident}}(const string& str) 5176657Snate@binkert.org{ 5186657Snate@binkert.org''') 5196657Snate@binkert.org 5206657Snate@binkert.org # For each field 5216657Snate@binkert.org code.indent() 5226657Snate@binkert.org code("if (false) {") 5236657Snate@binkert.org start = "} else " 5246657Snate@binkert.org for enum in self.enums.itervalues(): 5256657Snate@binkert.org code('${start}if (str == "${{enum.ident}}") {') 5266657Snate@binkert.org code(' return ${{self.c_ident}}_${{enum.ident}};') 5276657Snate@binkert.org code.dedent() 5286657Snate@binkert.org 5296657Snate@binkert.org code(''' 5306657Snate@binkert.org } else { 5316657Snate@binkert.org WARN_EXPR(str); 5326657Snate@binkert.org ERROR_MSG("Invalid string conversion for type ${{self.c_ident}}"); 5336657Snate@binkert.org } 5346657Snate@binkert.org} 5356657Snate@binkert.org 5366657Snate@binkert.org${{self.c_ident}}& operator++(${{self.c_ident}}& e) { 5376657Snate@binkert.org assert(e < ${{self.c_ident}}_NUM); 5386657Snate@binkert.org return e = ${{self.c_ident}}(e+1); 5396657Snate@binkert.org} 5406657Snate@binkert.org''') 5416657Snate@binkert.org 5426657Snate@binkert.org # MachineType hack used to set the base level and number of 5436657Snate@binkert.org # components for each Machine 5446657Snate@binkert.org if self.isMachineType: 5456657Snate@binkert.org code(''' 5466657Snate@binkert.org/** \\brief returns the base vector index for each machine type to be used by NetDest 5476657Snate@binkert.org * 5486657Snate@binkert.org * \\return the base vector index for each machine type to be used by NetDest 5496657Snate@binkert.org * \\see NetDest.hh 5506657Snate@binkert.org */ 5516657Snate@binkert.orgint ${{self.c_ident}}_base_level(const ${{self.c_ident}}& obj) 5526657Snate@binkert.org{ 5536657Snate@binkert.org switch(obj) { 5546657Snate@binkert.org''') 5556657Snate@binkert.org 5566657Snate@binkert.org # For each field 5576657Snate@binkert.org code.indent() 5586657Snate@binkert.org for i,enum in enumerate(self.enums.itervalues()): 5596657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 5606657Snate@binkert.org code(' return $i;') 5616657Snate@binkert.org code.dedent() 5626657Snate@binkert.org 5636657Snate@binkert.org # total num 5646657Snate@binkert.org code(''' 5656657Snate@binkert.org case ${{self.c_ident}}_NUM: 5666657Snate@binkert.org return ${{len(self.enums)}}; 5676657Snate@binkert.org 5686657Snate@binkert.org default: 5696657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 5706657Snate@binkert.org return -1; 5716657Snate@binkert.org } 5726657Snate@binkert.org} 5736657Snate@binkert.org 5746657Snate@binkert.org/** \\brief returns the machine type for each base vector index used by NetDest 5756657Snate@binkert.org * 5766657Snate@binkert.org * \\return the MachineTYpe 5776657Snate@binkert.org */ 5786657Snate@binkert.orgMachineType ${{self.c_ident}}_from_base_level(int type) 5796657Snate@binkert.org{ 5806657Snate@binkert.org switch(type) { 5816657Snate@binkert.org''') 5826657Snate@binkert.org 5836657Snate@binkert.org # For each field 5846657Snate@binkert.org code.indent() 5856657Snate@binkert.org for i,enum in enumerate(self.enums.itervalues()): 5866657Snate@binkert.org code(' case $i:') 5876657Snate@binkert.org code(' return ${{self.c_ident}}_${{enum.ident}};') 5886657Snate@binkert.org code.dedent() 5896657Snate@binkert.org 5906657Snate@binkert.org # Trailer 5916657Snate@binkert.org code(''' 5926657Snate@binkert.org default: 5936657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 5946657Snate@binkert.org return MachineType_NUM; 5956657Snate@binkert.org } 5966657Snate@binkert.org} 5976657Snate@binkert.org 5986657Snate@binkert.org/** \\brief The return value indicates the number of components created 5996657Snate@binkert.org * before a particular machine\'s components 6006657Snate@binkert.org * 6016657Snate@binkert.org * \\return the base number of components for each machine 6026657Snate@binkert.org */ 6036657Snate@binkert.orgint ${{self.c_ident}}_base_number(const ${{self.c_ident}}& obj) 6046657Snate@binkert.org{ 6056657Snate@binkert.org int base = 0; 6066657Snate@binkert.org switch(obj) { 6076657Snate@binkert.org''') 6086657Snate@binkert.org 6096657Snate@binkert.org # For each field 6106657Snate@binkert.org code.indent() 6116657Snate@binkert.org code(' case ${{self.c_ident}}_NUM:') 6126657Snate@binkert.org for enum in reversed(self.enums.values()): 6136657Snate@binkert.org code(' base += ${{enum.ident}}_Controller::getNumControllers();') 6146657Snate@binkert.org code(' case ${{self.c_ident}}_${{enum.ident}}:') 6156657Snate@binkert.org code(' break;') 6166657Snate@binkert.org code.dedent() 6176657Snate@binkert.org 6186657Snate@binkert.org code(''' 6196657Snate@binkert.org default: 6206657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 6216657Snate@binkert.org return -1; 6226657Snate@binkert.org } 6236657Snate@binkert.org 6246657Snate@binkert.org return base; 6256657Snate@binkert.org} 6266657Snate@binkert.org 6276657Snate@binkert.org/** \\brief returns the total number of components for each machine 6286657Snate@binkert.org * \\return the total number of components for each machine 6296657Snate@binkert.org */ 6306657Snate@binkert.orgint ${{self.c_ident}}_base_count(const ${{self.c_ident}}& obj) 6316657Snate@binkert.org{ 6326657Snate@binkert.org switch(obj) { 6336657Snate@binkert.org''') 6346657Snate@binkert.org 6356657Snate@binkert.org # For each field 6366657Snate@binkert.org for enum in self.enums.itervalues(): 6376657Snate@binkert.org code(''' 6386657Snate@binkert.org case ${{self.c_ident}}_${{enum.ident}}: 6396657Snate@binkert.org return ${{enum.ident}}_Controller::getNumControllers(); 6406657Snate@binkert.org''') 6416657Snate@binkert.org 6426657Snate@binkert.org # total num 6436657Snate@binkert.org code(''' 6446657Snate@binkert.org case ${{self.c_ident}}_NUM: 6456657Snate@binkert.org default: 6466657Snate@binkert.org ERROR_MSG("Invalid range for type ${{self.c_ident}}"); 6476657Snate@binkert.org return -1; 6486657Snate@binkert.org } 6496657Snate@binkert.org} 6506657Snate@binkert.org''') 6516657Snate@binkert.org 6526657Snate@binkert.org # Write the file 6536657Snate@binkert.org code.write(path, "%s.cc" % self.c_ident) 6546657Snate@binkert.org 6556657Snate@binkert.org__all__ = [ "Type" ] 656