SimObject.py revision 10584
111988Sandreas.sandberg@arm.com# Copyright (c) 2012 ARM Limited 28840Sandreas.hansson@arm.com# All rights reserved. 38840Sandreas.hansson@arm.com# 48840Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 58840Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 68840Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 78840Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 88840Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 98840Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 108840Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 118840Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 128840Sandreas.hansson@arm.com# 132740SN/A# Copyright (c) 2004-2006 The Regents of The University of Michigan 149983Sstever@gmail.com# Copyright (c) 2010-20013 Advanced Micro Devices, Inc. 159983Sstever@gmail.com# Copyright (c) 2013 Mark D. Hill and David A. Wood 161046SN/A# All rights reserved. 171046SN/A# 181046SN/A# Redistribution and use in source and binary forms, with or without 191046SN/A# modification, are permitted provided that the following conditions are 201046SN/A# met: redistributions of source code must retain the above copyright 211046SN/A# notice, this list of conditions and the following disclaimer; 221046SN/A# redistributions in binary form must reproduce the above copyright 231046SN/A# notice, this list of conditions and the following disclaimer in the 241046SN/A# documentation and/or other materials provided with the distribution; 251046SN/A# neither the name of the copyright holders nor the names of its 261046SN/A# contributors may be used to endorse or promote products derived from 271046SN/A# this software without specific prior written permission. 281046SN/A# 291046SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 301046SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 311046SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 321046SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 331046SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 341046SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 351046SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 361046SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 371046SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 381046SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 391046SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 402665SN/A# 412665SN/A# Authors: Steve Reinhardt 422665SN/A# Nathan Binkert 438840Sandreas.hansson@arm.com# Andreas Hansson 4411988Sandreas.sandberg@arm.com 451046SN/Aimport sys 465766Snate@binkert.orgfrom types import FunctionType, MethodType, ModuleType 478331Ssteve.reinhardt@amd.com 4811988Sandreas.sandberg@arm.comimport m5 4911988Sandreas.sandberg@arm.comfrom m5.util import * 501438SN/A 514762Snate@binkert.org# Have to import params up top since Param is referenced on initial 526654Snate@binkert.org# load (when SimObject class references Param to create a class 5311988Sandreas.sandberg@arm.com# variable, the 'name' param)... 5412469Sglenn.bergmans@arm.comfrom m5.params import * 5512469Sglenn.bergmans@arm.com# There are a few things we need that aren't in params.__all__ since 5612469Sglenn.bergmans@arm.com# normal users don't need them 573102Sstever@eecs.umich.edufrom m5.params import ParamDesc, VectorParamDesc, \ 583102Sstever@eecs.umich.edu isNullPointer, SimObjectVector, Port 593102Sstever@eecs.umich.edu 603102Sstever@eecs.umich.edufrom m5.proxy import * 616654Snate@binkert.orgfrom m5.proxy import isproxy 623102Sstever@eecs.umich.edu 633102Sstever@eecs.umich.edu##################################################################### 647528Ssteve.reinhardt@amd.com# 658839Sandreas.hansson@arm.com# M5 Python Configuration Utility 663102Sstever@eecs.umich.edu# 676654Snate@binkert.org# The basic idea is to write simple Python programs that build Python 686654Snate@binkert.org# objects corresponding to M5 SimObjects for the desired simulation 69679SN/A# configuration. For now, the Python emits a .ini file that can be 70679SN/A# parsed by M5. In the future, some tighter integration between M5 71679SN/A# and the Python interpreter may allow bypassing the .ini file. 72679SN/A# 73679SN/A# Each SimObject class in M5 is represented by a Python class with the 74679SN/A# same name. The Python inheritance tree mirrors the M5 C++ tree 751692SN/A# (e.g., SimpleCPU derives from BaseCPU in both cases, and all 76679SN/A# SimObjects inherit from a single SimObject base class). To specify 77679SN/A# an instance of an M5 SimObject in a configuration, the user simply 78679SN/A# instantiates the corresponding Python object. The parameters for 79679SN/A# that SimObject are given by assigning to attributes of the Python 80679SN/A# object, either using keyword assignment in the constructor or in 81679SN/A# separate assignment statements. For example: 82679SN/A# 83679SN/A# cache = BaseCache(size='64KB') 84679SN/A# cache.hit_latency = 3 85679SN/A# cache.assoc = 8 86679SN/A# 87679SN/A# The magic lies in the mapping of the Python attributes for SimObject 88679SN/A# classes to the actual SimObject parameter specifications. This 89679SN/A# allows parameter validity checking in the Python code. Continuing 901692SN/A# the example above, the statements "cache.blurfl=3" or 91679SN/A# "cache.assoc='hello'" would both result in runtime errors in Python, 92679SN/A# since the BaseCache object has no 'blurfl' parameter and the 'assoc' 93679SN/A# parameter requires an integer, respectively. This magic is done 94679SN/A# primarily by overriding the special __setattr__ method that controls 95679SN/A# assignment to object attributes. 96679SN/A# 97679SN/A# Once a set of Python objects have been instantiated in a hierarchy, 98679SN/A# calling 'instantiate(obj)' (where obj is the root of the hierarchy) 99679SN/A# will generate a .ini file. 100679SN/A# 101679SN/A##################################################################### 102679SN/A 103679SN/A# list of all SimObject classes 104679SN/AallClasses = {} 105679SN/A 1062740SN/A# dict to look up SimObjects based on path 107679SN/AinstanceDict = {} 108679SN/A 109679SN/A# Did any of the SimObjects lack a header file? 1104762Snate@binkert.orgnoCxxHeader = False 1114762Snate@binkert.org 1124762Snate@binkert.orgdef public_value(key, value): 1132738SN/A return key.startswith('_') or \ 1142738SN/A isinstance(value, (FunctionType, MethodType, ModuleType, 1152738SN/A classmethod, type)) 1169338SAndreas.Sandberg@arm.com 1179338SAndreas.Sandberg@arm.comdef createCxxConfigDirectoryEntryFile(code, name, simobj, is_header): 1189338SAndreas.Sandberg@arm.com entry_class = 'CxxConfigDirectoryEntry_%s' % name 1197673Snate@binkert.org param_class = '%sCxxConfigParams' % name 1207673Snate@binkert.org 1218331Ssteve.reinhardt@amd.com code('#include "params/%s.hh"' % name) 1228331Ssteve.reinhardt@amd.com 1237673Snate@binkert.org if not is_header: 12410458Sandreas.hansson@arm.com for param in simobj._params.values(): 12510458Sandreas.hansson@arm.com if isSimObjectClass(param.ptype): 12610458Sandreas.hansson@arm.com code('#include "%s"' % param.ptype._value_dict['cxx_header']) 12710458Sandreas.hansson@arm.com code('#include "params/%s.hh"' % param.ptype.__name__) 12810458Sandreas.hansson@arm.com else: 12910458Sandreas.hansson@arm.com param.ptype.cxx_ini_predecls(code) 13010458Sandreas.hansson@arm.com 13110458Sandreas.hansson@arm.com if is_header: 13210458Sandreas.hansson@arm.com member_prefix = '' 13310458Sandreas.hansson@arm.com end_of_decl = ';' 13410458Sandreas.hansson@arm.com code('#include "sim/cxx_config.hh"') 13510458Sandreas.hansson@arm.com code() 13610458Sandreas.hansson@arm.com code('class ${param_class} : public CxxConfigParams,' 13710458Sandreas.hansson@arm.com ' public ${name}Params') 13810458Sandreas.hansson@arm.com code('{') 13910458Sandreas.hansson@arm.com code(' private:') 14010458Sandreas.hansson@arm.com code.indent() 14110458Sandreas.hansson@arm.com code('class DirectoryEntry : public CxxConfigDirectoryEntry') 14210458Sandreas.hansson@arm.com code('{') 14310458Sandreas.hansson@arm.com code(' public:') 14410458Sandreas.hansson@arm.com code.indent() 14510458Sandreas.hansson@arm.com code('DirectoryEntry();'); 14610458Sandreas.hansson@arm.com code() 14710458Sandreas.hansson@arm.com code('CxxConfigParams *makeParamsObject() const') 14810458Sandreas.hansson@arm.com code('{ return new ${param_class}; }') 14910458Sandreas.hansson@arm.com code.dedent() 15010458Sandreas.hansson@arm.com code('};') 15110458Sandreas.hansson@arm.com code() 15210458Sandreas.hansson@arm.com code.dedent() 15310458Sandreas.hansson@arm.com code(' public:') 15410458Sandreas.hansson@arm.com code.indent() 15510458Sandreas.hansson@arm.com else: 15610458Sandreas.hansson@arm.com member_prefix = '%s::' % param_class 15710458Sandreas.hansson@arm.com end_of_decl = '' 15810458Sandreas.hansson@arm.com code('#include "%s"' % simobj._value_dict['cxx_header']) 15910458Sandreas.hansson@arm.com code('#include "base/str.hh"') 16010458Sandreas.hansson@arm.com code('#include "cxx_config/${name}.hh"') 16110458Sandreas.hansson@arm.com 16210458Sandreas.hansson@arm.com if simobj._ports.values() != []: 16310458Sandreas.hansson@arm.com code('#include "mem/mem_object.hh"') 16410458Sandreas.hansson@arm.com code('#include "mem/port.hh"') 16510458Sandreas.hansson@arm.com 16610458Sandreas.hansson@arm.com code() 16710458Sandreas.hansson@arm.com code('${member_prefix}DirectoryEntry::DirectoryEntry()'); 16810458Sandreas.hansson@arm.com code('{') 16910458Sandreas.hansson@arm.com 17010458Sandreas.hansson@arm.com def cxx_bool(b): 17110458Sandreas.hansson@arm.com return 'true' if b else 'false' 17210458Sandreas.hansson@arm.com 17310458Sandreas.hansson@arm.com code.indent() 17410458Sandreas.hansson@arm.com for param in simobj._params.values(): 17510458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 17610458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 17710458Sandreas.hansson@arm.com 17810458Sandreas.hansson@arm.com code('parameters["%s"] = new ParamDesc("%s", %s, %s);' % 17910458Sandreas.hansson@arm.com (param.name, param.name, cxx_bool(is_vector), 18010458Sandreas.hansson@arm.com cxx_bool(is_simobj))); 18110458Sandreas.hansson@arm.com 18210458Sandreas.hansson@arm.com for port in simobj._ports.values(): 18310458Sandreas.hansson@arm.com is_vector = isinstance(port, m5.params.VectorPort) 18410458Sandreas.hansson@arm.com is_master = port.role == 'MASTER' 18510458Sandreas.hansson@arm.com 18610458Sandreas.hansson@arm.com code('ports["%s"] = new PortDesc("%s", %s, %s);' % 18710458Sandreas.hansson@arm.com (port.name, port.name, cxx_bool(is_vector), 18810458Sandreas.hansson@arm.com cxx_bool(is_master))) 18910458Sandreas.hansson@arm.com 19010458Sandreas.hansson@arm.com code.dedent() 19110458Sandreas.hansson@arm.com code('}') 19210458Sandreas.hansson@arm.com code() 19310458Sandreas.hansson@arm.com 19410458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObject(const std::string &name,') 19510458Sandreas.hansson@arm.com code(' SimObject *simObject)${end_of_decl}') 19610458Sandreas.hansson@arm.com 19710458Sandreas.hansson@arm.com if not is_header: 19810458Sandreas.hansson@arm.com code('{') 19910458Sandreas.hansson@arm.com code.indent() 20010458Sandreas.hansson@arm.com code('bool ret = true;') 20110458Sandreas.hansson@arm.com code() 20210458Sandreas.hansson@arm.com code('if (false) {') 20310458Sandreas.hansson@arm.com for param in simobj._params.values(): 20410458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 20510458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 20610458Sandreas.hansson@arm.com 20710458Sandreas.hansson@arm.com if is_simobj and not is_vector: 20810458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 20910458Sandreas.hansson@arm.com code.indent() 21010458Sandreas.hansson@arm.com code('this->${{param.name}} = ' 21110458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(simObject);') 21210458Sandreas.hansson@arm.com code('if (simObject && !this->${{param.name}})') 21310458Sandreas.hansson@arm.com code(' ret = false;') 21410458Sandreas.hansson@arm.com code.dedent() 21510458Sandreas.hansson@arm.com code('} else {') 21610458Sandreas.hansson@arm.com code(' ret = false;') 21710458Sandreas.hansson@arm.com code('}') 21810458Sandreas.hansson@arm.com code() 21910458Sandreas.hansson@arm.com code('return ret;') 22010458Sandreas.hansson@arm.com code.dedent() 22110458Sandreas.hansson@arm.com code('}') 22210458Sandreas.hansson@arm.com 22310458Sandreas.hansson@arm.com code() 22410458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObjectVector(' 22510458Sandreas.hansson@arm.com 'const std::string &name,') 22610458Sandreas.hansson@arm.com code(' const std::vector<SimObject *> &simObjects)${end_of_decl}') 22710458Sandreas.hansson@arm.com 22810458Sandreas.hansson@arm.com if not is_header: 22910458Sandreas.hansson@arm.com code('{') 23010458Sandreas.hansson@arm.com code.indent() 23110458Sandreas.hansson@arm.com code('bool ret = true;') 23210458Sandreas.hansson@arm.com code() 23310458Sandreas.hansson@arm.com code('if (false) {') 23410458Sandreas.hansson@arm.com for param in simobj._params.values(): 23510458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 23610458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 23710458Sandreas.hansson@arm.com 23810458Sandreas.hansson@arm.com if is_simobj and is_vector: 23910458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 24010458Sandreas.hansson@arm.com code.indent() 24110458Sandreas.hansson@arm.com code('this->${{param.name}}.clear();') 24210458Sandreas.hansson@arm.com code('for (auto i = simObjects.begin(); ' 24310458Sandreas.hansson@arm.com 'ret && i != simObjects.end(); i ++)') 24410458Sandreas.hansson@arm.com code('{') 24510458Sandreas.hansson@arm.com code.indent() 24610458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} object = ' 24710458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(*i);') 24810458Sandreas.hansson@arm.com code('if (*i && !object)') 24910458Sandreas.hansson@arm.com code(' ret = false;') 25010458Sandreas.hansson@arm.com code('else') 25110458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(object);') 25210458Sandreas.hansson@arm.com code.dedent() 25310458Sandreas.hansson@arm.com code('}') 25410458Sandreas.hansson@arm.com code.dedent() 25510458Sandreas.hansson@arm.com code('} else {') 25610458Sandreas.hansson@arm.com code(' ret = false;') 25710458Sandreas.hansson@arm.com code('}') 25810458Sandreas.hansson@arm.com code() 25910458Sandreas.hansson@arm.com code('return ret;') 26010458Sandreas.hansson@arm.com code.dedent() 26110458Sandreas.hansson@arm.com code('}') 26210458Sandreas.hansson@arm.com 26310458Sandreas.hansson@arm.com code() 26410458Sandreas.hansson@arm.com code('void ${member_prefix}setName(const std::string &name_)' 26510458Sandreas.hansson@arm.com '${end_of_decl}') 26610458Sandreas.hansson@arm.com 26710458Sandreas.hansson@arm.com if not is_header: 26810458Sandreas.hansson@arm.com code('{') 26910458Sandreas.hansson@arm.com code.indent() 27010458Sandreas.hansson@arm.com code('this->name = name_;') 27110458Sandreas.hansson@arm.com code('this->pyobj = NULL;') 27210458Sandreas.hansson@arm.com code.dedent() 27310458Sandreas.hansson@arm.com code('}') 27410458Sandreas.hansson@arm.com 27510458Sandreas.hansson@arm.com if is_header: 27610458Sandreas.hansson@arm.com code('const std::string &${member_prefix}getName()') 27710458Sandreas.hansson@arm.com code('{ return this->name; }') 27810458Sandreas.hansson@arm.com 27910458Sandreas.hansson@arm.com code() 28010458Sandreas.hansson@arm.com code('bool ${member_prefix}setParam(const std::string &name,') 28110458Sandreas.hansson@arm.com code(' const std::string &value, const Flags flags)${end_of_decl}') 28210458Sandreas.hansson@arm.com 28310458Sandreas.hansson@arm.com if not is_header: 28410458Sandreas.hansson@arm.com code('{') 28510458Sandreas.hansson@arm.com code.indent() 28610458Sandreas.hansson@arm.com code('bool ret = true;') 28710458Sandreas.hansson@arm.com code() 28810458Sandreas.hansson@arm.com code('if (false) {') 28910458Sandreas.hansson@arm.com for param in simobj._params.values(): 29010458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 29110458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 29210458Sandreas.hansson@arm.com 29310458Sandreas.hansson@arm.com if not is_simobj and not is_vector: 29410458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 29510458Sandreas.hansson@arm.com code.indent() 29610458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 29710458Sandreas.hansson@arm.com 'value', 'this->%s' % param.name, 'ret =') 29810458Sandreas.hansson@arm.com code.dedent() 29910458Sandreas.hansson@arm.com code('} else {') 30010458Sandreas.hansson@arm.com code(' ret = false;') 30110458Sandreas.hansson@arm.com code('}') 30210458Sandreas.hansson@arm.com code() 30310458Sandreas.hansson@arm.com code('return ret;') 30410458Sandreas.hansson@arm.com code.dedent() 30510458Sandreas.hansson@arm.com code('}') 30610458Sandreas.hansson@arm.com 30710458Sandreas.hansson@arm.com code() 30810458Sandreas.hansson@arm.com code('bool ${member_prefix}setParamVector(' 30910458Sandreas.hansson@arm.com 'const std::string &name,') 31010458Sandreas.hansson@arm.com code(' const std::vector<std::string> &values,') 31110458Sandreas.hansson@arm.com code(' const Flags flags)${end_of_decl}') 31210458Sandreas.hansson@arm.com 31310458Sandreas.hansson@arm.com if not is_header: 31410458Sandreas.hansson@arm.com code('{') 31510458Sandreas.hansson@arm.com code.indent() 31610458Sandreas.hansson@arm.com code('bool ret = true;') 31710458Sandreas.hansson@arm.com code() 31810458Sandreas.hansson@arm.com code('if (false) {') 31910458Sandreas.hansson@arm.com for param in simobj._params.values(): 32010458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 32110458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 32210458Sandreas.hansson@arm.com 32310458Sandreas.hansson@arm.com if not is_simobj and is_vector: 32410458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 32510458Sandreas.hansson@arm.com code.indent() 32610458Sandreas.hansson@arm.com code('${{param.name}}.clear();') 32710458Sandreas.hansson@arm.com code('for (auto i = values.begin(); ' 32810458Sandreas.hansson@arm.com 'ret && i != values.end(); i ++)') 32910458Sandreas.hansson@arm.com code('{') 33010458Sandreas.hansson@arm.com code.indent() 33110458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} elem;') 33210458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 33310458Sandreas.hansson@arm.com '*i', 'elem', 'ret =') 33410458Sandreas.hansson@arm.com code('if (ret)') 33510458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(elem);') 33610458Sandreas.hansson@arm.com code.dedent() 33710458Sandreas.hansson@arm.com code('}') 33810458Sandreas.hansson@arm.com code.dedent() 33910458Sandreas.hansson@arm.com code('} else {') 34010458Sandreas.hansson@arm.com code(' ret = false;') 34110458Sandreas.hansson@arm.com code('}') 34210458Sandreas.hansson@arm.com code() 34310458Sandreas.hansson@arm.com code('return ret;') 34410458Sandreas.hansson@arm.com code.dedent() 34510458Sandreas.hansson@arm.com code('}') 34610458Sandreas.hansson@arm.com 34710458Sandreas.hansson@arm.com code() 34810458Sandreas.hansson@arm.com code('bool ${member_prefix}setPortConnectionCount(' 34910458Sandreas.hansson@arm.com 'const std::string &name,') 35010458Sandreas.hansson@arm.com code(' unsigned int count)${end_of_decl}') 35110458Sandreas.hansson@arm.com 35210458Sandreas.hansson@arm.com if not is_header: 35310458Sandreas.hansson@arm.com code('{') 35410458Sandreas.hansson@arm.com code.indent() 35510458Sandreas.hansson@arm.com code('bool ret = true;') 35610458Sandreas.hansson@arm.com code() 35710458Sandreas.hansson@arm.com code('if (false)') 35810458Sandreas.hansson@arm.com code(' ;') 35910458Sandreas.hansson@arm.com for port in simobj._ports.values(): 36010458Sandreas.hansson@arm.com code('else if (name == "${{port.name}}")') 36110458Sandreas.hansson@arm.com code(' this->port_${{port.name}}_connection_count = count;') 36210458Sandreas.hansson@arm.com code('else') 36310458Sandreas.hansson@arm.com code(' ret = false;') 36410458Sandreas.hansson@arm.com code() 36510458Sandreas.hansson@arm.com code('return ret;') 36610458Sandreas.hansson@arm.com code.dedent() 36710458Sandreas.hansson@arm.com code('}') 36810458Sandreas.hansson@arm.com 36910458Sandreas.hansson@arm.com code() 37010458Sandreas.hansson@arm.com code('SimObject *${member_prefix}simObjectCreate()${end_of_decl}') 37110458Sandreas.hansson@arm.com 37210458Sandreas.hansson@arm.com if not is_header: 37310458Sandreas.hansson@arm.com code('{') 37410458Sandreas.hansson@arm.com if hasattr(simobj, 'abstract') and simobj.abstract: 37510458Sandreas.hansson@arm.com code(' return NULL;') 37610458Sandreas.hansson@arm.com else: 37710458Sandreas.hansson@arm.com code(' return this->create();') 37810458Sandreas.hansson@arm.com code('}') 37910458Sandreas.hansson@arm.com 38010458Sandreas.hansson@arm.com if is_header: 38110458Sandreas.hansson@arm.com code() 38210458Sandreas.hansson@arm.com code('static CxxConfigDirectoryEntry' 38310458Sandreas.hansson@arm.com ' *${member_prefix}makeDirectoryEntry()') 38410458Sandreas.hansson@arm.com code('{ return new DirectoryEntry; }') 38510458Sandreas.hansson@arm.com 38610458Sandreas.hansson@arm.com if is_header: 38710458Sandreas.hansson@arm.com code.dedent() 38810458Sandreas.hansson@arm.com code('};') 38910458Sandreas.hansson@arm.com 39010458Sandreas.hansson@arm.com# The metaclass for SimObject. This class controls how new classes 39110458Sandreas.hansson@arm.com# that derive from SimObject are instantiated, and provides inherited 39210458Sandreas.hansson@arm.com# class behavior (just like a class controls how instances of that 39310458Sandreas.hansson@arm.com# class are instantiated, and provides inherited instance behavior). 39410458Sandreas.hansson@arm.comclass MetaSimObject(type): 39510458Sandreas.hansson@arm.com # Attributes that can be set only at initialization time 3962740SN/A init_keywords = { 'abstract' : bool, 3972740SN/A 'cxx_class' : str, 3982740SN/A 'cxx_type' : str, 3992740SN/A 'cxx_header' : str, 4001692SN/A 'type' : str, 4011427SN/A 'cxx_bases' : list } 40211988Sandreas.sandberg@arm.com # Attributes that can be set any time 40311988Sandreas.sandberg@arm.com keywords = { 'check' : FunctionType } 40411988Sandreas.sandberg@arm.com 40511988Sandreas.sandberg@arm.com # __new__ is called before __init__, and is where the statements 40611988Sandreas.sandberg@arm.com # in the body of the class definition get loaded into the class's 40711988Sandreas.sandberg@arm.com # __dict__. We intercept this to filter out parameter & port assignments 40811988Sandreas.sandberg@arm.com # and only allow "private" attributes to be passed to the base 40911988Sandreas.sandberg@arm.com # __new__ (starting with underscore). 41011988Sandreas.sandberg@arm.com def __new__(mcls, name, bases, dict): 41111988Sandreas.sandberg@arm.com assert name not in allClasses, "SimObject %s already present" % name 4121427SN/A 4137493Ssteve.reinhardt@amd.com # Copy "private" attributes, functions, and classes to the 414679SN/A # official dict. Everything else goes in _init_dict to be 415679SN/A # filtered in __init__. 416679SN/A cls_dict = {} 4172740SN/A value_dict = {} 418679SN/A for key,val in dict.items(): 419679SN/A if public_value(key, val): 4201310SN/A cls_dict[key] = val 4216654Snate@binkert.org else: 4224762Snate@binkert.org # must be a param/port setting 4232740SN/A value_dict[key] = val 4242740SN/A if 'abstract' not in value_dict: 4252740SN/A value_dict['abstract'] = False 4262740SN/A if 'cxx_bases' not in value_dict: 4272740SN/A value_dict['cxx_bases'] = [] 42811988Sandreas.sandberg@arm.com cls_dict['_value_dict'] = value_dict 4292740SN/A cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 43011988Sandreas.sandberg@arm.com if 'type' in value_dict: 43111988Sandreas.sandberg@arm.com allClasses[name] = cls 43211988Sandreas.sandberg@arm.com return cls 43311988Sandreas.sandberg@arm.com 43411988Sandreas.sandberg@arm.com # subclass initialization 4357673Snate@binkert.org def __init__(cls, name, bases, dict): 4362740SN/A # calls type.__init__()... I think that's a no-op, but leave 4372740SN/A # it here just in case it's not. 4382740SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 4392740SN/A 4404762Snate@binkert.org # initialize required attributes 4414762Snate@binkert.org 4429342SAndreas.Sandberg@arm.com # class-only attributes 4439342SAndreas.Sandberg@arm.com cls._params = multidict() # param descriptions 44411988Sandreas.sandberg@arm.com cls._ports = multidict() # port descriptions 44511988Sandreas.sandberg@arm.com 44611988Sandreas.sandberg@arm.com # class or instance attributes 44711988Sandreas.sandberg@arm.com cls._values = multidict() # param values 44811988Sandreas.sandberg@arm.com cls._hr_values = multidict() # human readable param values 44911988Sandreas.sandberg@arm.com cls._children = multidict() # SimObject children 4502740SN/A cls._port_refs = multidict() # port ref objects 4514762Snate@binkert.org cls._instantiated = False # really instantiated, cloned, or subclassed 4524762Snate@binkert.org 4534762Snate@binkert.org # We don't support multiple inheritance of sim objects. If you want 4544762Snate@binkert.org # to, you must fix multidict to deal with it properly. Non sim-objects 455679SN/A # are ok, though 4562711SN/A bTotal = 0 457679SN/A for c in bases: 4582711SN/A if isinstance(c, MetaSimObject): 4592711SN/A bTotal += 1 4601692SN/A if bTotal > 1: 4611310SN/A raise TypeError, "SimObjects do not support multiple inheritance" 4621427SN/A 4632740SN/A base = bases[0] 4642740SN/A 4652740SN/A # Set up general inheritance via multidicts. A subclass will 4662740SN/A # inherit all its settings from the base class. The only time 4672740SN/A # the following is not true is when we define the SimObject 4682740SN/A # class itself (in which case the multidicts have no parent). 4692740SN/A if isinstance(base, MetaSimObject): 47010267SGeoffrey.Blake@arm.com cls._base = base 4717528Ssteve.reinhardt@amd.com cls._params.parent = base._params 4723105Sstever@eecs.umich.edu cls._ports.parent = base._ports 4732740SN/A cls._values.parent = base._values 4741310SN/A cls._hr_values.parent = base._hr_values 4759100SBrad.Beckmann@amd.com cls._children.parent = base._children 4769100SBrad.Beckmann@amd.com cls._port_refs.parent = base._port_refs 4779100SBrad.Beckmann@amd.com # mark base as having been subclassed 4789100SBrad.Beckmann@amd.com base._instantiated = True 4799100SBrad.Beckmann@amd.com else: 4809100SBrad.Beckmann@amd.com cls._base = None 4819100SBrad.Beckmann@amd.com 4829100SBrad.Beckmann@amd.com # default keyword values 48312023Sbrandon.potter@amd.com if 'type' in cls._value_dict: 48412023Sbrandon.potter@amd.com if 'cxx_class' not in cls._value_dict: 4851692SN/A cls._value_dict['cxx_class'] = cls._value_dict['type'] 4861692SN/A 4871692SN/A cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 4882740SN/A 4892740SN/A if 'cxx_header' not in cls._value_dict: 4902740SN/A global noCxxHeader 4912740SN/A noCxxHeader = True 4921692SN/A warn("No header file specified for SimObject: %s", name) 4935610Snate@binkert.org 4941692SN/A # Export methods are automatically inherited via C++, so we 4952740SN/A # don't want the method declarations to get inherited on the 4961692SN/A # python side (and thus end up getting repeated in the wrapped 49710267SGeoffrey.Blake@arm.com # versions of derived classes). The code below basicallly 4987528Ssteve.reinhardt@amd.com # suppresses inheritance by substituting in the base (null) 4993105Sstever@eecs.umich.edu # versions of these methods unless a different version is 5002740SN/A # explicitly supplied. 5012712SN/A for method_name in ('export_methods', 'export_method_cxx_predecls', 5025610Snate@binkert.org 'export_method_swig_predecls'): 5035610Snate@binkert.org if method_name not in cls.__dict__: 5041692SN/A base_method = getattr(MetaSimObject, method_name) 5054762Snate@binkert.org m = MethodType(base_method, cls, MetaSimObject) 5064762Snate@binkert.org setattr(cls, method_name, m) 5074762Snate@binkert.org 5085610Snate@binkert.org # Now process the _value_dict items. They could be defining 5094762Snate@binkert.org # new (or overriding existing) parameters or ports, setting 5105610Snate@binkert.org # class keywords (e.g., 'abstract'), or setting parameter 5114859Snate@binkert.org # values or port bindings. The first 3 can only be set when 5129338SAndreas.Sandberg@arm.com # the class is defined, so we handle them here. The others 5139338SAndreas.Sandberg@arm.com # can be set later too, so just emulate that by calling 5149338SAndreas.Sandberg@arm.com # setattr(). 5159528Ssascha.bischoff@arm.com for key,val in cls._value_dict.items(): 5169338SAndreas.Sandberg@arm.com # param descriptions 5172740SN/A if isinstance(val, ParamDesc): 5182740SN/A cls._new_param(key, val) 5192740SN/A 5202740SN/A # port objects 5212740SN/A elif isinstance(val, Port): 5222740SN/A cls._new_port(key, val) 5232740SN/A 5242740SN/A # init-time-only keywords 5251527SN/A elif cls.init_keywords.has_key(key): 5262740SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 5271585SN/A 5281427SN/A # default: use normal path (ends up in __setattr__) 5292738SN/A else: 5302738SN/A setattr(cls, key, val) 5313105Sstever@eecs.umich.edu 5322738SN/A def _set_keyword(cls, keyword, val, kwtype): 5331427SN/A if not isinstance(val, kwtype): 5341427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 5351427SN/A (keyword, type(val), kwtype) 5361427SN/A if isinstance(val, FunctionType): 5371427SN/A val = classmethod(val) 5381427SN/A type.__setattr__(cls, keyword, val) 5391427SN/A 5401427SN/A def _new_param(cls, name, pdesc): 5411427SN/A # each param desc should be uniquely assigned to one variable 5421427SN/A assert(not hasattr(pdesc, 'name')) 5431427SN/A pdesc.name = name 5441427SN/A cls._params[name] = pdesc 5457493Ssteve.reinhardt@amd.com if hasattr(pdesc, 'default'): 5461427SN/A cls._set_param(name, pdesc.default, pdesc) 5471427SN/A 5481427SN/A def _set_param(cls, name, value, param): 5493100SN/A assert(param.name == name) 5503100SN/A try: 5513100SN/A hr_value = value 5523100SN/A value = param.convert(value) 5533100SN/A except Exception, e: 5543100SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 5553105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 5563105Sstever@eecs.umich.edu e.args = (msg, ) 5573105Sstever@eecs.umich.edu raise 5583105Sstever@eecs.umich.edu cls._values[name] = value 5593105Sstever@eecs.umich.edu # if param value is a SimObject, make it a child too, so that 56010267SGeoffrey.Blake@arm.com # it gets cloned properly when the class is instantiated 5618321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 5623105Sstever@eecs.umich.edu cls._add_cls_child(name, value) 5633105Sstever@eecs.umich.edu # update human-readable values of the param if it has a literal 5643105Sstever@eecs.umich.edu # value and is not an object or proxy. 5653105Sstever@eecs.umich.edu if not (isSimObjectOrVector(value) or\ 5663105Sstever@eecs.umich.edu isinstance(value, m5.proxy.BaseProxy)): 5678321Ssteve.reinhardt@amd.com cls._hr_values[name] = hr_value 5688321Ssteve.reinhardt@amd.com 5698321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 5708321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 5718321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 57210267SGeoffrey.Blake@arm.com # clears the parent pointer), and this makes it clear that the 57310267SGeoffrey.Blake@arm.com # object is not an orphan and can provide better error 57410267SGeoffrey.Blake@arm.com # messages. 57510267SGeoffrey.Blake@arm.com child.set_parent(cls, name) 57610267SGeoffrey.Blake@arm.com cls._children[name] = child 5778321Ssteve.reinhardt@amd.com 5788321Ssteve.reinhardt@amd.com def _new_port(cls, name, port): 5798321Ssteve.reinhardt@amd.com # each port should be uniquely assigned to one variable 5808321Ssteve.reinhardt@amd.com assert(not hasattr(port, 'name')) 5818321Ssteve.reinhardt@amd.com port.name = name 5828321Ssteve.reinhardt@amd.com cls._ports[name] = port 5838321Ssteve.reinhardt@amd.com 5848321Ssteve.reinhardt@amd.com # same as _get_port_ref, effectively, but for classes 58512199Sgabeblack@google.com def _cls_get_port_ref(cls, attr): 58612199Sgabeblack@google.com # Return reference that can be assigned to another port 5873105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 5883105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 5893105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 5903105Sstever@eecs.umich.edu if not ref: 5913105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 5923105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 5933105Sstever@eecs.umich.edu return ref 5943105Sstever@eecs.umich.edu 5953105Sstever@eecs.umich.edu # Set attribute (called on foo.attr = value when foo is an 5963105Sstever@eecs.umich.edu # instance of class cls). 5973105Sstever@eecs.umich.edu def __setattr__(cls, attr, value): 5983105Sstever@eecs.umich.edu # normal processing for private attributes 5993105Sstever@eecs.umich.edu if public_value(attr, value): 6003105Sstever@eecs.umich.edu type.__setattr__(cls, attr, value) 6013105Sstever@eecs.umich.edu return 6023105Sstever@eecs.umich.edu 6033105Sstever@eecs.umich.edu if cls.keywords.has_key(attr): 6041585SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 6051310SN/A return 6061310SN/A 6071310SN/A if cls._ports.has_key(attr): 6081310SN/A cls._cls_get_port_ref(attr).connect(value) 6097673Snate@binkert.org return 6101310SN/A 6111310SN/A if isSimObjectOrSequence(value) and cls._instantiated: 6121310SN/A raise RuntimeError, \ 6131310SN/A "cannot set SimObject parameter '%s' after\n" \ 6141427SN/A " class %s has been instantiated or subclassed" \ 6151310SN/A % (attr, cls.__name__) 6161310SN/A 6172738SN/A # check for param 6183105Sstever@eecs.umich.edu param = cls._params.get(attr) 6192738SN/A if param: 6202738SN/A cls._set_param(attr, value, param) 6212740SN/A return 6222740SN/A 6232740SN/A if isSimObjectOrSequence(value): 6242740SN/A # If RHS is a SimObject, it's an implicit child assignment. 6252740SN/A cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 6262740SN/A return 6272740SN/A 6283105Sstever@eecs.umich.edu # no valid assignment... raise exception 6291310SN/A raise AttributeError, \ 6303105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 6313105Sstever@eecs.umich.edu 6323105Sstever@eecs.umich.edu def __getattr__(cls, attr): 6333105Sstever@eecs.umich.edu if attr == 'cxx_class_path': 6343105Sstever@eecs.umich.edu return cls.cxx_class.split('::') 6358321Ssteve.reinhardt@amd.com 6363105Sstever@eecs.umich.edu if attr == 'cxx_class_name': 6373105Sstever@eecs.umich.edu return cls.cxx_class_path[-1] 6383105Sstever@eecs.umich.edu 6393105Sstever@eecs.umich.edu if attr == 'cxx_namespaces': 6403105Sstever@eecs.umich.edu return cls.cxx_class_path[:-1] 6411310SN/A 6421585SN/A if cls._values.has_key(attr): 6437675Snate@binkert.org return cls._values[attr] 6447675Snate@binkert.org 6457675Snate@binkert.org if cls._children.has_key(attr): 6467675Snate@binkert.org return cls._children[attr] 6477675Snate@binkert.org 6487675Snate@binkert.org raise AttributeError, \ 6497675Snate@binkert.org "object '%s' has no attribute '%s'" % (cls.__name__, attr) 6507675Snate@binkert.org 6517675Snate@binkert.org def __str__(cls): 6521692SN/A return cls.__name__ 6531692SN/A 6541585SN/A # See ParamValue.cxx_predecls for description. 6557528Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 6567528Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 6577528Ssteve.reinhardt@amd.com 6581585SN/A # See ParamValue.swig_predecls for description. 6591585SN/A def swig_predecls(cls, code): 6601585SN/A code('%import "python/m5/internal/param_$cls.i"') 6613100SN/A 6623100SN/A # Hook for exporting additional C++ methods to Python via SWIG. 6633100SN/A # Default is none, override using @classmethod in class definition. 6648596Ssteve.reinhardt@amd.com def export_methods(cls, code): 6658596Ssteve.reinhardt@amd.com pass 6668596Ssteve.reinhardt@amd.com 6678596Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 66811988Sandreas.sandberg@arm.com # exported via export_methods() to be compiled in the _wrap.cc 66911988Sandreas.sandberg@arm.com # file. Typically generates one or more #include statements. If 67011988Sandreas.sandberg@arm.com # any methods are exported, typically at least the C++ header 67111988Sandreas.sandberg@arm.com # declaring the relevant SimObject class must be included. 67211988Sandreas.sandberg@arm.com def export_method_cxx_predecls(cls, code): 67311988Sandreas.sandberg@arm.com pass 67411988Sandreas.sandberg@arm.com 67511988Sandreas.sandberg@arm.com # Generate the code needed as a prerequisite for the C++ methods 67611988Sandreas.sandberg@arm.com # exported via export_methods() to be processed by SWIG. 67711988Sandreas.sandberg@arm.com # Typically generates one or more %include or %import statements. 67811988Sandreas.sandberg@arm.com # If any methods are exported, typically at least the C++ header 67911988Sandreas.sandberg@arm.com # declaring the relevant SimObject class must be included. 68011988Sandreas.sandberg@arm.com def export_method_swig_predecls(cls, code): 68111988Sandreas.sandberg@arm.com pass 68211988Sandreas.sandberg@arm.com 68311988Sandreas.sandberg@arm.com # Generate the declaration for this object for wrapping with SWIG. 68411988Sandreas.sandberg@arm.com # Generates code that goes into a SWIG .i file. Called from 68511988Sandreas.sandberg@arm.com # src/SConscript. 68611988Sandreas.sandberg@arm.com def swig_decl(cls, code): 68711988Sandreas.sandberg@arm.com class_path = cls.cxx_class.split('::') 68812035Sandreas.sandberg@arm.com classname = class_path[-1] 68911988Sandreas.sandberg@arm.com namespaces = class_path[:-1] 69012023Sbrandon.potter@amd.com 69112023Sbrandon.potter@amd.com # The 'local' attribute restricts us to the params declared in 69211988Sandreas.sandberg@arm.com # the object itself, not including inherited params (which 69311988Sandreas.sandberg@arm.com # will also be inherited from the base class's param struct 69411988Sandreas.sandberg@arm.com # here). Sort the params based on their key 69511988Sandreas.sandberg@arm.com params = map(lambda (k, v): v, sorted(cls._params.local.items())) 69611988Sandreas.sandberg@arm.com ports = cls._ports.local 69711988Sandreas.sandberg@arm.com 69811988Sandreas.sandberg@arm.com code('%module(package="m5.internal") param_$cls') 69911988Sandreas.sandberg@arm.com code() 70011988Sandreas.sandberg@arm.com code('%{') 70111988Sandreas.sandberg@arm.com code('#include "sim/sim_object.hh"') 70211988Sandreas.sandberg@arm.com code('#include "params/$cls.hh"') 70311988Sandreas.sandberg@arm.com for param in params: 70411988Sandreas.sandberg@arm.com param.cxx_predecls(code) 70511988Sandreas.sandberg@arm.com code('#include "${{cls.cxx_header}}"') 70611988Sandreas.sandberg@arm.com cls.export_method_cxx_predecls(code) 70711988Sandreas.sandberg@arm.com code('''\ 70812036Sandreas.sandberg@arm.com/** 70912036Sandreas.sandberg@arm.com * This is a workaround for bug in swig. Prior to gcc 4.6.1 the STL 71012036Sandreas.sandberg@arm.com * headers like vector, string, etc. used to automatically pull in 71111988Sandreas.sandberg@arm.com * the cstddef header but starting with gcc 4.6.1 they no longer do. 71212036Sandreas.sandberg@arm.com * This leads to swig generated a file that does not compile so we 71312036Sandreas.sandberg@arm.com * explicitly include cstddef. Additionally, including version 2.0.4, 71412036Sandreas.sandberg@arm.com * swig uses ptrdiff_t without the std:: namespace prefix which is 71511988Sandreas.sandberg@arm.com * required with gcc 4.6.1. We explicitly provide access to it. 71611988Sandreas.sandberg@arm.com */ 71711988Sandreas.sandberg@arm.com#include <cstddef> 71811988Sandreas.sandberg@arm.comusing std::ptrdiff_t; 71911988Sandreas.sandberg@arm.com''') 72011988Sandreas.sandberg@arm.com code('%}') 72111988Sandreas.sandberg@arm.com code() 72211988Sandreas.sandberg@arm.com 72311988Sandreas.sandberg@arm.com for param in params: 72411988Sandreas.sandberg@arm.com param.swig_predecls(code) 72511988Sandreas.sandberg@arm.com cls.export_method_swig_predecls(code) 72611988Sandreas.sandberg@arm.com 72711988Sandreas.sandberg@arm.com code() 72811988Sandreas.sandberg@arm.com if cls._base: 72911988Sandreas.sandberg@arm.com code('%import "python/m5/internal/param_${{cls._base}}.i"') 73011988Sandreas.sandberg@arm.com code() 73111988Sandreas.sandberg@arm.com 73211988Sandreas.sandberg@arm.com for ns in namespaces: 73311988Sandreas.sandberg@arm.com code('namespace $ns {') 73411988Sandreas.sandberg@arm.com 73511988Sandreas.sandberg@arm.com if namespaces: 73611988Sandreas.sandberg@arm.com code('// avoid name conflicts') 73711988Sandreas.sandberg@arm.com sep_string = '_COLONS_' 73811988Sandreas.sandberg@arm.com flat_name = sep_string.join(class_path) 73912036Sandreas.sandberg@arm.com code('%rename($flat_name) $classname;') 74012036Sandreas.sandberg@arm.com 74112036Sandreas.sandberg@arm.com code() 74211988Sandreas.sandberg@arm.com code('// stop swig from creating/wrapping default ctor/dtor') 74312036Sandreas.sandberg@arm.com code('%nodefault $classname;') 74412036Sandreas.sandberg@arm.com code('class $classname') 74512036Sandreas.sandberg@arm.com if cls._base: 74611988Sandreas.sandberg@arm.com bases = [ cls._base.cxx_class ] + cls.cxx_bases 74711988Sandreas.sandberg@arm.com else: 74811988Sandreas.sandberg@arm.com bases = cls.cxx_bases 74911988Sandreas.sandberg@arm.com base_first = True 75011988Sandreas.sandberg@arm.com for base in bases: 75111988Sandreas.sandberg@arm.com if base_first: 75211988Sandreas.sandberg@arm.com code(' : public ${{base}}') 75311988Sandreas.sandberg@arm.com base_first = False 75411988Sandreas.sandberg@arm.com else: 75511988Sandreas.sandberg@arm.com code(' , public ${{base}}') 75611988Sandreas.sandberg@arm.com 75711988Sandreas.sandberg@arm.com code('{') 7588596Ssteve.reinhardt@amd.com code(' public:') 7598596Ssteve.reinhardt@amd.com cls.export_methods(code) 7608596Ssteve.reinhardt@amd.com code('};') 7618596Ssteve.reinhardt@amd.com 7628596Ssteve.reinhardt@amd.com for ns in reversed(namespaces): 7633100SN/A code('} // namespace $ns') 7643100SN/A 76510584Sandreas.hansson@arm.com code() 76610584Sandreas.hansson@arm.com code('%include "params/$cls.hh"') 7678840Sandreas.hansson@arm.com 7683100SN/A 7693100SN/A # Generate the C++ declaration (.hh file) for this SimObject's 7703100SN/A # param struct. Called from src/SConscript. 7713100SN/A def cxx_param_decl(cls, code): 7723100SN/A # The 'local' attribute restricts us to the params declared in 7733100SN/A # the object itself, not including inherited params (which 7743100SN/A # will also be inherited from the base class's param struct 7757675Snate@binkert.org # here). Sort the params based on their key 7767675Snate@binkert.org params = map(lambda (k, v): v, sorted(cls._params.local.items())) 7777675Snate@binkert.org ports = cls._ports.local 7787675Snate@binkert.org try: 7797675Snate@binkert.org ptypes = [p.ptype for p in params] 7807675Snate@binkert.org except: 7817675Snate@binkert.org print cls, p, p.ptype_str 7827675Snate@binkert.org print params 78311988Sandreas.sandberg@arm.com raise 78411988Sandreas.sandberg@arm.com 78511988Sandreas.sandberg@arm.com class_path = cls._value_dict['cxx_class'].split('::') 78611988Sandreas.sandberg@arm.com 78711988Sandreas.sandberg@arm.com code('''\ 78811988Sandreas.sandberg@arm.com#ifndef __PARAMS__${cls}__ 78911988Sandreas.sandberg@arm.com#define __PARAMS__${cls}__ 79011988Sandreas.sandberg@arm.com 7917675Snate@binkert.org''') 7927675Snate@binkert.org 7937675Snate@binkert.org # A forward class declaration is sufficient since we are just 7947675Snate@binkert.org # declaring a pointer. 7957675Snate@binkert.org for ns in class_path[:-1]: 7967675Snate@binkert.org code('namespace $ns {') 7977811Ssteve.reinhardt@amd.com code('class $0;', class_path[-1]) 7987675Snate@binkert.org for ns in reversed(class_path[:-1]): 7997675Snate@binkert.org code('} // namespace $ns') 8007673Snate@binkert.org code() 8017673Snate@binkert.org 8028840Sandreas.hansson@arm.com # The base SimObject has a couple of params that get 8038840Sandreas.hansson@arm.com # automatically set from Python without being declared through 8047673Snate@binkert.org # the normal Param mechanism; we slip them in here (needed 8054762Snate@binkert.org # predecls now, actual declarations below) 8065610Snate@binkert.org if cls == SimObject: 8077673Snate@binkert.org code(''' 8087673Snate@binkert.org#ifndef PY_VERSION 8094762Snate@binkert.orgstruct PyObject; 8104762Snate@binkert.org#endif 8114762Snate@binkert.org 8127673Snate@binkert.org#include <string> 8137673Snate@binkert.org''') 8144762Snate@binkert.org for param in params: 8158596Ssteve.reinhardt@amd.com param.cxx_predecls(code) 8168597Ssteve.reinhardt@amd.com for port in ports.itervalues(): 8178597Ssteve.reinhardt@amd.com port.cxx_predecls(code) 8188597Ssteve.reinhardt@amd.com code() 8198597Ssteve.reinhardt@amd.com 8208597Ssteve.reinhardt@amd.com if cls._base: 8218597Ssteve.reinhardt@amd.com code('#include "params/${{cls._base.type}}.hh"') 8228597Ssteve.reinhardt@amd.com code() 8238597Ssteve.reinhardt@amd.com 8248597Ssteve.reinhardt@amd.com for ptype in ptypes: 8258596Ssteve.reinhardt@amd.com if issubclass(ptype, Enum): 8268597Ssteve.reinhardt@amd.com code('#include "enums/${{ptype.__name__}}.hh"') 8279983Sstever@gmail.com code() 8288597Ssteve.reinhardt@amd.com 8298596Ssteve.reinhardt@amd.com # now generate the actual param struct 8308597Ssteve.reinhardt@amd.com code("struct ${cls}Params") 8318597Ssteve.reinhardt@amd.com if cls._base: 83211988Sandreas.sandberg@arm.com code(" : public ${{cls._base.type}}Params") 8338597Ssteve.reinhardt@amd.com code("{") 8348597Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 8358840Sandreas.hansson@arm.com if 'type' in cls.__dict__: 8368840Sandreas.hansson@arm.com code(" ${{cls.cxx_type}} create();") 8378840Sandreas.hansson@arm.com 8388597Ssteve.reinhardt@amd.com code.indent() 8398597Ssteve.reinhardt@amd.com if cls == SimObject: 8405488Snate@binkert.org code(''' 8417673Snate@binkert.org SimObjectParams() {} 8427673Snate@binkert.org virtual ~SimObjectParams() {} 8435488Snate@binkert.org 8445488Snate@binkert.org std::string name; 84510458Sandreas.hansson@arm.com PyObject *pyobj; 84610458Sandreas.hansson@arm.com ''') 84710458Sandreas.hansson@arm.com for param in params: 84810458Sandreas.hansson@arm.com param.cxx_decl(code) 84910458Sandreas.hansson@arm.com for port in ports.itervalues(): 8505488Snate@binkert.org port.cxx_decl(code) 8519983Sstever@gmail.com 8529983Sstever@gmail.com code.dedent() 8539983Sstever@gmail.com code('};') 8549983Sstever@gmail.com 8559983Sstever@gmail.com code() 8569983Sstever@gmail.com code('#endif // __PARAMS__${cls}__') 8579983Sstever@gmail.com return code 8589983Sstever@gmail.com 8593100SN/A # Generate the C++ declaration/definition files for this SimObject's 86011988Sandreas.sandberg@arm.com # param struct to allow C++ initialisation 86111988Sandreas.sandberg@arm.com def cxx_config_param_file(cls, code, is_header): 86211988Sandreas.sandberg@arm.com createCxxConfigDirectoryEntryFile(code, cls.__name__, cls, is_header) 86311988Sandreas.sandberg@arm.com return code 86411988Sandreas.sandberg@arm.com 86511988Sandreas.sandberg@arm.com# This *temporary* definition is required to support calls from the 86611988Sandreas.sandberg@arm.com# SimObject class definition to the MetaSimObject methods (in 86711988Sandreas.sandberg@arm.com# particular _set_param, which gets called for parameters with default 86811988Sandreas.sandberg@arm.com# values defined on the SimObject class itself). It will get 86911988Sandreas.sandberg@arm.com# overridden by the permanent definition (which requires that 87011988Sandreas.sandberg@arm.com# SimObject be defined) lower in this file. 87111988Sandreas.sandberg@arm.comdef isSimObjectOrVector(value): 87211988Sandreas.sandberg@arm.com return False 87311988Sandreas.sandberg@arm.com 87411988Sandreas.sandberg@arm.com# This class holds information about each simobject parameter 87511988Sandreas.sandberg@arm.com# that should be displayed on the command line for use in the 87611988Sandreas.sandberg@arm.com# configuration system. 87711988Sandreas.sandberg@arm.comclass ParamInfo(object): 87811988Sandreas.sandberg@arm.com def __init__(self, type, desc, type_str, example, default_val, access_str): 87911988Sandreas.sandberg@arm.com self.type = type 88011988Sandreas.sandberg@arm.com self.desc = desc 88111988Sandreas.sandberg@arm.com self.type_str = type_str 88211988Sandreas.sandberg@arm.com self.example_str = example 88311988Sandreas.sandberg@arm.com self.default_val = default_val 88411988Sandreas.sandberg@arm.com # The string representation used to access this param through python. 88511988Sandreas.sandberg@arm.com # The method to access this parameter presented on the command line may 88611988Sandreas.sandberg@arm.com # be different, so this needs to be stored for later use. 88711988Sandreas.sandberg@arm.com self.access_str = access_str 88811988Sandreas.sandberg@arm.com self.created = True 88911988Sandreas.sandberg@arm.com 89011988Sandreas.sandberg@arm.com # Make it so we can only set attributes at initialization time 89111988Sandreas.sandberg@arm.com # and effectively make this a const object. 89211988Sandreas.sandberg@arm.com def __setattr__(self, name, value): 89311988Sandreas.sandberg@arm.com if not "created" in self.__dict__: 89411988Sandreas.sandberg@arm.com self.__dict__[name] = value 89511988Sandreas.sandberg@arm.com 89611988Sandreas.sandberg@arm.com# The SimObject class is the root of the special hierarchy. Most of 89711988Sandreas.sandberg@arm.com# the code in this class deals with the configuration hierarchy itself 89811988Sandreas.sandberg@arm.com# (parent/child node relationships). 89911988Sandreas.sandberg@arm.comclass SimObject(object): 90011988Sandreas.sandberg@arm.com # Specify metaclass. Any class inheriting from SimObject will 90110267SGeoffrey.Blake@arm.com # get this metaclass. 90210267SGeoffrey.Blake@arm.com __metaclass__ = MetaSimObject 90310267SGeoffrey.Blake@arm.com type = 'SimObject' 90410267SGeoffrey.Blake@arm.com abstract = True 90510267SGeoffrey.Blake@arm.com 90610267SGeoffrey.Blake@arm.com cxx_header = "sim/sim_object.hh" 90710267SGeoffrey.Blake@arm.com cxx_bases = [ "Drainable", "Serializable" ] 90810267SGeoffrey.Blake@arm.com eventq_index = Param.UInt32(Parent.eventq_index, "Event Queue Index") 90910267SGeoffrey.Blake@arm.com 91010267SGeoffrey.Blake@arm.com @classmethod 91110267SGeoffrey.Blake@arm.com def export_method_swig_predecls(cls, code): 91210267SGeoffrey.Blake@arm.com code(''' 91310267SGeoffrey.Blake@arm.com%include <std_string.i> 91410267SGeoffrey.Blake@arm.com 91510267SGeoffrey.Blake@arm.com%import "python/swig/drain.i" 91610267SGeoffrey.Blake@arm.com%import "python/swig/serialize.i" 91710267SGeoffrey.Blake@arm.com''') 91810267SGeoffrey.Blake@arm.com 91910267SGeoffrey.Blake@arm.com @classmethod 92010267SGeoffrey.Blake@arm.com def export_methods(cls, code): 92110267SGeoffrey.Blake@arm.com code(''' 92210267SGeoffrey.Blake@arm.com void init(); 9232740SN/A void loadState(Checkpoint *cp); 924679SN/A void initState(); 925679SN/A void regStats(); 9261692SN/A void resetStats(); 9271692SN/A void regProbePoints(); 928679SN/A void regProbeListeners(); 9291692SN/A void startup(); 9303100SN/A''') 9314762Snate@binkert.org 9329983Sstever@gmail.com # Returns a dict of all the option strings that can be 9339338SAndreas.Sandberg@arm.com # generated as command line options for this simobject instance 9349345SAndreas.Sandberg@ARM.com # by tracing all reachable params in the top level instance and 9359983Sstever@gmail.com # any children it contains. 9369342SAndreas.Sandberg@arm.com def enumerateParams(self, flags_dict = {}, 93711988Sandreas.sandberg@arm.com cmd_line_str = "", access_str = ""): 93811988Sandreas.sandberg@arm.com if hasattr(self, "_paramEnumed"): 93911988Sandreas.sandberg@arm.com print "Cycle detected enumerating params" 94011988Sandreas.sandberg@arm.com else: 94111988Sandreas.sandberg@arm.com self._paramEnumed = True 94211988Sandreas.sandberg@arm.com # Scan the children first to pick up all the objects in this SimObj 94311988Sandreas.sandberg@arm.com for keys in self._children: 94411988Sandreas.sandberg@arm.com child = self._children[keys] 94511988Sandreas.sandberg@arm.com next_cmdline_str = cmd_line_str + keys 94611988Sandreas.sandberg@arm.com next_access_str = access_str + keys 94711988Sandreas.sandberg@arm.com if not isSimObjectVector(child): 94811988Sandreas.sandberg@arm.com next_cmdline_str = next_cmdline_str + "." 94911988Sandreas.sandberg@arm.com next_access_str = next_access_str + "." 95011988Sandreas.sandberg@arm.com flags_dict = child.enumerateParams(flags_dict, 95111988Sandreas.sandberg@arm.com next_cmdline_str, 95211988Sandreas.sandberg@arm.com next_access_str) 95311988Sandreas.sandberg@arm.com 95411988Sandreas.sandberg@arm.com # Go through the simple params in the simobject in this level 95511988Sandreas.sandberg@arm.com # of the simobject hierarchy and save information about the 95611988Sandreas.sandberg@arm.com # parameter to be used for generating and processing command line 95711988Sandreas.sandberg@arm.com # options to the simulator to set these parameters. 95810267SGeoffrey.Blake@arm.com for keys,values in self._params.items(): 95910267SGeoffrey.Blake@arm.com if values.isCmdLineSettable(): 96010267SGeoffrey.Blake@arm.com type_str = '' 96110267SGeoffrey.Blake@arm.com ex_str = values.example_str() 96210267SGeoffrey.Blake@arm.com ptype = None 96310267SGeoffrey.Blake@arm.com if isinstance(values, VectorParamDesc): 96410267SGeoffrey.Blake@arm.com type_str = 'Vector_%s' % values.ptype_str 96510267SGeoffrey.Blake@arm.com ptype = values 96610267SGeoffrey.Blake@arm.com else: 96710267SGeoffrey.Blake@arm.com type_str = '%s' % values.ptype_str 96810267SGeoffrey.Blake@arm.com ptype = values.ptype 96910267SGeoffrey.Blake@arm.com 97010267SGeoffrey.Blake@arm.com if keys in self._hr_values\ 97110267SGeoffrey.Blake@arm.com and keys in self._values\ 97210267SGeoffrey.Blake@arm.com and not isinstance(self._values[keys], m5.proxy.BaseProxy): 97310267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 97410267SGeoffrey.Blake@arm.com acc_str = access_str + keys 97510267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 97610267SGeoffrey.Blake@arm.com self._params[keys].desc, type_str, ex_str, 97710267SGeoffrey.Blake@arm.com values.pretty_print(self._hr_values[keys]), 97810267SGeoffrey.Blake@arm.com acc_str) 97910267SGeoffrey.Blake@arm.com elif not keys in self._hr_values\ 98010267SGeoffrey.Blake@arm.com and not keys in self._values: 98110267SGeoffrey.Blake@arm.com # Empty param 98210267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 98310267SGeoffrey.Blake@arm.com acc_str = access_str + keys 98410267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 98510267SGeoffrey.Blake@arm.com self._params[keys].desc, 98610267SGeoffrey.Blake@arm.com type_str, ex_str, '', acc_str) 98710267SGeoffrey.Blake@arm.com 98810267SGeoffrey.Blake@arm.com return flags_dict 98910267SGeoffrey.Blake@arm.com 99010267SGeoffrey.Blake@arm.com # Initialize new instance. For objects with SimObject-valued 99110267SGeoffrey.Blake@arm.com # children, we need to recursively clone the classes represented 99210267SGeoffrey.Blake@arm.com # by those param values as well in a consistent "deep copy"-style 99310267SGeoffrey.Blake@arm.com # fashion. That is, we want to make sure that each instance is 99410267SGeoffrey.Blake@arm.com # cloned only once, and that if there are multiple references to 99510267SGeoffrey.Blake@arm.com # the same original object, we end up with the corresponding 99610267SGeoffrey.Blake@arm.com # cloned references all pointing to the same cloned instance. 99710267SGeoffrey.Blake@arm.com def __init__(self, **kwargs): 99812023Sbrandon.potter@amd.com ancestor = kwargs.get('_ancestor') 99912023Sbrandon.potter@amd.com memo_dict = kwargs.get('_memo') 100010267SGeoffrey.Blake@arm.com if memo_dict is None: 100110267SGeoffrey.Blake@arm.com # prepare to memoize any recursively instantiated objects 100210267SGeoffrey.Blake@arm.com memo_dict = {} 100310267SGeoffrey.Blake@arm.com elif ancestor: 100410267SGeoffrey.Blake@arm.com # memoize me now to avoid problems with recursive calls 100510267SGeoffrey.Blake@arm.com memo_dict[ancestor] = self 100610267SGeoffrey.Blake@arm.com 100710267SGeoffrey.Blake@arm.com if not ancestor: 100810267SGeoffrey.Blake@arm.com ancestor = self.__class__ 100910267SGeoffrey.Blake@arm.com ancestor._instantiated = True 101010267SGeoffrey.Blake@arm.com 101110267SGeoffrey.Blake@arm.com # initialize required attributes 101210267SGeoffrey.Blake@arm.com self._parent = None 101310267SGeoffrey.Blake@arm.com self._name = None 101410267SGeoffrey.Blake@arm.com self._ccObject = None # pointer to C++ object 101510267SGeoffrey.Blake@arm.com self._ccParams = None 101610267SGeoffrey.Blake@arm.com self._instantiated = False # really "cloned" 10172740SN/A 10182740SN/A # Clone children specified at class level. No need for a 10192740SN/A # multidict here since we will be cloning everything. 10202740SN/A # Do children before parameter values so that children that 10212740SN/A # are also param values get cloned properly. 10222740SN/A self._children = {} 10232740SN/A for key,val in ancestor._children.iteritems(): 10242740SN/A self.add_child(key, val(_memo=memo_dict)) 10252740SN/A 10262740SN/A # Inherit parameter values from class using multidict so 10272740SN/A # individual value settings can be overridden but we still 10282740SN/A # inherit late changes to non-overridden class values. 10292740SN/A self._values = multidict(ancestor._values) 10302740SN/A self._hr_values = multidict(ancestor._hr_values) 10312740SN/A # clone SimObject-valued parameters 10322740SN/A for key,val in ancestor._values.iteritems(): 10332711SN/A val = tryAsSimObjectOrVector(val) 10342740SN/A if val is not None: 10352740SN/A self._values[key] = val(_memo=memo_dict) 10362740SN/A 10372711SN/A # clone port references. no need to use a multidict here 10382740SN/A # since we will be creating new references for all ports. 10392740SN/A self._port_refs = {} 10407528Ssteve.reinhardt@amd.com for key,val in ancestor._port_refs.iteritems(): 10412740SN/A self._port_refs[key] = val.clone(self, memo_dict) 10424762Snate@binkert.org # apply attribute assignments from keyword args, if any 10432740SN/A for key,val in kwargs.iteritems(): 10442712SN/A setattr(self, key, val) 10458321Ssteve.reinhardt@amd.com 10468321Ssteve.reinhardt@amd.com # "Clone" the current instance by creating another instance of 10478321Ssteve.reinhardt@amd.com # this instance's class, but that inherits its parameter values 10488321Ssteve.reinhardt@amd.com # and port mappings from the current instance. If we're in a 10498321Ssteve.reinhardt@amd.com # "deep copy" recursive clone, check the _memo dict to see if 10508321Ssteve.reinhardt@amd.com # we've already cloned this instance. 10518321Ssteve.reinhardt@amd.com def __call__(self, **kwargs): 10528321Ssteve.reinhardt@amd.com memo_dict = kwargs.get('_memo') 10532711SN/A if memo_dict is None: 10547528Ssteve.reinhardt@amd.com # no memo_dict: must be top-level clone operation. 10557528Ssteve.reinhardt@amd.com # this is only allowed at the root of a hierarchy 10562740SN/A if self._parent: 105710267SGeoffrey.Blake@arm.com raise RuntimeError, "attempt to clone object %s " \ 10582740SN/A "not at the root of a tree (parent = %s)" \ 10592740SN/A % (self, self._parent) 10607528Ssteve.reinhardt@amd.com # create a new dict and use that. 10617528Ssteve.reinhardt@amd.com memo_dict = {} 10627528Ssteve.reinhardt@amd.com kwargs['_memo'] = memo_dict 10637528Ssteve.reinhardt@amd.com elif memo_dict.has_key(self): 10642740SN/A # clone already done & memoized 10652740SN/A return memo_dict[self] 10663105Sstever@eecs.umich.edu return self.__class__(_ancestor = self, **kwargs) 10673105Sstever@eecs.umich.edu 10683105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 10691692SN/A # Return reference that can be assigned to another port 10701692SN/A # via __setattr__. There is only ever one reference 10711692SN/A # object per port, but we create them lazily here. 1072679SN/A ref = self._port_refs.get(attr) 10732740SN/A if ref == None: 10742740SN/A ref = self._ports[attr].makeRef(self) 10752740SN/A self._port_refs[attr] = ref 10762740SN/A return ref 10772740SN/A 10781692SN/A def __getattr__(self, attr): 10792740SN/A if self._ports.has_key(attr): 10802740SN/A return self._get_port_ref(attr) 10812740SN/A 10822740SN/A if self._values.has_key(attr): 10832740SN/A return self._values[attr] 10842740SN/A 10852740SN/A if self._children.has_key(attr): 10862740SN/A return self._children[attr] 10872740SN/A 10882740SN/A # If the attribute exists on the C++ object, transparently 10892740SN/A # forward the reference there. This is typically used for 10902740SN/A # SWIG-wrapped methods such as init(), regStats(), 10912740SN/A # resetStats(), startup(), drain(), and 10922740SN/A # resume(). 10932740SN/A if self._ccObject and hasattr(self._ccObject, attr): 10941343SN/A return getattr(self._ccObject, attr) 10953105Sstever@eecs.umich.edu 10963105Sstever@eecs.umich.edu err_string = "object '%s' has no attribute '%s'" \ 10973105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 10983105Sstever@eecs.umich.edu 10993105Sstever@eecs.umich.edu if not self._ccObject: 11009940SGeoffrey.Blake@arm.com err_string += "\n (C++ object is not yet constructed," \ 11013105Sstever@eecs.umich.edu " so wrapped C++ methods are unavailable.)" 11023105Sstever@eecs.umich.edu 11033105Sstever@eecs.umich.edu raise AttributeError, err_string 11043105Sstever@eecs.umich.edu 11051692SN/A # Set attribute (called on foo.attr = value when foo is an 11062738SN/A # instance of class cls). 11073105Sstever@eecs.umich.edu def __setattr__(self, attr, value): 11082738SN/A # normal processing for private attributes 11091692SN/A if attr.startswith('_'): 11101692SN/A object.__setattr__(self, attr, value) 11111427SN/A return 11127528Ssteve.reinhardt@amd.com 11137528Ssteve.reinhardt@amd.com if self._ports.has_key(attr): 11147528Ssteve.reinhardt@amd.com # set up port connection 11157500Ssteve.reinhardt@amd.com self._get_port_ref(attr).connect(value) 11167500Ssteve.reinhardt@amd.com return 111711991Sandreas.sandberg@arm.com 11187500Ssteve.reinhardt@amd.com param = self._params.get(attr) 11197500Ssteve.reinhardt@amd.com if param: 11207500Ssteve.reinhardt@amd.com try: 112110002Ssteve.reinhardt@amd.com hr_value = value 11221692SN/A value = param.convert(value) 11231427SN/A except Exception, e: 112410002Ssteve.reinhardt@amd.com msg = "%s\nError setting param %s.%s to %s\n" % \ 112510002Ssteve.reinhardt@amd.com (e, self.__class__.__name__, attr, value) 112610002Ssteve.reinhardt@amd.com e.args = (msg, ) 112710002Ssteve.reinhardt@amd.com raise 112810002Ssteve.reinhardt@amd.com self._values[attr] = value 112910002Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 11301692SN/A if isSimObjectOrVector(value) and not value.has_parent(): 11311692SN/A self.add_child(attr, value) 11321692SN/A # set the human-readable value dict if this is a param 11331692SN/A # with a literal value and is not being set as an object 11341692SN/A # or proxy. 11351692SN/A if not (isSimObjectOrVector(value) or\ 11361692SN/A isinstance(value, m5.proxy.BaseProxy)): 11371427SN/A self._hr_values[attr] = hr_value 11382738SN/A 11392738SN/A return 11403105Sstever@eecs.umich.edu 11412738SN/A # if RHS is a SimObject, it's an implicit child assignment 11422738SN/A if isSimObjectOrSequence(value): 11433105Sstever@eecs.umich.edu self.add_child(attr, value) 11441692SN/A return 11451310SN/A 114610267SGeoffrey.Blake@arm.com # no valid assignment... raise exception 11471692SN/A raise AttributeError, "Class %s has no parameter %s" \ 11481587SN/A % (self.__class__.__name__, attr) 11491692SN/A 11501692SN/A 11511605SN/A # this hack allows tacking a '[0]' onto parameters that may or may 11521605SN/A # not be vectors, and always getting the first element (e.g. cpus) 11537528Ssteve.reinhardt@amd.com def __getitem__(self, key): 11548321Ssteve.reinhardt@amd.com if key == 0: 11558321Ssteve.reinhardt@amd.com return self 11568321Ssteve.reinhardt@amd.com raise IndexError, "Non-zero index '%s' to SimObject" % key 115710267SGeoffrey.Blake@arm.com 115810267SGeoffrey.Blake@arm.com # this hack allows us to iterate over a SimObject that may 115910267SGeoffrey.Blake@arm.com # not be a vector, so we can call a loop over it and get just one 116010267SGeoffrey.Blake@arm.com # element. 116110267SGeoffrey.Blake@arm.com def __len__(self): 116210267SGeoffrey.Blake@arm.com return 1 116310267SGeoffrey.Blake@arm.com 11643105Sstever@eecs.umich.edu # Also implemented by SimObjectVector 11651310SN/A def clear_parent(self, old_parent): 11667528Ssteve.reinhardt@amd.com assert self._parent is old_parent 11673105Sstever@eecs.umich.edu self._parent = None 11687528Ssteve.reinhardt@amd.com 11693105Sstever@eecs.umich.edu # Also implemented by SimObjectVector 11701693SN/A def set_parent(self, parent, name): 11713105Sstever@eecs.umich.edu self._parent = parent 11723105Sstever@eecs.umich.edu self._name = name 11733105Sstever@eecs.umich.edu 11741310SN/A # Return parent object of this SimObject, not implemented by SimObjectVector 11751310SN/A # because the elements in a SimObjectVector may not share the same parent 11761692SN/A def get_parent(self): 11771692SN/A return self._parent 11781692SN/A 11791692SN/A # Also implemented by SimObjectVector 11801692SN/A def get_name(self): 118110267SGeoffrey.Blake@arm.com return self._name 118210267SGeoffrey.Blake@arm.com 118310267SGeoffrey.Blake@arm.com # Also implemented by SimObjectVector 118410267SGeoffrey.Blake@arm.com def has_parent(self): 118510267SGeoffrey.Blake@arm.com return self._parent is not None 118610267SGeoffrey.Blake@arm.com 118710267SGeoffrey.Blake@arm.com # clear out child with given name. This code is not likely to be exercised. 11881310SN/A # See comment in add_child. 11897528Ssteve.reinhardt@amd.com def clear_child(self, name): 11907528Ssteve.reinhardt@amd.com child = self._children[name] 11917528Ssteve.reinhardt@amd.com child.clear_parent(self) 11927528Ssteve.reinhardt@amd.com del self._children[name] 11937528Ssteve.reinhardt@amd.com 11947528Ssteve.reinhardt@amd.com # Add a new child to this object. 11957528Ssteve.reinhardt@amd.com def add_child(self, name, child): 11967528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 11977528Ssteve.reinhardt@amd.com if child.has_parent(): 11987528Ssteve.reinhardt@amd.com warn("add_child('%s'): child '%s' already has parent", name, 119912023Sbrandon.potter@amd.com child.get_name()) 120012023Sbrandon.potter@amd.com if self._children.has_key(name): 120112023Sbrandon.potter@amd.com # This code path had an undiscovered bug that would make it fail 12029953Sgeoffrey.blake@arm.com # at runtime. It had been here for a long time and was only 12039953Sgeoffrey.blake@arm.com # exposed by a buggy script. Changes here will probably not be 12049953Sgeoffrey.blake@arm.com # exercised without specialized testing. 12057528Ssteve.reinhardt@amd.com self.clear_child(name) 12067528Ssteve.reinhardt@amd.com child.set_parent(self, name) 12077528Ssteve.reinhardt@amd.com self._children[name] = child 12087528Ssteve.reinhardt@amd.com 12098321Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 12108321Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 12118321Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 12127528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 12137742Sgblack@eecs.umich.edu # inside the configuration hierarchy. 12147742Sgblack@eecs.umich.edu def adoptOrphanParams(self): 12151693SN/A for key,val in self._values.iteritems(): 12161693SN/A if not isSimObjectVector(val) and isSimObjectSequence(val): 12177528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 12181693SN/A # SimObjectVector class so we can call has_parent() 12191693SN/A val = SimObjectVector(val) 12207528Ssteve.reinhardt@amd.com self._values[key] = val 12217528Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 12227528Ssteve.reinhardt@amd.com warn("%s adopting orphan SimObject param '%s'", self, key) 12238321Ssteve.reinhardt@amd.com self.add_child(key, val) 12249528Ssascha.bischoff@arm.com 12259528Ssascha.bischoff@arm.com def path(self): 12267528Ssteve.reinhardt@amd.com if not self._parent: 12277742Sgblack@eecs.umich.edu return '<orphan %s>' % self.__class__ 12287742Sgblack@eecs.umich.edu ppath = self._parent.path() 12297742Sgblack@eecs.umich.edu if ppath == 'root': 12307742Sgblack@eecs.umich.edu return self._name 12317738Sgblack@eecs.umich.edu return ppath + "." + self._name 12327528Ssteve.reinhardt@amd.com 123312199Sgabeblack@google.com def __str__(self): 123412199Sgabeblack@google.com return self.path() 12351310SN/A 12367528Ssteve.reinhardt@amd.com def config_value(self): 12377528Ssteve.reinhardt@amd.com return self.path() 12387528Ssteve.reinhardt@amd.com 12397528Ssteve.reinhardt@amd.com def ini_str(self): 12407528Ssteve.reinhardt@amd.com return self.path() 12417528Ssteve.reinhardt@amd.com 12427528Ssteve.reinhardt@amd.com def find_any(self, ptype): 12437528Ssteve.reinhardt@amd.com if isinstance(self, ptype): 12447528Ssteve.reinhardt@amd.com return self, True 12458321Ssteve.reinhardt@amd.com 12467528Ssteve.reinhardt@amd.com found_obj = None 12477528Ssteve.reinhardt@amd.com for child in self._children.itervalues(): 12488321Ssteve.reinhardt@amd.com visited = False 12499528Ssascha.bischoff@arm.com if hasattr(child, '_visited'): 12507528Ssteve.reinhardt@amd.com visited = getattr(child, '_visited') 12513105Sstever@eecs.umich.edu 12521692SN/A if isinstance(child, ptype) and not visited: 12532740SN/A if found_obj != None and child != found_obj: 12548321Ssteve.reinhardt@amd.com raise AttributeError, \ 125511231Sandreas.sandberg@arm.com 'parent.any matched more than one: %s %s' % \ 125611231Sandreas.sandberg@arm.com (found_obj.path, child.path) 125711231Sandreas.sandberg@arm.com found_obj = child 12581692SN/A # search param space 12591692SN/A for pname,pdesc in self._params.iteritems(): 12601692SN/A if issubclass(pdesc.ptype, ptype): 12611692SN/A match_obj = self._values[pname] 12621310SN/A if found_obj != None and found_obj != match_obj: 12631692SN/A raise AttributeError, \ 12641692SN/A 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 12651310SN/A found_obj = match_obj 126610380SAndrew.Bardsley@arm.com return found_obj, found_obj != None 126710380SAndrew.Bardsley@arm.com 126810380SAndrew.Bardsley@arm.com def find_all(self, ptype): 12691692SN/A all = {} 12701692SN/A # search children 12711310SN/A for child in self._children.itervalues(): 12721692SN/A # a child could be a list, so ensure we visit each item 12731692SN/A if isinstance(child, list): 12741692SN/A children = child 12751310SN/A else: 12761692SN/A children = [child] 12771692SN/A 127810195SGeoffrey.Blake@arm.com for child in children: 127910195SGeoffrey.Blake@arm.com if isinstance(child, ptype) and not isproxy(child) and \ 128010195SGeoffrey.Blake@arm.com not isNullPointer(child): 128110195SGeoffrey.Blake@arm.com all[child] = True 128210195SGeoffrey.Blake@arm.com if isSimObject(child): 12831692SN/A # also add results from the child itself 12841692SN/A child_all, done = child.find_all(ptype) 12851692SN/A all.update(dict(zip(child_all, [done] * len(child_all)))) 12861814SN/A # search param space 12871692SN/A for pname,pdesc in self._params.iteritems(): 12881692SN/A if issubclass(pdesc.ptype, ptype): 12891692SN/A match_obj = self._values[pname] 12901692SN/A if not isproxy(match_obj) and not isNullPointer(match_obj): 12911692SN/A all[match_obj] = True 12921692SN/A # Also make sure to sort the keys based on the objects' path to 12931692SN/A # ensure that the order is the same on all hosts 129412023Sbrandon.potter@amd.com return sorted(all.keys(), key = lambda o: o.path()), True 129512023Sbrandon.potter@amd.com 12961692SN/A def unproxy(self, base): 12971692SN/A return self 12981692SN/A 12998459SAli.Saidi@ARM.com def unproxyParams(self): 13008459SAli.Saidi@ARM.com for param in self._params.iterkeys(): 13018459SAli.Saidi@ARM.com value = self._values.get(param) 13028459SAli.Saidi@ARM.com if value != None and isproxy(value): 13039410Sandreas.hansson@arm.com try: 13049410Sandreas.hansson@arm.com value = value.unproxy(self) 13059410Sandreas.hansson@arm.com except: 13069410Sandreas.hansson@arm.com print "Error in unproxying param '%s' of %s" % \ 13079410Sandreas.hansson@arm.com (param, self.path()) 13089410Sandreas.hansson@arm.com raise 13099410Sandreas.hansson@arm.com setattr(self, param, value) 13109410Sandreas.hansson@arm.com 13119410Sandreas.hansson@arm.com # Unproxy ports in sorted order so that 'append' operations on 13129410Sandreas.hansson@arm.com # vector ports are done in a deterministic fashion. 13139410Sandreas.hansson@arm.com port_names = self._ports.keys() 13149410Sandreas.hansson@arm.com port_names.sort() 13159410Sandreas.hansson@arm.com for port_name in port_names: 13169410Sandreas.hansson@arm.com port = self._port_refs.get(port_name) 13178459SAli.Saidi@ARM.com if port != None: 13188459SAli.Saidi@ARM.com port.unproxy(self) 13198459SAli.Saidi@ARM.com 13208459SAli.Saidi@ARM.com def print_ini(self, ini_file): 13218459SAli.Saidi@ARM.com print >>ini_file, '[' + self.path() + ']' # .ini section header 13228459SAli.Saidi@ARM.com 132310532Sandreas.hansson@arm.com instanceDict[self.path()] = self 132410532Sandreas.hansson@arm.com 132510532Sandreas.hansson@arm.com if hasattr(self, 'type'): 13268459SAli.Saidi@ARM.com print >>ini_file, 'type=%s' % self.type 13271815SN/A 13281815SN/A if len(self._children.keys()): 13291815SN/A print >>ini_file, 'children=%s' % \ 13307527Ssteve.reinhardt@amd.com ' '.join(self._children[n].get_name() \ 13313105Sstever@eecs.umich.edu for n in sorted(self._children.keys())) 13323105Sstever@eecs.umich.edu 13336654Snate@binkert.org for param in sorted(self._params.keys()): 13343105Sstever@eecs.umich.edu value = self._values.get(param) 13353105Sstever@eecs.umich.edu if value != None: 13363105Sstever@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 13373105Sstever@eecs.umich.edu self._values[param].ini_str()) 13383105Sstever@eecs.umich.edu 13393105Sstever@eecs.umich.edu for port_name in sorted(self._ports.keys()): 13403105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 13413105Sstever@eecs.umich.edu if port != None: 13423107Sstever@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 13433107Sstever@eecs.umich.edu 13443107Sstever@eecs.umich.edu print >>ini_file # blank line between objects 13453107Sstever@eecs.umich.edu 13463107Sstever@eecs.umich.edu # generate a tree of dictionaries expressing all the parameters in the 13473105Sstever@eecs.umich.edu # instantiated system for use by scripts that want to do power, thermal 13483105Sstever@eecs.umich.edu # visualization, and other similar tasks 13493105Sstever@eecs.umich.edu def get_config_as_dict(self): 13503105Sstever@eecs.umich.edu d = attrdict() 13515037Smilesck@eecs.umich.edu if hasattr(self, 'type'): 13525543Ssaidi@eecs.umich.edu d.type = self.type 13531692SN/A if hasattr(self, 'cxx_class'): 13542738SN/A d.cxx_class = self.cxx_class 13552738SN/A # Add the name and path of this object to be able to link to 13564081Sbinkertn@umich.edu # the stats 13575037Smilesck@eecs.umich.edu d.name = self.get_name() 13581692SN/A d.path = self.path() 13598664SAli.Saidi@ARM.com 13607528Ssteve.reinhardt@amd.com for param in sorted(self._params.keys()): 13618664SAli.Saidi@ARM.com value = self._values.get(param) 13628664SAli.Saidi@ARM.com if value != None: 13631692SN/A d[param] = value.config_value() 13648664SAli.Saidi@ARM.com 13653105Sstever@eecs.umich.edu for n in sorted(self._children.keys()): 13661692SN/A child = self._children[n] 13675037Smilesck@eecs.umich.edu # Use the name of the attribute (and not get_name()) as 13685037Smilesck@eecs.umich.edu # the key in the JSON dictionary to capture the hierarchy 13691692SN/A # in the Python code that assembled this system 13708664SAli.Saidi@ARM.com d[n] = child.get_config_as_dict() 13713105Sstever@eecs.umich.edu 13723105Sstever@eecs.umich.edu for port_name in sorted(self._ports.keys()): 13735037Smilesck@eecs.umich.edu port = self._port_refs.get(port_name, None) 13743103Sstever@eecs.umich.edu if port != None: 13755543Ssaidi@eecs.umich.edu # Represent each port with a dictionary containing the 13761692SN/A # prominent attributes 13778664SAli.Saidi@ARM.com d[port_name] = port.get_config_as_dict() 13788664SAli.Saidi@ARM.com 13798664SAli.Saidi@ARM.com return d 13808664SAli.Saidi@ARM.com 13818664SAli.Saidi@ARM.com def getCCParams(self): 13828664SAli.Saidi@ARM.com if self._ccParams: 13838664SAli.Saidi@ARM.com return self._ccParams 13848664SAli.Saidi@ARM.com 13858664SAli.Saidi@ARM.com cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 13869017Sandreas.hansson@arm.com cc_params = cc_params_struct() 13879017Sandreas.hansson@arm.com cc_params.pyobj = self 13889017Sandreas.hansson@arm.com cc_params.name = str(self) 13899017Sandreas.hansson@arm.com 13908664SAli.Saidi@ARM.com param_names = self._params.keys() 13918664SAli.Saidi@ARM.com param_names.sort() 13928664SAli.Saidi@ARM.com for param in param_names: 13938848Ssteve.reinhardt@amd.com value = self._values.get(param) 139410380SAndrew.Bardsley@arm.com if value is None: 13958664SAli.Saidi@ARM.com fatal("%s.%s without default or user set value", 13968664SAli.Saidi@ARM.com self.path(), param) 13979017Sandreas.hansson@arm.com 13989017Sandreas.hansson@arm.com value = value.getValue() 13999017Sandreas.hansson@arm.com if isinstance(self._params[param], VectorParamDesc): 14009017Sandreas.hansson@arm.com assert isinstance(value, list) 14019017Sandreas.hansson@arm.com vec = getattr(cc_params, param) 14028664SAli.Saidi@ARM.com assert not len(vec) 14038664SAli.Saidi@ARM.com for v in value: 14048664SAli.Saidi@ARM.com vec.append(v) 14058664SAli.Saidi@ARM.com else: 14069017Sandreas.hansson@arm.com setattr(cc_params, param, value) 14079017Sandreas.hansson@arm.com 14089017Sandreas.hansson@arm.com port_names = self._ports.keys() 14098664SAli.Saidi@ARM.com port_names.sort() 14108664SAli.Saidi@ARM.com for port_name in port_names: 14118664SAli.Saidi@ARM.com port = self._port_refs.get(port_name, None) 14124762Snate@binkert.org if port != None: 14134762Snate@binkert.org port_count = len(port) 14144762Snate@binkert.org else: 14154762Snate@binkert.org port_count = 0 14167677Snate@binkert.org setattr(cc_params, 'port_' + port_name + '_connection_count', 14174762Snate@binkert.org port_count) 14184762Snate@binkert.org self._ccParams = cc_params 14194762Snate@binkert.org return self._ccParams 14204762Snate@binkert.org 14214762Snate@binkert.org # Get C++ object corresponding to this object, calling C++ if 14224762Snate@binkert.org # necessary to construct it. Does *not* recursively create 14234762Snate@binkert.org # children. 14244762Snate@binkert.org def getCCObject(self): 14256654Snate@binkert.org if not self._ccObject: 14266654Snate@binkert.org # Make sure this object is in the configuration hierarchy 14274762Snate@binkert.org if not self._parent and not isRoot(self): 14284762Snate@binkert.org raise RuntimeError, "Attempt to instantiate orphan node" 14294762Snate@binkert.org # Cycles in the configuration hierarchy are not supported. This 14304762Snate@binkert.org # will catch the resulting recursion and stop. 14314762Snate@binkert.org self._ccObject = -1 14324762Snate@binkert.org if not self.abstract: 143312035Sandreas.sandberg@arm.com params = self.getCCParams() 143412035Sandreas.sandberg@arm.com self._ccObject = params.create() 143512035Sandreas.sandberg@arm.com elif self._ccObject == -1: 143612035Sandreas.sandberg@arm.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 143712035Sandreas.sandberg@arm.com % self.path() 143812035Sandreas.sandberg@arm.com return self._ccObject 143912035Sandreas.sandberg@arm.com 144012035Sandreas.sandberg@arm.com def descendants(self): 14414762Snate@binkert.org yield self 14424762Snate@binkert.org # The order of the dict is implementation dependent, so sort 14434762Snate@binkert.org # it based on the key (name) to ensure the order is the same 14444762Snate@binkert.org # on all hosts 14454762Snate@binkert.org for (name, child) in sorted(self._children.iteritems()): 14464762Snate@binkert.org for obj in child.descendants(): 14474762Snate@binkert.org yield obj 14488912Sandreas.hansson@arm.com 14498912Sandreas.hansson@arm.com # Call C++ to create C++ object corresponding to this object 14508912Sandreas.hansson@arm.com def createCCObject(self): 14518912Sandreas.hansson@arm.com self.getCCParams() 14528900Sandreas.hansson@arm.com self.getCCObject() # force creation 14538912Sandreas.hansson@arm.com 14544762Snate@binkert.org def getValue(self): 14554762Snate@binkert.org return self.getCCObject() 14562738SN/A 14572740SN/A # Create C++ port connections corresponding to the connections in 14582740SN/A # _port_refs 14592740SN/A def connectPorts(self): 14602740SN/A # Sort the ports based on their attribute name to ensure the 14612740SN/A # order is the same on all hosts 14627526Ssteve.reinhardt@amd.com for (attr, portRef) in sorted(self._port_refs.iteritems()): 14637526Ssteve.reinhardt@amd.com portRef.ccConnect() 14647526Ssteve.reinhardt@amd.com 14657526Ssteve.reinhardt@amd.com# Function to provide to C++ so it can look up instances based on paths 14665244Sgblack@eecs.umich.edudef resolveSimObject(name): 14675244Sgblack@eecs.umich.edu obj = instanceDict[name] 146810267SGeoffrey.Blake@arm.com return obj.getCCObject() 146910267SGeoffrey.Blake@arm.com 147010267SGeoffrey.Blake@arm.comdef isSimObject(value): 14712740SN/A return isinstance(value, SimObject) 14727526Ssteve.reinhardt@amd.com 14732740SN/Adef isSimObjectClass(value): 14742740SN/A return issubclass(value, SimObject) 14752740SN/A 14767527Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 14777527Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 147810532Sandreas.hansson@arm.com 147910532Sandreas.hansson@arm.comdef isSimObjectSequence(value): 148010532Sandreas.hansson@arm.com if not isinstance(value, (list, tuple)) or len(value) == 0: 148110532Sandreas.hansson@arm.com return False 14827527Ssteve.reinhardt@amd.com 14837527Ssteve.reinhardt@amd.com for val in value: 14847527Ssteve.reinhardt@amd.com if not isNullPointer(val) and not isSimObject(val): 14857527Ssteve.reinhardt@amd.com return False 14864762Snate@binkert.org 14874762Snate@binkert.org return True 14884762Snate@binkert.org 14894762Snate@binkert.orgdef isSimObjectOrSequence(value): 14904762Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 14914762Snate@binkert.org 14924762Snate@binkert.orgdef isRoot(obj): 14932738SN/A from m5.objects import Root 14947527Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 14952738SN/A 149610532Sandreas.hansson@arm.comdef isSimObjectOrVector(value): 149710532Sandreas.hansson@arm.com return isSimObject(value) or isSimObjectVector(value) 149810532Sandreas.hansson@arm.com 14993105Sstever@eecs.umich.edudef tryAsSimObjectOrVector(value): 15002797SN/A if isSimObjectOrVector(value): 150112469Sglenn.bergmans@arm.com return value 150212469Sglenn.bergmans@arm.com if isSimObjectSequence(value): 150312469Sglenn.bergmans@arm.com return SimObjectVector(value) 150412469Sglenn.bergmans@arm.com return None 150512469Sglenn.bergmans@arm.com 150612469Sglenn.bergmans@arm.comdef coerceSimObjectOrVector(value): 150712469Sglenn.bergmans@arm.com value = tryAsSimObjectOrVector(value) 150812469Sglenn.bergmans@arm.com if value is None: 150912469Sglenn.bergmans@arm.com raise TypeError, "SimObject or SimObjectVector expected" 151012469Sglenn.bergmans@arm.com return value 151112469Sglenn.bergmans@arm.com 151212469Sglenn.bergmans@arm.combaseClasses = allClasses.copy() 151312469Sglenn.bergmans@arm.combaseInstances = instanceDict.copy() 15143101Sstever@eecs.umich.edu 15153101Sstever@eecs.umich.edudef clear(): 15163101Sstever@eecs.umich.edu global allClasses, instanceDict, noCxxHeader 15173101Sstever@eecs.umich.edu 1518679SN/A allClasses = baseClasses.copy() 15196654Snate@binkert.org instanceDict = baseInstances.copy() 15206654Snate@binkert.org noCxxHeader = False 15216654Snate@binkert.org 15226654Snate@binkert.org# __all__ defines the list of symbols that get exported when 15236654Snate@binkert.org# 'from config import *' is invoked. Try to keep this reasonably 15246654Snate@binkert.org# short to avoid polluting other namespaces. 15257528Ssteve.reinhardt@amd.com__all__ = [ 'SimObject' ] 15267528Ssteve.reinhardt@amd.com