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