SimObject.py revision 13719
113356Sciro.santilli@arm.com# Copyright (c) 2017-2018 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 4612563Sgabeblack@google.comfrom __future__ import print_function 4713714Sandreas.sandberg@arm.comfrom __future__ import absolute_import 4813719Sandreas.sandberg@arm.comimport six 4913719Sandreas.sandberg@arm.comif six.PY3: 5013719Sandreas.sandberg@arm.com long = int 5112563Sgabeblack@google.com 525766Snate@binkert.orgimport sys 538331Ssteve.reinhardt@amd.comfrom types import FunctionType, MethodType, ModuleType 5411988Sandreas.sandberg@arm.comfrom functools import wraps 5511988Sandreas.sandberg@arm.comimport inspect 561438SN/A 574762Snate@binkert.orgimport m5 586654Snate@binkert.orgfrom m5.util import * 5911988Sandreas.sandberg@arm.comfrom m5.util.pybind import * 6012469Sglenn.bergmans@arm.com# Use the pyfdt and not the helper class, because the fdthelper 6112469Sglenn.bergmans@arm.com# relies on the SimObject definition 6212469Sglenn.bergmans@arm.comfrom m5.ext.pyfdt import pyfdt 633102Sstever@eecs.umich.edu 643102Sstever@eecs.umich.edu# Have to import params up top since Param is referenced on initial 653102Sstever@eecs.umich.edu# load (when SimObject class references Param to create a class 663102Sstever@eecs.umich.edu# variable, the 'name' param)... 676654Snate@binkert.orgfrom m5.params import * 683102Sstever@eecs.umich.edu# There are a few things we need that aren't in params.__all__ since 693102Sstever@eecs.umich.edu# normal users don't need them 707528Ssteve.reinhardt@amd.comfrom m5.params import ParamDesc, VectorParamDesc, \ 718839Sandreas.hansson@arm.com isNullPointer, SimObjectVector, Port 723102Sstever@eecs.umich.edu 736654Snate@binkert.orgfrom m5.proxy import * 746654Snate@binkert.orgfrom m5.proxy import isproxy 75679SN/A 76679SN/A##################################################################### 77679SN/A# 78679SN/A# M5 Python Configuration Utility 79679SN/A# 80679SN/A# The basic idea is to write simple Python programs that build Python 811692SN/A# objects corresponding to M5 SimObjects for the desired simulation 82679SN/A# configuration. For now, the Python emits a .ini file that can be 83679SN/A# parsed by M5. In the future, some tighter integration between M5 84679SN/A# and the Python interpreter may allow bypassing the .ini file. 85679SN/A# 86679SN/A# Each SimObject class in M5 is represented by a Python class with the 87679SN/A# same name. The Python inheritance tree mirrors the M5 C++ tree 88679SN/A# (e.g., SimpleCPU derives from BaseCPU in both cases, and all 89679SN/A# SimObjects inherit from a single SimObject base class). To specify 90679SN/A# an instance of an M5 SimObject in a configuration, the user simply 91679SN/A# instantiates the corresponding Python object. The parameters for 92679SN/A# that SimObject are given by assigning to attributes of the Python 93679SN/A# object, either using keyword assignment in the constructor or in 94679SN/A# separate assignment statements. For example: 95679SN/A# 961692SN/A# cache = BaseCache(size='64KB') 97679SN/A# cache.hit_latency = 3 98679SN/A# cache.assoc = 8 99679SN/A# 100679SN/A# The magic lies in the mapping of the Python attributes for SimObject 101679SN/A# classes to the actual SimObject parameter specifications. This 102679SN/A# allows parameter validity checking in the Python code. Continuing 103679SN/A# the example above, the statements "cache.blurfl=3" or 104679SN/A# "cache.assoc='hello'" would both result in runtime errors in Python, 105679SN/A# since the BaseCache object has no 'blurfl' parameter and the 'assoc' 106679SN/A# parameter requires an integer, respectively. This magic is done 107679SN/A# primarily by overriding the special __setattr__ method that controls 108679SN/A# assignment to object attributes. 109679SN/A# 110679SN/A# Once a set of Python objects have been instantiated in a hierarchy, 111679SN/A# calling 'instantiate(obj)' (where obj is the root of the hierarchy) 1122740SN/A# will generate a .ini file. 113679SN/A# 114679SN/A##################################################################### 115679SN/A 1164762Snate@binkert.org# list of all SimObject classes 1174762Snate@binkert.orgallClasses = {} 1184762Snate@binkert.org 1192738SN/A# dict to look up SimObjects based on path 1202738SN/AinstanceDict = {} 1212738SN/A 1229338SAndreas.Sandberg@arm.com# Did any of the SimObjects lack a header file? 1239338SAndreas.Sandberg@arm.comnoCxxHeader = False 1249338SAndreas.Sandberg@arm.com 1257673Snate@binkert.orgdef public_value(key, value): 1267673Snate@binkert.org return key.startswith('_') or \ 1278331Ssteve.reinhardt@amd.com isinstance(value, (FunctionType, MethodType, ModuleType, 1288331Ssteve.reinhardt@amd.com classmethod, type)) 1297673Snate@binkert.org 13010458Sandreas.hansson@arm.comdef createCxxConfigDirectoryEntryFile(code, name, simobj, is_header): 13110458Sandreas.hansson@arm.com entry_class = 'CxxConfigDirectoryEntry_%s' % name 13210458Sandreas.hansson@arm.com param_class = '%sCxxConfigParams' % name 13310458Sandreas.hansson@arm.com 13410458Sandreas.hansson@arm.com code('#include "params/%s.hh"' % name) 13510458Sandreas.hansson@arm.com 13610458Sandreas.hansson@arm.com if not is_header: 13710458Sandreas.hansson@arm.com for param in simobj._params.values(): 13810458Sandreas.hansson@arm.com if isSimObjectClass(param.ptype): 13910458Sandreas.hansson@arm.com code('#include "%s"' % param.ptype._value_dict['cxx_header']) 14010458Sandreas.hansson@arm.com code('#include "params/%s.hh"' % param.ptype.__name__) 14110458Sandreas.hansson@arm.com else: 14210458Sandreas.hansson@arm.com param.ptype.cxx_ini_predecls(code) 14310458Sandreas.hansson@arm.com 14410458Sandreas.hansson@arm.com if is_header: 14510458Sandreas.hansson@arm.com member_prefix = '' 14610458Sandreas.hansson@arm.com end_of_decl = ';' 14710458Sandreas.hansson@arm.com code('#include "sim/cxx_config.hh"') 14810458Sandreas.hansson@arm.com code() 14910458Sandreas.hansson@arm.com code('class ${param_class} : public CxxConfigParams,' 15010458Sandreas.hansson@arm.com ' public ${name}Params') 15110458Sandreas.hansson@arm.com code('{') 15210458Sandreas.hansson@arm.com code(' private:') 15310458Sandreas.hansson@arm.com code.indent() 15410458Sandreas.hansson@arm.com code('class DirectoryEntry : public CxxConfigDirectoryEntry') 15510458Sandreas.hansson@arm.com code('{') 15610458Sandreas.hansson@arm.com code(' public:') 15710458Sandreas.hansson@arm.com code.indent() 15810458Sandreas.hansson@arm.com code('DirectoryEntry();'); 15910458Sandreas.hansson@arm.com code() 16010458Sandreas.hansson@arm.com code('CxxConfigParams *makeParamsObject() const') 16110458Sandreas.hansson@arm.com code('{ return new ${param_class}; }') 16210458Sandreas.hansson@arm.com code.dedent() 16310458Sandreas.hansson@arm.com code('};') 16410458Sandreas.hansson@arm.com code() 16510458Sandreas.hansson@arm.com code.dedent() 16610458Sandreas.hansson@arm.com code(' public:') 16710458Sandreas.hansson@arm.com code.indent() 16810458Sandreas.hansson@arm.com else: 16910458Sandreas.hansson@arm.com member_prefix = '%s::' % param_class 17010458Sandreas.hansson@arm.com end_of_decl = '' 17110458Sandreas.hansson@arm.com code('#include "%s"' % simobj._value_dict['cxx_header']) 17210458Sandreas.hansson@arm.com code('#include "base/str.hh"') 17310458Sandreas.hansson@arm.com code('#include "cxx_config/${name}.hh"') 17410458Sandreas.hansson@arm.com 17513709Sandreas.sandberg@arm.com if simobj._ports: 17610458Sandreas.hansson@arm.com code('#include "mem/mem_object.hh"') 17710458Sandreas.hansson@arm.com code('#include "mem/port.hh"') 17810458Sandreas.hansson@arm.com 17910458Sandreas.hansson@arm.com code() 18010458Sandreas.hansson@arm.com code('${member_prefix}DirectoryEntry::DirectoryEntry()'); 18110458Sandreas.hansson@arm.com code('{') 18210458Sandreas.hansson@arm.com 18310458Sandreas.hansson@arm.com def cxx_bool(b): 18410458Sandreas.hansson@arm.com return 'true' if b else 'false' 18510458Sandreas.hansson@arm.com 18610458Sandreas.hansson@arm.com code.indent() 18710458Sandreas.hansson@arm.com for param in simobj._params.values(): 18810458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 18910458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 19010458Sandreas.hansson@arm.com 19110458Sandreas.hansson@arm.com code('parameters["%s"] = new ParamDesc("%s", %s, %s);' % 19210458Sandreas.hansson@arm.com (param.name, param.name, cxx_bool(is_vector), 19310458Sandreas.hansson@arm.com cxx_bool(is_simobj))); 19410458Sandreas.hansson@arm.com 19510458Sandreas.hansson@arm.com for port in simobj._ports.values(): 19610458Sandreas.hansson@arm.com is_vector = isinstance(port, m5.params.VectorPort) 19710458Sandreas.hansson@arm.com is_master = port.role == 'MASTER' 19810458Sandreas.hansson@arm.com 19910458Sandreas.hansson@arm.com code('ports["%s"] = new PortDesc("%s", %s, %s);' % 20010458Sandreas.hansson@arm.com (port.name, port.name, cxx_bool(is_vector), 20110458Sandreas.hansson@arm.com cxx_bool(is_master))) 20210458Sandreas.hansson@arm.com 20310458Sandreas.hansson@arm.com code.dedent() 20410458Sandreas.hansson@arm.com code('}') 20510458Sandreas.hansson@arm.com code() 20610458Sandreas.hansson@arm.com 20710458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObject(const std::string &name,') 20810458Sandreas.hansson@arm.com code(' SimObject *simObject)${end_of_decl}') 20910458Sandreas.hansson@arm.com 21010458Sandreas.hansson@arm.com if not is_header: 21110458Sandreas.hansson@arm.com code('{') 21210458Sandreas.hansson@arm.com code.indent() 21310458Sandreas.hansson@arm.com code('bool ret = true;') 21410458Sandreas.hansson@arm.com code() 21510458Sandreas.hansson@arm.com code('if (false) {') 21610458Sandreas.hansson@arm.com for param in simobj._params.values(): 21710458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 21810458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 21910458Sandreas.hansson@arm.com 22010458Sandreas.hansson@arm.com if is_simobj and not is_vector: 22110458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 22210458Sandreas.hansson@arm.com code.indent() 22310458Sandreas.hansson@arm.com code('this->${{param.name}} = ' 22410458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(simObject);') 22510458Sandreas.hansson@arm.com code('if (simObject && !this->${{param.name}})') 22610458Sandreas.hansson@arm.com code(' ret = false;') 22710458Sandreas.hansson@arm.com code.dedent() 22810458Sandreas.hansson@arm.com code('} else {') 22910458Sandreas.hansson@arm.com code(' ret = false;') 23010458Sandreas.hansson@arm.com code('}') 23110458Sandreas.hansson@arm.com code() 23210458Sandreas.hansson@arm.com code('return ret;') 23310458Sandreas.hansson@arm.com code.dedent() 23410458Sandreas.hansson@arm.com code('}') 23510458Sandreas.hansson@arm.com 23610458Sandreas.hansson@arm.com code() 23710458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObjectVector(' 23810458Sandreas.hansson@arm.com 'const std::string &name,') 23910458Sandreas.hansson@arm.com code(' const std::vector<SimObject *> &simObjects)${end_of_decl}') 24010458Sandreas.hansson@arm.com 24110458Sandreas.hansson@arm.com if not is_header: 24210458Sandreas.hansson@arm.com code('{') 24310458Sandreas.hansson@arm.com code.indent() 24410458Sandreas.hansson@arm.com code('bool ret = true;') 24510458Sandreas.hansson@arm.com code() 24610458Sandreas.hansson@arm.com code('if (false) {') 24710458Sandreas.hansson@arm.com for param in simobj._params.values(): 24810458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 24910458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 25010458Sandreas.hansson@arm.com 25110458Sandreas.hansson@arm.com if is_simobj and is_vector: 25210458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 25310458Sandreas.hansson@arm.com code.indent() 25410458Sandreas.hansson@arm.com code('this->${{param.name}}.clear();') 25510458Sandreas.hansson@arm.com code('for (auto i = simObjects.begin(); ' 25610458Sandreas.hansson@arm.com 'ret && i != simObjects.end(); i ++)') 25710458Sandreas.hansson@arm.com code('{') 25810458Sandreas.hansson@arm.com code.indent() 25910458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} object = ' 26010458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(*i);') 26110458Sandreas.hansson@arm.com code('if (*i && !object)') 26210458Sandreas.hansson@arm.com code(' ret = false;') 26310458Sandreas.hansson@arm.com code('else') 26410458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(object);') 26510458Sandreas.hansson@arm.com code.dedent() 26610458Sandreas.hansson@arm.com code('}') 26710458Sandreas.hansson@arm.com code.dedent() 26810458Sandreas.hansson@arm.com code('} else {') 26910458Sandreas.hansson@arm.com code(' ret = false;') 27010458Sandreas.hansson@arm.com code('}') 27110458Sandreas.hansson@arm.com code() 27210458Sandreas.hansson@arm.com code('return ret;') 27310458Sandreas.hansson@arm.com code.dedent() 27410458Sandreas.hansson@arm.com code('}') 27510458Sandreas.hansson@arm.com 27610458Sandreas.hansson@arm.com code() 27710458Sandreas.hansson@arm.com code('void ${member_prefix}setName(const std::string &name_)' 27810458Sandreas.hansson@arm.com '${end_of_decl}') 27910458Sandreas.hansson@arm.com 28010458Sandreas.hansson@arm.com if not is_header: 28110458Sandreas.hansson@arm.com code('{') 28210458Sandreas.hansson@arm.com code.indent() 28310458Sandreas.hansson@arm.com code('this->name = name_;') 28410458Sandreas.hansson@arm.com code.dedent() 28510458Sandreas.hansson@arm.com code('}') 28610458Sandreas.hansson@arm.com 28710458Sandreas.hansson@arm.com if is_header: 28810458Sandreas.hansson@arm.com code('const std::string &${member_prefix}getName()') 28910458Sandreas.hansson@arm.com code('{ return this->name; }') 29010458Sandreas.hansson@arm.com 29110458Sandreas.hansson@arm.com code() 29210458Sandreas.hansson@arm.com code('bool ${member_prefix}setParam(const std::string &name,') 29310458Sandreas.hansson@arm.com code(' const std::string &value, const Flags flags)${end_of_decl}') 29410458Sandreas.hansson@arm.com 29510458Sandreas.hansson@arm.com if not is_header: 29610458Sandreas.hansson@arm.com code('{') 29710458Sandreas.hansson@arm.com code.indent() 29810458Sandreas.hansson@arm.com code('bool ret = true;') 29910458Sandreas.hansson@arm.com code() 30010458Sandreas.hansson@arm.com code('if (false) {') 30110458Sandreas.hansson@arm.com for param in simobj._params.values(): 30210458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 30310458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 30410458Sandreas.hansson@arm.com 30510458Sandreas.hansson@arm.com if not is_simobj and not is_vector: 30610458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 30710458Sandreas.hansson@arm.com code.indent() 30810458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 30910458Sandreas.hansson@arm.com 'value', 'this->%s' % param.name, 'ret =') 31010458Sandreas.hansson@arm.com code.dedent() 31110458Sandreas.hansson@arm.com code('} else {') 31210458Sandreas.hansson@arm.com code(' ret = false;') 31310458Sandreas.hansson@arm.com code('}') 31410458Sandreas.hansson@arm.com code() 31510458Sandreas.hansson@arm.com code('return ret;') 31610458Sandreas.hansson@arm.com code.dedent() 31710458Sandreas.hansson@arm.com code('}') 31810458Sandreas.hansson@arm.com 31910458Sandreas.hansson@arm.com code() 32010458Sandreas.hansson@arm.com code('bool ${member_prefix}setParamVector(' 32110458Sandreas.hansson@arm.com 'const std::string &name,') 32210458Sandreas.hansson@arm.com code(' const std::vector<std::string> &values,') 32310458Sandreas.hansson@arm.com code(' const Flags flags)${end_of_decl}') 32410458Sandreas.hansson@arm.com 32510458Sandreas.hansson@arm.com if not is_header: 32610458Sandreas.hansson@arm.com code('{') 32710458Sandreas.hansson@arm.com code.indent() 32810458Sandreas.hansson@arm.com code('bool ret = true;') 32910458Sandreas.hansson@arm.com code() 33010458Sandreas.hansson@arm.com code('if (false) {') 33110458Sandreas.hansson@arm.com for param in simobj._params.values(): 33210458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 33310458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 33410458Sandreas.hansson@arm.com 33510458Sandreas.hansson@arm.com if not is_simobj and is_vector: 33610458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 33710458Sandreas.hansson@arm.com code.indent() 33810458Sandreas.hansson@arm.com code('${{param.name}}.clear();') 33910458Sandreas.hansson@arm.com code('for (auto i = values.begin(); ' 34010458Sandreas.hansson@arm.com 'ret && i != values.end(); i ++)') 34110458Sandreas.hansson@arm.com code('{') 34210458Sandreas.hansson@arm.com code.indent() 34310458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} elem;') 34410458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 34510458Sandreas.hansson@arm.com '*i', 'elem', 'ret =') 34610458Sandreas.hansson@arm.com code('if (ret)') 34710458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(elem);') 34810458Sandreas.hansson@arm.com code.dedent() 34910458Sandreas.hansson@arm.com code('}') 35010458Sandreas.hansson@arm.com code.dedent() 35110458Sandreas.hansson@arm.com code('} else {') 35210458Sandreas.hansson@arm.com code(' ret = false;') 35310458Sandreas.hansson@arm.com code('}') 35410458Sandreas.hansson@arm.com code() 35510458Sandreas.hansson@arm.com code('return ret;') 35610458Sandreas.hansson@arm.com code.dedent() 35710458Sandreas.hansson@arm.com code('}') 35810458Sandreas.hansson@arm.com 35910458Sandreas.hansson@arm.com code() 36010458Sandreas.hansson@arm.com code('bool ${member_prefix}setPortConnectionCount(' 36110458Sandreas.hansson@arm.com 'const std::string &name,') 36210458Sandreas.hansson@arm.com code(' unsigned int count)${end_of_decl}') 36310458Sandreas.hansson@arm.com 36410458Sandreas.hansson@arm.com if not is_header: 36510458Sandreas.hansson@arm.com code('{') 36610458Sandreas.hansson@arm.com code.indent() 36710458Sandreas.hansson@arm.com code('bool ret = true;') 36810458Sandreas.hansson@arm.com code() 36910458Sandreas.hansson@arm.com code('if (false)') 37010458Sandreas.hansson@arm.com code(' ;') 37110458Sandreas.hansson@arm.com for port in simobj._ports.values(): 37210458Sandreas.hansson@arm.com code('else if (name == "${{port.name}}")') 37310458Sandreas.hansson@arm.com code(' this->port_${{port.name}}_connection_count = count;') 37410458Sandreas.hansson@arm.com code('else') 37510458Sandreas.hansson@arm.com code(' ret = false;') 37610458Sandreas.hansson@arm.com code() 37710458Sandreas.hansson@arm.com code('return ret;') 37810458Sandreas.hansson@arm.com code.dedent() 37910458Sandreas.hansson@arm.com code('}') 38010458Sandreas.hansson@arm.com 38110458Sandreas.hansson@arm.com code() 38210458Sandreas.hansson@arm.com code('SimObject *${member_prefix}simObjectCreate()${end_of_decl}') 38310458Sandreas.hansson@arm.com 38410458Sandreas.hansson@arm.com if not is_header: 38510458Sandreas.hansson@arm.com code('{') 38610458Sandreas.hansson@arm.com if hasattr(simobj, 'abstract') and simobj.abstract: 38710458Sandreas.hansson@arm.com code(' return NULL;') 38810458Sandreas.hansson@arm.com else: 38910458Sandreas.hansson@arm.com code(' return this->create();') 39010458Sandreas.hansson@arm.com code('}') 39110458Sandreas.hansson@arm.com 39210458Sandreas.hansson@arm.com if is_header: 39310458Sandreas.hansson@arm.com code() 39410458Sandreas.hansson@arm.com code('static CxxConfigDirectoryEntry' 39510458Sandreas.hansson@arm.com ' *${member_prefix}makeDirectoryEntry()') 39610458Sandreas.hansson@arm.com code('{ return new DirectoryEntry; }') 39710458Sandreas.hansson@arm.com 39810458Sandreas.hansson@arm.com if is_header: 39910458Sandreas.hansson@arm.com code.dedent() 40010458Sandreas.hansson@arm.com code('};') 40110458Sandreas.hansson@arm.com 4022740SN/A# The metaclass for SimObject. This class controls how new classes 4032740SN/A# that derive from SimObject are instantiated, and provides inherited 4042740SN/A# class behavior (just like a class controls how instances of that 4052740SN/A# class are instantiated, and provides inherited instance behavior). 4061692SN/Aclass MetaSimObject(type): 4071427SN/A # Attributes that can be set only at initialization time 40811988Sandreas.sandberg@arm.com init_keywords = { 40911988Sandreas.sandberg@arm.com 'abstract' : bool, 41011988Sandreas.sandberg@arm.com 'cxx_class' : str, 41111988Sandreas.sandberg@arm.com 'cxx_type' : str, 41211988Sandreas.sandberg@arm.com 'cxx_header' : str, 41311988Sandreas.sandberg@arm.com 'type' : str, 41412770Sgabeblack@google.com 'cxx_base' : (str, type(None)), 41512742Sgabeblack@google.com 'cxx_extra_bases' : list, 41611988Sandreas.sandberg@arm.com 'cxx_exports' : list, 41711988Sandreas.sandberg@arm.com 'cxx_param_exports' : list, 41811988Sandreas.sandberg@arm.com } 4191427SN/A # Attributes that can be set any time 4207493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 421679SN/A 422679SN/A # __new__ is called before __init__, and is where the statements 423679SN/A # in the body of the class definition get loaded into the class's 4242740SN/A # __dict__. We intercept this to filter out parameter & port assignments 425679SN/A # and only allow "private" attributes to be passed to the base 426679SN/A # __new__ (starting with underscore). 4271310SN/A def __new__(mcls, name, bases, dict): 4286654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 4294762Snate@binkert.org 4302740SN/A # Copy "private" attributes, functions, and classes to the 4312740SN/A # official dict. Everything else goes in _init_dict to be 4322740SN/A # filtered in __init__. 4332740SN/A cls_dict = {} 4342740SN/A value_dict = {} 43511988Sandreas.sandberg@arm.com cxx_exports = [] 4362740SN/A for key,val in dict.items(): 43711988Sandreas.sandberg@arm.com try: 43811988Sandreas.sandberg@arm.com cxx_exports.append(getattr(val, "__pybind")) 43911988Sandreas.sandberg@arm.com except AttributeError: 44011988Sandreas.sandberg@arm.com pass 44111988Sandreas.sandberg@arm.com 4427673Snate@binkert.org if public_value(key, val): 4432740SN/A cls_dict[key] = val 4442740SN/A else: 4452740SN/A # must be a param/port setting 4462740SN/A value_dict[key] = val 4474762Snate@binkert.org if 'abstract' not in value_dict: 4484762Snate@binkert.org value_dict['abstract'] = False 44912742Sgabeblack@google.com if 'cxx_extra_bases' not in value_dict: 45012742Sgabeblack@google.com value_dict['cxx_extra_bases'] = [] 45111988Sandreas.sandberg@arm.com if 'cxx_exports' not in value_dict: 45211988Sandreas.sandberg@arm.com value_dict['cxx_exports'] = cxx_exports 45311988Sandreas.sandberg@arm.com else: 45411988Sandreas.sandberg@arm.com value_dict['cxx_exports'] += cxx_exports 45511988Sandreas.sandberg@arm.com if 'cxx_param_exports' not in value_dict: 45611988Sandreas.sandberg@arm.com value_dict['cxx_param_exports'] = [] 4572740SN/A cls_dict['_value_dict'] = value_dict 4584762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 4594762Snate@binkert.org if 'type' in value_dict: 4604762Snate@binkert.org allClasses[name] = cls 4614762Snate@binkert.org return cls 462679SN/A 4632711SN/A # subclass initialization 464679SN/A def __init__(cls, name, bases, dict): 4652711SN/A # calls type.__init__()... I think that's a no-op, but leave 4662711SN/A # it here just in case it's not. 4671692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 4681310SN/A 4691427SN/A # initialize required attributes 4702740SN/A 4712740SN/A # class-only attributes 4722740SN/A cls._params = multidict() # param descriptions 4732740SN/A cls._ports = multidict() # port descriptions 4742740SN/A 4752740SN/A # class or instance attributes 4762740SN/A cls._values = multidict() # param values 47710267SGeoffrey.Blake@arm.com cls._hr_values = multidict() # human readable param values 4787528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 4793105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 4802740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 4811310SN/A 4829100SBrad.Beckmann@amd.com # We don't support multiple inheritance of sim objects. If you want 4839100SBrad.Beckmann@amd.com # to, you must fix multidict to deal with it properly. Non sim-objects 4849100SBrad.Beckmann@amd.com # are ok, though 4859100SBrad.Beckmann@amd.com bTotal = 0 4869100SBrad.Beckmann@amd.com for c in bases: 4879100SBrad.Beckmann@amd.com if isinstance(c, MetaSimObject): 4889100SBrad.Beckmann@amd.com bTotal += 1 4899100SBrad.Beckmann@amd.com if bTotal > 1: 49013663Sandreas.sandberg@arm.com raise TypeError( 49113663Sandreas.sandberg@arm.com "SimObjects do not support multiple inheritance") 4921692SN/A 4931692SN/A base = bases[0] 4941692SN/A 4952740SN/A # Set up general inheritance via multidicts. A subclass will 4962740SN/A # inherit all its settings from the base class. The only time 4972740SN/A # the following is not true is when we define the SimObject 4982740SN/A # class itself (in which case the multidicts have no parent). 4991692SN/A if isinstance(base, MetaSimObject): 5005610Snate@binkert.org cls._base = base 5011692SN/A cls._params.parent = base._params 5022740SN/A cls._ports.parent = base._ports 5031692SN/A cls._values.parent = base._values 50410267SGeoffrey.Blake@arm.com cls._hr_values.parent = base._hr_values 5057528Ssteve.reinhardt@amd.com cls._children.parent = base._children 5063105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 5072740SN/A # mark base as having been subclassed 5082712SN/A base._instantiated = True 5095610Snate@binkert.org else: 5105610Snate@binkert.org cls._base = None 5111692SN/A 5124762Snate@binkert.org # default keyword values 5134762Snate@binkert.org if 'type' in cls._value_dict: 5144762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 5155610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 5164762Snate@binkert.org 5175610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 5184859Snate@binkert.org 5199338SAndreas.Sandberg@arm.com if 'cxx_header' not in cls._value_dict: 5209338SAndreas.Sandberg@arm.com global noCxxHeader 5219338SAndreas.Sandberg@arm.com noCxxHeader = True 5229528Ssascha.bischoff@arm.com warn("No header file specified for SimObject: %s", name) 5239338SAndreas.Sandberg@arm.com 5242740SN/A # Now process the _value_dict items. They could be defining 5252740SN/A # new (or overriding existing) parameters or ports, setting 5262740SN/A # class keywords (e.g., 'abstract'), or setting parameter 5272740SN/A # values or port bindings. The first 3 can only be set when 5282740SN/A # the class is defined, so we handle them here. The others 5292740SN/A # can be set later too, so just emulate that by calling 5302740SN/A # setattr(). 5312740SN/A for key,val in cls._value_dict.items(): 5321527SN/A # param descriptions 5332740SN/A if isinstance(val, ParamDesc): 5341585SN/A cls._new_param(key, val) 5351427SN/A 5362738SN/A # port objects 5372738SN/A elif isinstance(val, Port): 5383105Sstever@eecs.umich.edu cls._new_port(key, val) 5392738SN/A 5401427SN/A # init-time-only keywords 54113675Sandreas.sandberg@arm.com elif key in cls.init_keywords: 5421427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 5431427SN/A 5441427SN/A # default: use normal path (ends up in __setattr__) 5451427SN/A else: 5461427SN/A setattr(cls, key, val) 5471427SN/A 5481427SN/A def _set_keyword(cls, keyword, val, kwtype): 5491427SN/A if not isinstance(val, kwtype): 55013663Sandreas.sandberg@arm.com raise TypeError('keyword %s has bad type %s (expecting %s)' % \ 55113663Sandreas.sandberg@arm.com (keyword, type(val), kwtype)) 5527493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 5531427SN/A val = classmethod(val) 5541427SN/A type.__setattr__(cls, keyword, val) 5551427SN/A 5563100SN/A def _new_param(cls, name, pdesc): 5573100SN/A # each param desc should be uniquely assigned to one variable 5583100SN/A assert(not hasattr(pdesc, 'name')) 5593100SN/A pdesc.name = name 5603100SN/A cls._params[name] = pdesc 5613100SN/A if hasattr(pdesc, 'default'): 5623105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 5633105Sstever@eecs.umich.edu 5643105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 5653105Sstever@eecs.umich.edu assert(param.name == name) 5663105Sstever@eecs.umich.edu try: 56710267SGeoffrey.Blake@arm.com hr_value = value 5688321Ssteve.reinhardt@amd.com value = param.convert(value) 56913663Sandreas.sandberg@arm.com except Exception as e: 5703105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 5713105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 5723105Sstever@eecs.umich.edu e.args = (msg, ) 5733105Sstever@eecs.umich.edu raise 5748321Ssteve.reinhardt@amd.com cls._values[name] = value 5758321Ssteve.reinhardt@amd.com # if param value is a SimObject, make it a child too, so that 5768321Ssteve.reinhardt@amd.com # it gets cloned properly when the class is instantiated 5778321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 5788321Ssteve.reinhardt@amd.com cls._add_cls_child(name, value) 57910267SGeoffrey.Blake@arm.com # update human-readable values of the param if it has a literal 58010267SGeoffrey.Blake@arm.com # value and is not an object or proxy. 58110267SGeoffrey.Blake@arm.com if not (isSimObjectOrVector(value) or\ 58210267SGeoffrey.Blake@arm.com isinstance(value, m5.proxy.BaseProxy)): 58310267SGeoffrey.Blake@arm.com cls._hr_values[name] = hr_value 5848321Ssteve.reinhardt@amd.com 5858321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 5868321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 5878321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 5888321Ssteve.reinhardt@amd.com # clears the parent pointer), and this makes it clear that the 5898321Ssteve.reinhardt@amd.com # object is not an orphan and can provide better error 5908321Ssteve.reinhardt@amd.com # messages. 5918321Ssteve.reinhardt@amd.com child.set_parent(cls, name) 59212199Sgabeblack@google.com if not isNullPointer(child): 59312199Sgabeblack@google.com cls._children[name] = child 5943105Sstever@eecs.umich.edu 5953105Sstever@eecs.umich.edu def _new_port(cls, name, port): 5963105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 5973105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 5983105Sstever@eecs.umich.edu port.name = name 5993105Sstever@eecs.umich.edu cls._ports[name] = port 6003105Sstever@eecs.umich.edu 6013105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 6023105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 6033105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 6043105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 6053105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 6063105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 6073105Sstever@eecs.umich.edu if not ref: 6083105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 6093105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 6103105Sstever@eecs.umich.edu return ref 6111585SN/A 6121310SN/A # Set attribute (called on foo.attr = value when foo is an 6131310SN/A # instance of class cls). 6141310SN/A def __setattr__(cls, attr, value): 6151310SN/A # normal processing for private attributes 6167673Snate@binkert.org if public_value(attr, value): 6171310SN/A type.__setattr__(cls, attr, value) 6181310SN/A return 6191310SN/A 62013675Sandreas.sandberg@arm.com if attr in cls.keywords: 6211427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 6221310SN/A return 6231310SN/A 62413675Sandreas.sandberg@arm.com if attr in cls._ports: 6253105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 6262738SN/A return 6272738SN/A 6282740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 62913663Sandreas.sandberg@arm.com raise RuntimeError( 6302740SN/A "cannot set SimObject parameter '%s' after\n" \ 6312740SN/A " class %s has been instantiated or subclassed" \ 63213663Sandreas.sandberg@arm.com % (attr, cls.__name__)) 6332740SN/A 6342740SN/A # check for param 6353105Sstever@eecs.umich.edu param = cls._params.get(attr) 6361310SN/A if param: 6373105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 6383105Sstever@eecs.umich.edu return 6393105Sstever@eecs.umich.edu 6403105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 6413105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 6428321Ssteve.reinhardt@amd.com cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 6433105Sstever@eecs.umich.edu return 6443105Sstever@eecs.umich.edu 6453105Sstever@eecs.umich.edu # no valid assignment... raise exception 64613663Sandreas.sandberg@arm.com raise AttributeError( 64713663Sandreas.sandberg@arm.com "Class %s has no parameter \'%s\'" % (cls.__name__, attr)) 6481310SN/A 6491585SN/A def __getattr__(cls, attr): 6507675Snate@binkert.org if attr == 'cxx_class_path': 6517675Snate@binkert.org return cls.cxx_class.split('::') 6527675Snate@binkert.org 6537675Snate@binkert.org if attr == 'cxx_class_name': 6547675Snate@binkert.org return cls.cxx_class_path[-1] 6557675Snate@binkert.org 6567675Snate@binkert.org if attr == 'cxx_namespaces': 6577675Snate@binkert.org return cls.cxx_class_path[:-1] 6587675Snate@binkert.org 65913675Sandreas.sandberg@arm.com if attr in cls._values: 6601692SN/A return cls._values[attr] 6611585SN/A 66213675Sandreas.sandberg@arm.com if attr in cls._children: 6637528Ssteve.reinhardt@amd.com return cls._children[attr] 6647528Ssteve.reinhardt@amd.com 66513663Sandreas.sandberg@arm.com raise AttributeError( 66613663Sandreas.sandberg@arm.com "object '%s' has no attribute '%s'" % (cls.__name__, attr)) 6671585SN/A 6683100SN/A def __str__(cls): 6693100SN/A return cls.__name__ 6703100SN/A 6718596Ssteve.reinhardt@amd.com # See ParamValue.cxx_predecls for description. 6728596Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 6738596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 6748596Ssteve.reinhardt@amd.com 67511988Sandreas.sandberg@arm.com def pybind_predecls(cls, code): 67611988Sandreas.sandberg@arm.com code('#include "${{cls.cxx_header}}"') 67711988Sandreas.sandberg@arm.com 67811988Sandreas.sandberg@arm.com def pybind_decl(cls, code): 67911988Sandreas.sandberg@arm.com class_path = cls.cxx_class.split('::') 68011988Sandreas.sandberg@arm.com namespaces, classname = class_path[:-1], class_path[-1] 68111988Sandreas.sandberg@arm.com py_class_name = '_COLONS_'.join(class_path) if namespaces else \ 68211988Sandreas.sandberg@arm.com classname; 68311988Sandreas.sandberg@arm.com 68411988Sandreas.sandberg@arm.com # The 'local' attribute restricts us to the params declared in 68511988Sandreas.sandberg@arm.com # the object itself, not including inherited params (which 68611988Sandreas.sandberg@arm.com # will also be inherited from the base class's param struct 68711988Sandreas.sandberg@arm.com # here). Sort the params based on their key 68813683Sandreas.sandberg@arm.com params = map(lambda k_v: k_v[1], sorted(cls._params.local.items())) 68911988Sandreas.sandberg@arm.com ports = cls._ports.local 69011988Sandreas.sandberg@arm.com 69111988Sandreas.sandberg@arm.com code('''#include "pybind11/pybind11.h" 69211988Sandreas.sandberg@arm.com#include "pybind11/stl.h" 69311988Sandreas.sandberg@arm.com 69411988Sandreas.sandberg@arm.com#include "params/$cls.hh" 69512035Sandreas.sandberg@arm.com#include "python/pybind11/core.hh" 69611988Sandreas.sandberg@arm.com#include "sim/init.hh" 69712023Sbrandon.potter@amd.com#include "sim/sim_object.hh" 69812023Sbrandon.potter@amd.com 69911988Sandreas.sandberg@arm.com#include "${{cls.cxx_header}}" 70011988Sandreas.sandberg@arm.com 70111988Sandreas.sandberg@arm.com''') 70211988Sandreas.sandberg@arm.com 70311988Sandreas.sandberg@arm.com for param in params: 70411988Sandreas.sandberg@arm.com param.pybind_predecls(code) 70511988Sandreas.sandberg@arm.com 70611988Sandreas.sandberg@arm.com code('''namespace py = pybind11; 70711988Sandreas.sandberg@arm.com 70811988Sandreas.sandberg@arm.comstatic void 70911988Sandreas.sandberg@arm.commodule_init(py::module &m_internal) 71011988Sandreas.sandberg@arm.com{ 71111988Sandreas.sandberg@arm.com py::module m = m_internal.def_submodule("param_${cls}"); 71211988Sandreas.sandberg@arm.com''') 71311988Sandreas.sandberg@arm.com code.indent() 71411988Sandreas.sandberg@arm.com if cls._base: 71512036Sandreas.sandberg@arm.com code('py::class_<${cls}Params, ${{cls._base.type}}Params, ' \ 71612036Sandreas.sandberg@arm.com 'std::unique_ptr<${{cls}}Params, py::nodelete>>(' \ 71712036Sandreas.sandberg@arm.com 'm, "${cls}Params")') 71811988Sandreas.sandberg@arm.com else: 71912036Sandreas.sandberg@arm.com code('py::class_<${cls}Params, ' \ 72012036Sandreas.sandberg@arm.com 'std::unique_ptr<${cls}Params, py::nodelete>>(' \ 72112036Sandreas.sandberg@arm.com 'm, "${cls}Params")') 72211988Sandreas.sandberg@arm.com 72311988Sandreas.sandberg@arm.com code.indent() 72411988Sandreas.sandberg@arm.com if not hasattr(cls, 'abstract') or not cls.abstract: 72511988Sandreas.sandberg@arm.com code('.def(py::init<>())') 72611988Sandreas.sandberg@arm.com code('.def("create", &${cls}Params::create)') 72711988Sandreas.sandberg@arm.com 72811988Sandreas.sandberg@arm.com param_exports = cls.cxx_param_exports + [ 72911988Sandreas.sandberg@arm.com PyBindProperty(k) 73011988Sandreas.sandberg@arm.com for k, v in sorted(cls._params.local.items()) 73111988Sandreas.sandberg@arm.com ] + [ 73211988Sandreas.sandberg@arm.com PyBindProperty("port_%s_connection_count" % port.name) 73313709Sandreas.sandberg@arm.com for port in ports.values() 73411988Sandreas.sandberg@arm.com ] 73511988Sandreas.sandberg@arm.com for exp in param_exports: 73611988Sandreas.sandberg@arm.com exp.export(code, "%sParams" % cls) 73711988Sandreas.sandberg@arm.com 73811988Sandreas.sandberg@arm.com code(';') 73911988Sandreas.sandberg@arm.com code() 74011988Sandreas.sandberg@arm.com code.dedent() 74111988Sandreas.sandberg@arm.com 74212770Sgabeblack@google.com bases = [] 74312770Sgabeblack@google.com if 'cxx_base' in cls._value_dict: 74412770Sgabeblack@google.com # If the c++ base class implied by python inheritance was 74512770Sgabeblack@google.com # overridden, use that value. 74612770Sgabeblack@google.com if cls.cxx_base: 74712770Sgabeblack@google.com bases.append(cls.cxx_base) 74812770Sgabeblack@google.com elif cls._base: 74912770Sgabeblack@google.com # If not and if there was a SimObject base, use its c++ class 75012770Sgabeblack@google.com # as this class' base. 75112770Sgabeblack@google.com bases.append(cls._base.cxx_class) 75212770Sgabeblack@google.com # Add in any extra bases that were requested. 75312770Sgabeblack@google.com bases.extend(cls.cxx_extra_bases) 75412770Sgabeblack@google.com 75511988Sandreas.sandberg@arm.com if bases: 75611988Sandreas.sandberg@arm.com base_str = ", ".join(bases) 75712036Sandreas.sandberg@arm.com code('py::class_<${{cls.cxx_class}}, ${base_str}, ' \ 75812036Sandreas.sandberg@arm.com 'std::unique_ptr<${{cls.cxx_class}}, py::nodelete>>(' \ 75912036Sandreas.sandberg@arm.com 'm, "${py_class_name}")') 76011988Sandreas.sandberg@arm.com else: 76112036Sandreas.sandberg@arm.com code('py::class_<${{cls.cxx_class}}, ' \ 76212036Sandreas.sandberg@arm.com 'std::unique_ptr<${{cls.cxx_class}}, py::nodelete>>(' \ 76312036Sandreas.sandberg@arm.com 'm, "${py_class_name}")') 76411988Sandreas.sandberg@arm.com code.indent() 76511988Sandreas.sandberg@arm.com for exp in cls.cxx_exports: 76611988Sandreas.sandberg@arm.com exp.export(code, cls.cxx_class) 76711988Sandreas.sandberg@arm.com code(';') 76811988Sandreas.sandberg@arm.com code.dedent() 76911988Sandreas.sandberg@arm.com code() 77011988Sandreas.sandberg@arm.com code.dedent() 77111988Sandreas.sandberg@arm.com code('}') 77211988Sandreas.sandberg@arm.com code() 77311988Sandreas.sandberg@arm.com code('static EmbeddedPyBind embed_obj("${0}", module_init, "${1}");', 77411988Sandreas.sandberg@arm.com cls, cls._base.type if cls._base else "") 77511988Sandreas.sandberg@arm.com 7768596Ssteve.reinhardt@amd.com 7778596Ssteve.reinhardt@amd.com # Generate the C++ declaration (.hh file) for this SimObject's 7788596Ssteve.reinhardt@amd.com # param struct. Called from src/SConscript. 7798596Ssteve.reinhardt@amd.com def cxx_param_decl(cls, code): 7808596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 7813100SN/A # the object itself, not including inherited params (which 7823100SN/A # will also be inherited from the base class's param struct 78310584Sandreas.hansson@arm.com # here). Sort the params based on their key 78413683Sandreas.sandberg@arm.com params = map(lambda k_v: k_v[1], sorted(cls._params.local.items())) 7858840Sandreas.hansson@arm.com ports = cls._ports.local 7863100SN/A try: 7873100SN/A ptypes = [p.ptype for p in params] 7883100SN/A except: 78912563Sgabeblack@google.com print(cls, p, p.ptype_str) 79012563Sgabeblack@google.com print(params) 7913100SN/A raise 7923100SN/A 7937675Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 7947675Snate@binkert.org 7957675Snate@binkert.org code('''\ 7967675Snate@binkert.org#ifndef __PARAMS__${cls}__ 7977675Snate@binkert.org#define __PARAMS__${cls}__ 7987675Snate@binkert.org 7997675Snate@binkert.org''') 8007675Snate@binkert.org 80111988Sandreas.sandberg@arm.com 80211988Sandreas.sandberg@arm.com # The base SimObject has a couple of params that get 80311988Sandreas.sandberg@arm.com # automatically set from Python without being declared through 80411988Sandreas.sandberg@arm.com # the normal Param mechanism; we slip them in here (needed 80511988Sandreas.sandberg@arm.com # predecls now, actual declarations below) 80611988Sandreas.sandberg@arm.com if cls == SimObject: 80711988Sandreas.sandberg@arm.com code('''#include <string>''') 80811988Sandreas.sandberg@arm.com 8097675Snate@binkert.org # A forward class declaration is sufficient since we are just 8107675Snate@binkert.org # declaring a pointer. 8117675Snate@binkert.org for ns in class_path[:-1]: 8127675Snate@binkert.org code('namespace $ns {') 8137675Snate@binkert.org code('class $0;', class_path[-1]) 8147675Snate@binkert.org for ns in reversed(class_path[:-1]): 8157811Ssteve.reinhardt@amd.com code('} // namespace $ns') 8167675Snate@binkert.org code() 8177675Snate@binkert.org 8187673Snate@binkert.org for param in params: 8197673Snate@binkert.org param.cxx_predecls(code) 82013709Sandreas.sandberg@arm.com for port in ports.values(): 8218840Sandreas.hansson@arm.com port.cxx_predecls(code) 8227673Snate@binkert.org code() 8234762Snate@binkert.org 8245610Snate@binkert.org if cls._base: 8257673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 8267673Snate@binkert.org code() 8274762Snate@binkert.org 8284762Snate@binkert.org for ptype in ptypes: 8294762Snate@binkert.org if issubclass(ptype, Enum): 8307673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 8317673Snate@binkert.org code() 8324762Snate@binkert.org 8338596Ssteve.reinhardt@amd.com # now generate the actual param struct 8348597Ssteve.reinhardt@amd.com code("struct ${cls}Params") 8358597Ssteve.reinhardt@amd.com if cls._base: 8368597Ssteve.reinhardt@amd.com code(" : public ${{cls._base.type}}Params") 8378597Ssteve.reinhardt@amd.com code("{") 8388597Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 8398597Ssteve.reinhardt@amd.com if 'type' in cls.__dict__: 8408597Ssteve.reinhardt@amd.com code(" ${{cls.cxx_type}} create();") 8418597Ssteve.reinhardt@amd.com 8428597Ssteve.reinhardt@amd.com code.indent() 8438596Ssteve.reinhardt@amd.com if cls == SimObject: 8448597Ssteve.reinhardt@amd.com code(''' 8459983Sstever@gmail.com SimObjectParams() {} 8468597Ssteve.reinhardt@amd.com virtual ~SimObjectParams() {} 8478596Ssteve.reinhardt@amd.com 8488597Ssteve.reinhardt@amd.com std::string name; 8498597Ssteve.reinhardt@amd.com ''') 85011988Sandreas.sandberg@arm.com 8518597Ssteve.reinhardt@amd.com for param in params: 8528597Ssteve.reinhardt@amd.com param.cxx_decl(code) 85313709Sandreas.sandberg@arm.com for port in ports.values(): 8548840Sandreas.hansson@arm.com port.cxx_decl(code) 8558840Sandreas.hansson@arm.com 8568597Ssteve.reinhardt@amd.com code.dedent() 8578597Ssteve.reinhardt@amd.com code('};') 8585488Snate@binkert.org 8597673Snate@binkert.org code() 8607673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 8615488Snate@binkert.org return code 8625488Snate@binkert.org 86310458Sandreas.hansson@arm.com # Generate the C++ declaration/definition files for this SimObject's 86410458Sandreas.hansson@arm.com # param struct to allow C++ initialisation 86510458Sandreas.hansson@arm.com def cxx_config_param_file(cls, code, is_header): 86610458Sandreas.hansson@arm.com createCxxConfigDirectoryEntryFile(code, cls.__name__, cls, is_header) 86710458Sandreas.hansson@arm.com return code 8685488Snate@binkert.org 8699983Sstever@gmail.com# This *temporary* definition is required to support calls from the 8709983Sstever@gmail.com# SimObject class definition to the MetaSimObject methods (in 8719983Sstever@gmail.com# particular _set_param, which gets called for parameters with default 8729983Sstever@gmail.com# values defined on the SimObject class itself). It will get 8739983Sstever@gmail.com# overridden by the permanent definition (which requires that 8749983Sstever@gmail.com# SimObject be defined) lower in this file. 8759983Sstever@gmail.comdef isSimObjectOrVector(value): 8769983Sstever@gmail.com return False 8773100SN/A 87811988Sandreas.sandberg@arm.comdef cxxMethod(*args, **kwargs): 87911988Sandreas.sandberg@arm.com """Decorator to export C++ functions to Python""" 88011988Sandreas.sandberg@arm.com 88111988Sandreas.sandberg@arm.com def decorate(func): 88213698Sandreas.sandberg@arm.com name = func.__name__ 88311988Sandreas.sandberg@arm.com override = kwargs.get("override", False) 88411988Sandreas.sandberg@arm.com cxx_name = kwargs.get("cxx_name", name) 88511988Sandreas.sandberg@arm.com 88611988Sandreas.sandberg@arm.com args, varargs, keywords, defaults = inspect.getargspec(func) 88711988Sandreas.sandberg@arm.com if varargs or keywords: 88811988Sandreas.sandberg@arm.com raise ValueError("Wrapped methods must not contain variable " \ 88911988Sandreas.sandberg@arm.com "arguments") 89011988Sandreas.sandberg@arm.com 89111988Sandreas.sandberg@arm.com # Create tuples of (argument, default) 89211988Sandreas.sandberg@arm.com if defaults: 89313709Sandreas.sandberg@arm.com args = args[:-len(defaults)] + \ 89413709Sandreas.sandberg@arm.com list(zip(args[-len(defaults):], defaults)) 89511988Sandreas.sandberg@arm.com # Don't include self in the argument list to PyBind 89611988Sandreas.sandberg@arm.com args = args[1:] 89711988Sandreas.sandberg@arm.com 89811988Sandreas.sandberg@arm.com 89911988Sandreas.sandberg@arm.com @wraps(func) 90011988Sandreas.sandberg@arm.com def cxx_call(self, *args, **kwargs): 90111988Sandreas.sandberg@arm.com ccobj = self.getCCObject() 90211988Sandreas.sandberg@arm.com return getattr(ccobj, name)(*args, **kwargs) 90311988Sandreas.sandberg@arm.com 90411988Sandreas.sandberg@arm.com @wraps(func) 90511988Sandreas.sandberg@arm.com def py_call(self, *args, **kwargs): 90612805Sandreas.sandberg@arm.com return func(self, *args, **kwargs) 90711988Sandreas.sandberg@arm.com 90811988Sandreas.sandberg@arm.com f = py_call if override else cxx_call 90911988Sandreas.sandberg@arm.com f.__pybind = PyBindMethod(name, cxx_name=cxx_name, args=args) 91011988Sandreas.sandberg@arm.com 91111988Sandreas.sandberg@arm.com return f 91211988Sandreas.sandberg@arm.com 91311988Sandreas.sandberg@arm.com if len(args) == 0: 91411988Sandreas.sandberg@arm.com return decorate 91511988Sandreas.sandberg@arm.com elif len(args) == 1 and len(kwargs) == 0: 91611988Sandreas.sandberg@arm.com return decorate(*args) 91711988Sandreas.sandberg@arm.com else: 91811988Sandreas.sandberg@arm.com raise TypeError("One argument and no kwargs, or only kwargs expected") 91911988Sandreas.sandberg@arm.com 92010267SGeoffrey.Blake@arm.com# This class holds information about each simobject parameter 92110267SGeoffrey.Blake@arm.com# that should be displayed on the command line for use in the 92210267SGeoffrey.Blake@arm.com# configuration system. 92310267SGeoffrey.Blake@arm.comclass ParamInfo(object): 92410267SGeoffrey.Blake@arm.com def __init__(self, type, desc, type_str, example, default_val, access_str): 92510267SGeoffrey.Blake@arm.com self.type = type 92610267SGeoffrey.Blake@arm.com self.desc = desc 92710267SGeoffrey.Blake@arm.com self.type_str = type_str 92810267SGeoffrey.Blake@arm.com self.example_str = example 92910267SGeoffrey.Blake@arm.com self.default_val = default_val 93010267SGeoffrey.Blake@arm.com # The string representation used to access this param through python. 93110267SGeoffrey.Blake@arm.com # The method to access this parameter presented on the command line may 93210267SGeoffrey.Blake@arm.com # be different, so this needs to be stored for later use. 93310267SGeoffrey.Blake@arm.com self.access_str = access_str 93410267SGeoffrey.Blake@arm.com self.created = True 93510267SGeoffrey.Blake@arm.com 93610267SGeoffrey.Blake@arm.com # Make it so we can only set attributes at initialization time 93710267SGeoffrey.Blake@arm.com # and effectively make this a const object. 93810267SGeoffrey.Blake@arm.com def __setattr__(self, name, value): 93910267SGeoffrey.Blake@arm.com if not "created" in self.__dict__: 94010267SGeoffrey.Blake@arm.com self.__dict__[name] = value 94110267SGeoffrey.Blake@arm.com 94213356Sciro.santilli@arm.comclass SimObjectCliWrapperException(Exception): 94313356Sciro.santilli@arm.com def __init__(self, message): 94413356Sciro.santilli@arm.com super(Exception, self).__init__(message) 94513356Sciro.santilli@arm.com 94613356Sciro.santilli@arm.comclass SimObjectCliWrapper(object): 94713356Sciro.santilli@arm.com """ 94813356Sciro.santilli@arm.com Wrapper class to restrict operations that may be done 94913356Sciro.santilli@arm.com from the command line on SimObjects. 95013356Sciro.santilli@arm.com 95113356Sciro.santilli@arm.com Only parameters may be set, and only children may be accessed. 95213356Sciro.santilli@arm.com 95313356Sciro.santilli@arm.com Slicing allows for multiple simultaneous assignment of items in 95413356Sciro.santilli@arm.com one statement. 95513356Sciro.santilli@arm.com """ 95613356Sciro.santilli@arm.com 95713356Sciro.santilli@arm.com def __init__(self, sim_objects): 95813356Sciro.santilli@arm.com self.__dict__['_sim_objects'] = list(sim_objects) 95913356Sciro.santilli@arm.com 96013356Sciro.santilli@arm.com def __getattr__(self, key): 96113356Sciro.santilli@arm.com return SimObjectCliWrapper(sim_object._children[key] 96213356Sciro.santilli@arm.com for sim_object in self._sim_objects) 96313356Sciro.santilli@arm.com 96413356Sciro.santilli@arm.com def __setattr__(self, key, val): 96513356Sciro.santilli@arm.com for sim_object in self._sim_objects: 96613356Sciro.santilli@arm.com if key in sim_object._params: 96713356Sciro.santilli@arm.com if sim_object._params[key].isCmdLineSettable(): 96813356Sciro.santilli@arm.com setattr(sim_object, key, val) 96913356Sciro.santilli@arm.com else: 97013356Sciro.santilli@arm.com raise SimObjectCliWrapperException( 97113356Sciro.santilli@arm.com 'tried to set or unsettable' \ 97213356Sciro.santilli@arm.com 'object parameter: ' + key) 97313356Sciro.santilli@arm.com else: 97413356Sciro.santilli@arm.com raise SimObjectCliWrapperException( 97513356Sciro.santilli@arm.com 'tried to set or access non-existent' \ 97613356Sciro.santilli@arm.com 'object parameter: ' + key) 97713356Sciro.santilli@arm.com 97813356Sciro.santilli@arm.com def __getitem__(self, idx): 97913356Sciro.santilli@arm.com """ 98013356Sciro.santilli@arm.com Extends the list() semantics to also allow tuples, 98113356Sciro.santilli@arm.com for example object[1, 3] selects items 1 and 3. 98213356Sciro.santilli@arm.com """ 98313356Sciro.santilli@arm.com out = [] 98413356Sciro.santilli@arm.com if isinstance(idx, tuple): 98513356Sciro.santilli@arm.com for t in idx: 98613356Sciro.santilli@arm.com out.extend(self[t]._sim_objects) 98713356Sciro.santilli@arm.com else: 98813356Sciro.santilli@arm.com if isinstance(idx, int): 98913356Sciro.santilli@arm.com _range = range(idx, idx + 1) 99013356Sciro.santilli@arm.com elif not isinstance(idx, slice): 99113356Sciro.santilli@arm.com raise SimObjectCliWrapperException( \ 99213356Sciro.santilli@arm.com 'invalid index type: ' + repr(idx)) 99313356Sciro.santilli@arm.com for sim_object in self._sim_objects: 99413356Sciro.santilli@arm.com if isinstance(idx, slice): 99513356Sciro.santilli@arm.com _range = range(*idx.indices(len(sim_object))) 99613356Sciro.santilli@arm.com out.extend(sim_object[i] for i in _range) 99713356Sciro.santilli@arm.com return SimObjectCliWrapper(out) 99813356Sciro.santilli@arm.com 9992740SN/A# The SimObject class is the root of the special hierarchy. Most of 1000679SN/A# the code in this class deals with the configuration hierarchy itself 1001679SN/A# (parent/child node relationships). 10021692SN/Aclass SimObject(object): 10031692SN/A # Specify metaclass. Any class inheriting from SimObject will 1004679SN/A # get this metaclass. 10051692SN/A __metaclass__ = MetaSimObject 10063100SN/A type = 'SimObject' 10074762Snate@binkert.org abstract = True 10089983Sstever@gmail.com 10099338SAndreas.Sandberg@arm.com cxx_header = "sim/sim_object.hh" 101012742Sgabeblack@google.com cxx_extra_bases = [ "Drainable", "Serializable" ] 10119983Sstever@gmail.com eventq_index = Param.UInt32(Parent.eventq_index, "Event Queue Index") 10129342SAndreas.Sandberg@arm.com 101311988Sandreas.sandberg@arm.com cxx_exports = [ 101411988Sandreas.sandberg@arm.com PyBindMethod("init"), 101511988Sandreas.sandberg@arm.com PyBindMethod("initState"), 101611988Sandreas.sandberg@arm.com PyBindMethod("memInvalidate"), 101711988Sandreas.sandberg@arm.com PyBindMethod("memWriteback"), 101811988Sandreas.sandberg@arm.com PyBindMethod("regStats"), 101911988Sandreas.sandberg@arm.com PyBindMethod("resetStats"), 102011988Sandreas.sandberg@arm.com PyBindMethod("regProbePoints"), 102111988Sandreas.sandberg@arm.com PyBindMethod("regProbeListeners"), 102211988Sandreas.sandberg@arm.com PyBindMethod("startup"), 102311988Sandreas.sandberg@arm.com ] 102411988Sandreas.sandberg@arm.com 102511988Sandreas.sandberg@arm.com cxx_param_exports = [ 102611988Sandreas.sandberg@arm.com PyBindProperty("name"), 102711988Sandreas.sandberg@arm.com ] 102811988Sandreas.sandberg@arm.com 102911988Sandreas.sandberg@arm.com @cxxMethod 103011988Sandreas.sandberg@arm.com def loadState(self, cp): 103111988Sandreas.sandberg@arm.com """Load SimObject state from a checkpoint""" 103211988Sandreas.sandberg@arm.com pass 103311988Sandreas.sandberg@arm.com 103410267SGeoffrey.Blake@arm.com # Returns a dict of all the option strings that can be 103510267SGeoffrey.Blake@arm.com # generated as command line options for this simobject instance 103610267SGeoffrey.Blake@arm.com # by tracing all reachable params in the top level instance and 103710267SGeoffrey.Blake@arm.com # any children it contains. 103810267SGeoffrey.Blake@arm.com def enumerateParams(self, flags_dict = {}, 103910267SGeoffrey.Blake@arm.com cmd_line_str = "", access_str = ""): 104010267SGeoffrey.Blake@arm.com if hasattr(self, "_paramEnumed"): 104112563Sgabeblack@google.com print("Cycle detected enumerating params") 104210267SGeoffrey.Blake@arm.com else: 104310267SGeoffrey.Blake@arm.com self._paramEnumed = True 104410267SGeoffrey.Blake@arm.com # Scan the children first to pick up all the objects in this SimObj 104510267SGeoffrey.Blake@arm.com for keys in self._children: 104610267SGeoffrey.Blake@arm.com child = self._children[keys] 104710267SGeoffrey.Blake@arm.com next_cmdline_str = cmd_line_str + keys 104810267SGeoffrey.Blake@arm.com next_access_str = access_str + keys 104910267SGeoffrey.Blake@arm.com if not isSimObjectVector(child): 105010267SGeoffrey.Blake@arm.com next_cmdline_str = next_cmdline_str + "." 105110267SGeoffrey.Blake@arm.com next_access_str = next_access_str + "." 105210267SGeoffrey.Blake@arm.com flags_dict = child.enumerateParams(flags_dict, 105310267SGeoffrey.Blake@arm.com next_cmdline_str, 105410267SGeoffrey.Blake@arm.com next_access_str) 105510267SGeoffrey.Blake@arm.com 105610267SGeoffrey.Blake@arm.com # Go through the simple params in the simobject in this level 105710267SGeoffrey.Blake@arm.com # of the simobject hierarchy and save information about the 105810267SGeoffrey.Blake@arm.com # parameter to be used for generating and processing command line 105910267SGeoffrey.Blake@arm.com # options to the simulator to set these parameters. 106010267SGeoffrey.Blake@arm.com for keys,values in self._params.items(): 106110267SGeoffrey.Blake@arm.com if values.isCmdLineSettable(): 106210267SGeoffrey.Blake@arm.com type_str = '' 106310267SGeoffrey.Blake@arm.com ex_str = values.example_str() 106410267SGeoffrey.Blake@arm.com ptype = None 106510267SGeoffrey.Blake@arm.com if isinstance(values, VectorParamDesc): 106610267SGeoffrey.Blake@arm.com type_str = 'Vector_%s' % values.ptype_str 106710267SGeoffrey.Blake@arm.com ptype = values 106810267SGeoffrey.Blake@arm.com else: 106910267SGeoffrey.Blake@arm.com type_str = '%s' % values.ptype_str 107010267SGeoffrey.Blake@arm.com ptype = values.ptype 107110267SGeoffrey.Blake@arm.com 107210267SGeoffrey.Blake@arm.com if keys in self._hr_values\ 107310267SGeoffrey.Blake@arm.com and keys in self._values\ 107412023Sbrandon.potter@amd.com and not isinstance(self._values[keys], 107512023Sbrandon.potter@amd.com m5.proxy.BaseProxy): 107610267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 107710267SGeoffrey.Blake@arm.com acc_str = access_str + keys 107810267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 107910267SGeoffrey.Blake@arm.com self._params[keys].desc, type_str, ex_str, 108010267SGeoffrey.Blake@arm.com values.pretty_print(self._hr_values[keys]), 108110267SGeoffrey.Blake@arm.com acc_str) 108210267SGeoffrey.Blake@arm.com elif not keys in self._hr_values\ 108310267SGeoffrey.Blake@arm.com and not keys in self._values: 108410267SGeoffrey.Blake@arm.com # Empty param 108510267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 108610267SGeoffrey.Blake@arm.com acc_str = access_str + keys 108710267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 108810267SGeoffrey.Blake@arm.com self._params[keys].desc, 108910267SGeoffrey.Blake@arm.com type_str, ex_str, '', acc_str) 109010267SGeoffrey.Blake@arm.com 109110267SGeoffrey.Blake@arm.com return flags_dict 109210267SGeoffrey.Blake@arm.com 10932740SN/A # Initialize new instance. For objects with SimObject-valued 10942740SN/A # children, we need to recursively clone the classes represented 10952740SN/A # by those param values as well in a consistent "deep copy"-style 10962740SN/A # fashion. That is, we want to make sure that each instance is 10972740SN/A # cloned only once, and that if there are multiple references to 10982740SN/A # the same original object, we end up with the corresponding 10992740SN/A # cloned references all pointing to the same cloned instance. 11002740SN/A def __init__(self, **kwargs): 11012740SN/A ancestor = kwargs.get('_ancestor') 11022740SN/A memo_dict = kwargs.get('_memo') 11032740SN/A if memo_dict is None: 11042740SN/A # prepare to memoize any recursively instantiated objects 11052740SN/A memo_dict = {} 11062740SN/A elif ancestor: 11072740SN/A # memoize me now to avoid problems with recursive calls 11082740SN/A memo_dict[ancestor] = self 11092711SN/A 11102740SN/A if not ancestor: 11112740SN/A ancestor = self.__class__ 11122740SN/A ancestor._instantiated = True 11132711SN/A 11142740SN/A # initialize required attributes 11152740SN/A self._parent = None 11167528Ssteve.reinhardt@amd.com self._name = None 11172740SN/A self._ccObject = None # pointer to C++ object 11184762Snate@binkert.org self._ccParams = None 11192740SN/A self._instantiated = False # really "cloned" 11202712SN/A 11218321Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 11228321Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 11238321Ssteve.reinhardt@amd.com # Do children before parameter values so that children that 11248321Ssteve.reinhardt@amd.com # are also param values get cloned properly. 11258321Ssteve.reinhardt@amd.com self._children = {} 112613709Sandreas.sandberg@arm.com for key,val in ancestor._children.items(): 11278321Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 11288321Ssteve.reinhardt@amd.com 11292711SN/A # Inherit parameter values from class using multidict so 11307528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 11317528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 11322740SN/A self._values = multidict(ancestor._values) 113310267SGeoffrey.Blake@arm.com self._hr_values = multidict(ancestor._hr_values) 11342740SN/A # clone SimObject-valued parameters 113513709Sandreas.sandberg@arm.com for key,val in ancestor._values.items(): 11367528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 11377528Ssteve.reinhardt@amd.com if val is not None: 11387528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 11397528Ssteve.reinhardt@amd.com 11402740SN/A # clone port references. no need to use a multidict here 11412740SN/A # since we will be creating new references for all ports. 11423105Sstever@eecs.umich.edu self._port_refs = {} 114313709Sandreas.sandberg@arm.com for key,val in ancestor._port_refs.items(): 11443105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 11451692SN/A # apply attribute assignments from keyword args, if any 114613709Sandreas.sandberg@arm.com for key,val in kwargs.items(): 11471692SN/A setattr(self, key, val) 1148679SN/A 11492740SN/A # "Clone" the current instance by creating another instance of 11502740SN/A # this instance's class, but that inherits its parameter values 11512740SN/A # and port mappings from the current instance. If we're in a 11522740SN/A # "deep copy" recursive clone, check the _memo dict to see if 11532740SN/A # we've already cloned this instance. 11541692SN/A def __call__(self, **kwargs): 11552740SN/A memo_dict = kwargs.get('_memo') 11562740SN/A if memo_dict is None: 11572740SN/A # no memo_dict: must be top-level clone operation. 11582740SN/A # this is only allowed at the root of a hierarchy 11592740SN/A if self._parent: 116013663Sandreas.sandberg@arm.com raise RuntimeError("attempt to clone object %s " \ 11612740SN/A "not at the root of a tree (parent = %s)" \ 116213663Sandreas.sandberg@arm.com % (self, self._parent)) 11632740SN/A # create a new dict and use that. 11642740SN/A memo_dict = {} 11652740SN/A kwargs['_memo'] = memo_dict 116613675Sandreas.sandberg@arm.com elif self in memo_dict: 11672740SN/A # clone already done & memoized 11682740SN/A return memo_dict[self] 11692740SN/A return self.__class__(_ancestor = self, **kwargs) 11701343SN/A 11713105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 11723105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 11733105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 11743105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 11753105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 11769940SGeoffrey.Blake@arm.com if ref == None: 11773105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 11783105Sstever@eecs.umich.edu self._port_refs[attr] = ref 11793105Sstever@eecs.umich.edu return ref 11803105Sstever@eecs.umich.edu 11811692SN/A def __getattr__(self, attr): 118213675Sandreas.sandberg@arm.com if attr in self._ports: 11833105Sstever@eecs.umich.edu return self._get_port_ref(attr) 11842738SN/A 118513675Sandreas.sandberg@arm.com if attr in self._values: 11861692SN/A return self._values[attr] 11871427SN/A 118813675Sandreas.sandberg@arm.com if attr in self._children: 11897528Ssteve.reinhardt@amd.com return self._children[attr] 11907528Ssteve.reinhardt@amd.com 11917500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 11927500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 119311991Sandreas.sandberg@arm.com # methods exported to Python (e.g., init(), and startup()) 11947500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 11957500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 11967500Ssteve.reinhardt@amd.com 119710002Ssteve.reinhardt@amd.com err_string = "object '%s' has no attribute '%s'" \ 11981692SN/A % (self.__class__.__name__, attr) 11991427SN/A 120010002Ssteve.reinhardt@amd.com if not self._ccObject: 120110002Ssteve.reinhardt@amd.com err_string += "\n (C++ object is not yet constructed," \ 120210002Ssteve.reinhardt@amd.com " so wrapped C++ methods are unavailable.)" 120310002Ssteve.reinhardt@amd.com 120413663Sandreas.sandberg@arm.com raise AttributeError(err_string) 120510002Ssteve.reinhardt@amd.com 12061692SN/A # Set attribute (called on foo.attr = value when foo is an 12071692SN/A # instance of class cls). 12081692SN/A def __setattr__(self, attr, value): 12091692SN/A # normal processing for private attributes 12101692SN/A if attr.startswith('_'): 12111692SN/A object.__setattr__(self, attr, value) 12121692SN/A return 12131427SN/A 121413675Sandreas.sandberg@arm.com if attr in self._ports: 12152738SN/A # set up port connection 12163105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 12172738SN/A return 12182738SN/A 12193105Sstever@eecs.umich.edu param = self._params.get(attr) 12201692SN/A if param: 12211310SN/A try: 122210267SGeoffrey.Blake@arm.com hr_value = value 12231692SN/A value = param.convert(value) 122413663Sandreas.sandberg@arm.com except Exception as e: 12251692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 12261692SN/A (e, self.__class__.__name__, attr, value) 12271605SN/A e.args = (msg, ) 12281605SN/A raise 12297528Ssteve.reinhardt@amd.com self._values[attr] = value 12308321Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 12318321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 12328321Ssteve.reinhardt@amd.com self.add_child(attr, value) 123310267SGeoffrey.Blake@arm.com # set the human-readable value dict if this is a param 123410267SGeoffrey.Blake@arm.com # with a literal value and is not being set as an object 123510267SGeoffrey.Blake@arm.com # or proxy. 123610267SGeoffrey.Blake@arm.com if not (isSimObjectOrVector(value) or\ 123710267SGeoffrey.Blake@arm.com isinstance(value, m5.proxy.BaseProxy)): 123810267SGeoffrey.Blake@arm.com self._hr_values[attr] = hr_value 123910267SGeoffrey.Blake@arm.com 12403105Sstever@eecs.umich.edu return 12411310SN/A 12427528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 12433105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 12447528Ssteve.reinhardt@amd.com self.add_child(attr, value) 12453105Sstever@eecs.umich.edu return 12461693SN/A 12473105Sstever@eecs.umich.edu # no valid assignment... raise exception 124813663Sandreas.sandberg@arm.com raise AttributeError("Class %s has no parameter %s" \ 124913663Sandreas.sandberg@arm.com % (self.__class__.__name__, attr)) 12501310SN/A 12511310SN/A 12521692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 12531692SN/A # not be vectors, and always getting the first element (e.g. cpus) 12541692SN/A def __getitem__(self, key): 12551692SN/A if key == 0: 12561692SN/A return self 125713663Sandreas.sandberg@arm.com raise IndexError("Non-zero index '%s' to SimObject" % key) 125810267SGeoffrey.Blake@arm.com 125910267SGeoffrey.Blake@arm.com # this hack allows us to iterate over a SimObject that may 126010267SGeoffrey.Blake@arm.com # not be a vector, so we can call a loop over it and get just one 126110267SGeoffrey.Blake@arm.com # element. 126210267SGeoffrey.Blake@arm.com def __len__(self): 126310267SGeoffrey.Blake@arm.com return 1 12641310SN/A 12657528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 12667528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 12677528Ssteve.reinhardt@amd.com assert self._parent is old_parent 12687528Ssteve.reinhardt@amd.com self._parent = None 12697528Ssteve.reinhardt@amd.com 12707528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 12717528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 12727528Ssteve.reinhardt@amd.com self._parent = parent 12737528Ssteve.reinhardt@amd.com self._name = name 12747528Ssteve.reinhardt@amd.com 127512023Sbrandon.potter@amd.com # Return parent object of this SimObject, not implemented by 127612023Sbrandon.potter@amd.com # SimObjectVector because the elements in a SimObjectVector may not share 127712023Sbrandon.potter@amd.com # the same parent 12789953Sgeoffrey.blake@arm.com def get_parent(self): 12799953Sgeoffrey.blake@arm.com return self._parent 12809953Sgeoffrey.blake@arm.com 12817528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 12827528Ssteve.reinhardt@amd.com def get_name(self): 12837528Ssteve.reinhardt@amd.com return self._name 12847528Ssteve.reinhardt@amd.com 12858321Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 12868321Ssteve.reinhardt@amd.com def has_parent(self): 12878321Ssteve.reinhardt@amd.com return self._parent is not None 12887528Ssteve.reinhardt@amd.com 12897742Sgblack@eecs.umich.edu # clear out child with given name. This code is not likely to be exercised. 12907742Sgblack@eecs.umich.edu # See comment in add_child. 12911693SN/A def clear_child(self, name): 12921693SN/A child = self._children[name] 12937528Ssteve.reinhardt@amd.com child.clear_parent(self) 12941693SN/A del self._children[name] 12951693SN/A 12967528Ssteve.reinhardt@amd.com # Add a new child to this object. 12977528Ssteve.reinhardt@amd.com def add_child(self, name, child): 12987528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 12998321Ssteve.reinhardt@amd.com if child.has_parent(): 13009528Ssascha.bischoff@arm.com warn("add_child('%s'): child '%s' already has parent", name, 13019528Ssascha.bischoff@arm.com child.get_name()) 130213675Sandreas.sandberg@arm.com if name in self._children: 13037742Sgblack@eecs.umich.edu # This code path had an undiscovered bug that would make it fail 13047742Sgblack@eecs.umich.edu # at runtime. It had been here for a long time and was only 13057742Sgblack@eecs.umich.edu # exposed by a buggy script. Changes here will probably not be 13067742Sgblack@eecs.umich.edu # exercised without specialized testing. 13077738Sgblack@eecs.umich.edu self.clear_child(name) 13087528Ssteve.reinhardt@amd.com child.set_parent(self, name) 130912199Sgabeblack@google.com if not isNullPointer(child): 131012199Sgabeblack@google.com self._children[name] = child 13111310SN/A 13127528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 13137528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 13147528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 13157528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 13167528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 13177528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 131813709Sandreas.sandberg@arm.com for key,val in self._values.items(): 13197528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 13207528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 13218321Ssteve.reinhardt@amd.com # SimObjectVector class so we can call has_parent() 13227528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 13237528Ssteve.reinhardt@amd.com self._values[key] = val 13248321Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 13259528Ssascha.bischoff@arm.com warn("%s adopting orphan SimObject param '%s'", self, key) 13267528Ssteve.reinhardt@amd.com self.add_child(key, val) 13273105Sstever@eecs.umich.edu 13281692SN/A def path(self): 13292740SN/A if not self._parent: 13308321Ssteve.reinhardt@amd.com return '<orphan %s>' % self.__class__ 133111231Sandreas.sandberg@arm.com elif isinstance(self._parent, MetaSimObject): 133211231Sandreas.sandberg@arm.com return str(self.__class__) 133311231Sandreas.sandberg@arm.com 13341692SN/A ppath = self._parent.path() 13351692SN/A if ppath == 'root': 13361692SN/A return self._name 13371692SN/A return ppath + "." + self._name 13381310SN/A 13391692SN/A def __str__(self): 13401692SN/A return self.path() 13411310SN/A 134210380SAndrew.Bardsley@arm.com def config_value(self): 134310380SAndrew.Bardsley@arm.com return self.path() 134410380SAndrew.Bardsley@arm.com 13451692SN/A def ini_str(self): 13461692SN/A return self.path() 13471310SN/A 13481692SN/A def find_any(self, ptype): 13491692SN/A if isinstance(self, ptype): 13501692SN/A return self, True 13511310SN/A 13521692SN/A found_obj = None 135313709Sandreas.sandberg@arm.com for child in self._children.values(): 135410195SGeoffrey.Blake@arm.com visited = False 135510195SGeoffrey.Blake@arm.com if hasattr(child, '_visited'): 135610195SGeoffrey.Blake@arm.com visited = getattr(child, '_visited') 135710195SGeoffrey.Blake@arm.com 135810195SGeoffrey.Blake@arm.com if isinstance(child, ptype) and not visited: 13591692SN/A if found_obj != None and child != found_obj: 136013663Sandreas.sandberg@arm.com raise AttributeError( 13611692SN/A 'parent.any matched more than one: %s %s' % \ 136213663Sandreas.sandberg@arm.com (found_obj.path, child.path)) 13631692SN/A found_obj = child 13641692SN/A # search param space 136513709Sandreas.sandberg@arm.com for pname,pdesc in self._params.items(): 13661692SN/A if issubclass(pdesc.ptype, ptype): 13671692SN/A match_obj = self._values[pname] 13681692SN/A if found_obj != None and found_obj != match_obj: 136913663Sandreas.sandberg@arm.com raise AttributeError( 137012023Sbrandon.potter@amd.com 'parent.any matched more than one: %s and %s' % \ 137113663Sandreas.sandberg@arm.com (found_obj.path, match_obj.path)) 13721692SN/A found_obj = match_obj 13731692SN/A return found_obj, found_obj != None 13741692SN/A 13758459SAli.Saidi@ARM.com def find_all(self, ptype): 13768459SAli.Saidi@ARM.com all = {} 13778459SAli.Saidi@ARM.com # search children 137813709Sandreas.sandberg@arm.com for child in self._children.values(): 13799410Sandreas.hansson@arm.com # a child could be a list, so ensure we visit each item 13809410Sandreas.hansson@arm.com if isinstance(child, list): 13819410Sandreas.hansson@arm.com children = child 13829410Sandreas.hansson@arm.com else: 13839410Sandreas.hansson@arm.com children = [child] 13849410Sandreas.hansson@arm.com 13859410Sandreas.hansson@arm.com for child in children: 13869410Sandreas.hansson@arm.com if isinstance(child, ptype) and not isproxy(child) and \ 13879410Sandreas.hansson@arm.com not isNullPointer(child): 13889410Sandreas.hansson@arm.com all[child] = True 13899410Sandreas.hansson@arm.com if isSimObject(child): 13909410Sandreas.hansson@arm.com # also add results from the child itself 13919410Sandreas.hansson@arm.com child_all, done = child.find_all(ptype) 13929410Sandreas.hansson@arm.com all.update(dict(zip(child_all, [done] * len(child_all)))) 13938459SAli.Saidi@ARM.com # search param space 139413709Sandreas.sandberg@arm.com for pname,pdesc in self._params.items(): 13958459SAli.Saidi@ARM.com if issubclass(pdesc.ptype, ptype): 13968459SAli.Saidi@ARM.com match_obj = self._values[pname] 13978459SAli.Saidi@ARM.com if not isproxy(match_obj) and not isNullPointer(match_obj): 13988459SAli.Saidi@ARM.com all[match_obj] = True 139910532Sandreas.hansson@arm.com # Also make sure to sort the keys based on the objects' path to 140010532Sandreas.hansson@arm.com # ensure that the order is the same on all hosts 140110532Sandreas.hansson@arm.com return sorted(all.keys(), key = lambda o: o.path()), True 14028459SAli.Saidi@ARM.com 14031815SN/A def unproxy(self, base): 14041815SN/A return self 14051815SN/A 14067527Ssteve.reinhardt@amd.com def unproxyParams(self): 140713709Sandreas.sandberg@arm.com for param in self._params.keys(): 14083105Sstever@eecs.umich.edu value = self._values.get(param) 14096654Snate@binkert.org if value != None and isproxy(value): 14103105Sstever@eecs.umich.edu try: 14113105Sstever@eecs.umich.edu value = value.unproxy(self) 14123105Sstever@eecs.umich.edu except: 141312563Sgabeblack@google.com print("Error in unproxying param '%s' of %s" % 141412563Sgabeblack@google.com (param, self.path())) 14153105Sstever@eecs.umich.edu raise 14163105Sstever@eecs.umich.edu setattr(self, param, value) 14173105Sstever@eecs.umich.edu 14183107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 14193107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 142013709Sandreas.sandberg@arm.com port_names = list(self._ports.keys()) 14213107Sstever@eecs.umich.edu port_names.sort() 14223107Sstever@eecs.umich.edu for port_name in port_names: 14233105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 14243105Sstever@eecs.umich.edu if port != None: 14253105Sstever@eecs.umich.edu port.unproxy(self) 14263105Sstever@eecs.umich.edu 14275037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 142812563Sgabeblack@google.com print('[' + self.path() + ']', file=ini_file) # .ini section header 14291692SN/A 14302738SN/A instanceDict[self.path()] = self 14312738SN/A 14324081Sbinkertn@umich.edu if hasattr(self, 'type'): 143312563Sgabeblack@google.com print('type=%s' % self.type, file=ini_file) 14341692SN/A 14358664SAli.Saidi@ARM.com if len(self._children.keys()): 143612563Sgabeblack@google.com print('children=%s' % 143712563Sgabeblack@google.com ' '.join(self._children[n].get_name() 143812563Sgabeblack@google.com for n in sorted(self._children.keys())), 143912563Sgabeblack@google.com file=ini_file) 14401692SN/A 14418664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 14423105Sstever@eecs.umich.edu value = self._values.get(param) 14431692SN/A if value != None: 144412563Sgabeblack@google.com print('%s=%s' % (param, self._values[param].ini_str()), 144512563Sgabeblack@google.com file=ini_file) 14461692SN/A 14478664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 14483105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 14493105Sstever@eecs.umich.edu if port != None: 145012563Sgabeblack@google.com print('%s=%s' % (port_name, port.ini_str()), file=ini_file) 14513103Sstever@eecs.umich.edu 145212563Sgabeblack@google.com print(file=ini_file) # blank line between objects 14531692SN/A 14548664SAli.Saidi@ARM.com # generate a tree of dictionaries expressing all the parameters in the 14558664SAli.Saidi@ARM.com # instantiated system for use by scripts that want to do power, thermal 14568664SAli.Saidi@ARM.com # visualization, and other similar tasks 14578664SAli.Saidi@ARM.com def get_config_as_dict(self): 14588664SAli.Saidi@ARM.com d = attrdict() 14598664SAli.Saidi@ARM.com if hasattr(self, 'type'): 14608664SAli.Saidi@ARM.com d.type = self.type 14618664SAli.Saidi@ARM.com if hasattr(self, 'cxx_class'): 14628664SAli.Saidi@ARM.com d.cxx_class = self.cxx_class 14639017Sandreas.hansson@arm.com # Add the name and path of this object to be able to link to 14649017Sandreas.hansson@arm.com # the stats 14659017Sandreas.hansson@arm.com d.name = self.get_name() 14669017Sandreas.hansson@arm.com d.path = self.path() 14678664SAli.Saidi@ARM.com 14688664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 14698664SAli.Saidi@ARM.com value = self._values.get(param) 14708848Ssteve.reinhardt@amd.com if value != None: 147110380SAndrew.Bardsley@arm.com d[param] = value.config_value() 14728664SAli.Saidi@ARM.com 14738664SAli.Saidi@ARM.com for n in sorted(self._children.keys()): 14749017Sandreas.hansson@arm.com child = self._children[n] 14759017Sandreas.hansson@arm.com # Use the name of the attribute (and not get_name()) as 14769017Sandreas.hansson@arm.com # the key in the JSON dictionary to capture the hierarchy 14779017Sandreas.hansson@arm.com # in the Python code that assembled this system 14789017Sandreas.hansson@arm.com d[n] = child.get_config_as_dict() 14798664SAli.Saidi@ARM.com 14808664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 14818664SAli.Saidi@ARM.com port = self._port_refs.get(port_name, None) 14828664SAli.Saidi@ARM.com if port != None: 14839017Sandreas.hansson@arm.com # Represent each port with a dictionary containing the 14849017Sandreas.hansson@arm.com # prominent attributes 14859017Sandreas.hansson@arm.com d[port_name] = port.get_config_as_dict() 14868664SAli.Saidi@ARM.com 14878664SAli.Saidi@ARM.com return d 14888664SAli.Saidi@ARM.com 14894762Snate@binkert.org def getCCParams(self): 14904762Snate@binkert.org if self._ccParams: 14914762Snate@binkert.org return self._ccParams 14924762Snate@binkert.org 14937677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 14944762Snate@binkert.org cc_params = cc_params_struct() 14954762Snate@binkert.org cc_params.name = str(self) 14964762Snate@binkert.org 149713709Sandreas.sandberg@arm.com param_names = list(self._params.keys()) 14984762Snate@binkert.org param_names.sort() 14994762Snate@binkert.org for param in param_names: 15004762Snate@binkert.org value = self._values.get(param) 15014762Snate@binkert.org if value is None: 15026654Snate@binkert.org fatal("%s.%s without default or user set value", 15036654Snate@binkert.org self.path(), param) 15044762Snate@binkert.org 15054762Snate@binkert.org value = value.getValue() 15064762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 15074762Snate@binkert.org assert isinstance(value, list) 15084762Snate@binkert.org vec = getattr(cc_params, param) 15094762Snate@binkert.org assert not len(vec) 151012035Sandreas.sandberg@arm.com # Some types are exposed as opaque types. They support 151112035Sandreas.sandberg@arm.com # the append operation unlike the automatically 151212035Sandreas.sandberg@arm.com # wrapped types. 151312035Sandreas.sandberg@arm.com if isinstance(vec, list): 151412035Sandreas.sandberg@arm.com setattr(cc_params, param, list(value)) 151512035Sandreas.sandberg@arm.com else: 151612035Sandreas.sandberg@arm.com for v in value: 151712035Sandreas.sandberg@arm.com getattr(cc_params, param).append(v) 15184762Snate@binkert.org else: 15194762Snate@binkert.org setattr(cc_params, param, value) 15204762Snate@binkert.org 152113709Sandreas.sandberg@arm.com port_names = list(self._ports.keys()) 15224762Snate@binkert.org port_names.sort() 15234762Snate@binkert.org for port_name in port_names: 15244762Snate@binkert.org port = self._port_refs.get(port_name, None) 15258912Sandreas.hansson@arm.com if port != None: 15268912Sandreas.hansson@arm.com port_count = len(port) 15278912Sandreas.hansson@arm.com else: 15288912Sandreas.hansson@arm.com port_count = 0 15298900Sandreas.hansson@arm.com setattr(cc_params, 'port_' + port_name + '_connection_count', 15308912Sandreas.hansson@arm.com port_count) 15314762Snate@binkert.org self._ccParams = cc_params 15324762Snate@binkert.org return self._ccParams 15332738SN/A 15342740SN/A # Get C++ object corresponding to this object, calling C++ if 15352740SN/A # necessary to construct it. Does *not* recursively create 15362740SN/A # children. 15372740SN/A def getCCObject(self): 15382740SN/A if not self._ccObject: 15397526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 15407526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 154113663Sandreas.sandberg@arm.com raise RuntimeError("Attempt to instantiate orphan node") 15427526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 15435244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 15445244Sgblack@eecs.umich.edu self._ccObject = -1 154510267SGeoffrey.Blake@arm.com if not self.abstract: 154610267SGeoffrey.Blake@arm.com params = self.getCCParams() 154710267SGeoffrey.Blake@arm.com self._ccObject = params.create() 15482740SN/A elif self._ccObject == -1: 154913663Sandreas.sandberg@arm.com raise RuntimeError("%s: Cycle found in configuration hierarchy." \ 155013663Sandreas.sandberg@arm.com % self.path()) 15512740SN/A return self._ccObject 15522740SN/A 15537527Ssteve.reinhardt@amd.com def descendants(self): 15547527Ssteve.reinhardt@amd.com yield self 155510532Sandreas.hansson@arm.com # The order of the dict is implementation dependent, so sort 155610532Sandreas.hansson@arm.com # it based on the key (name) to ensure the order is the same 155710532Sandreas.hansson@arm.com # on all hosts 155813709Sandreas.sandberg@arm.com for (name, child) in sorted(self._children.items()): 15597527Ssteve.reinhardt@amd.com for obj in child.descendants(): 15607527Ssteve.reinhardt@amd.com yield obj 15617527Ssteve.reinhardt@amd.com 15627527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 15634762Snate@binkert.org def createCCObject(self): 15644762Snate@binkert.org self.getCCParams() 15654762Snate@binkert.org self.getCCObject() # force creation 15664762Snate@binkert.org 15674762Snate@binkert.org def getValue(self): 15684762Snate@binkert.org return self.getCCObject() 15694762Snate@binkert.org 15702738SN/A # Create C++ port connections corresponding to the connections in 15717527Ssteve.reinhardt@amd.com # _port_refs 15722738SN/A def connectPorts(self): 157310532Sandreas.hansson@arm.com # Sort the ports based on their attribute name to ensure the 157410532Sandreas.hansson@arm.com # order is the same on all hosts 157513709Sandreas.sandberg@arm.com for (attr, portRef) in sorted(self._port_refs.items()): 15763105Sstever@eecs.umich.edu portRef.ccConnect() 15772797SN/A 157812469Sglenn.bergmans@arm.com # Default function for generating the device structure. 157912469Sglenn.bergmans@arm.com # Can be overloaded by the inheriting class 158012469Sglenn.bergmans@arm.com def generateDeviceTree(self, state): 158112469Sglenn.bergmans@arm.com return # return without yielding anything 158212469Sglenn.bergmans@arm.com yield # make this function a (null) generator 158312469Sglenn.bergmans@arm.com 158412469Sglenn.bergmans@arm.com def recurseDeviceTree(self, state): 158513709Sandreas.sandberg@arm.com for child in self._children.values(): 158612469Sglenn.bergmans@arm.com for item in child: # For looping over SimObjectVectors 158712786Sandreas.sandberg@arm.com for dt in item.generateDeviceTree(state): 158812786Sandreas.sandberg@arm.com yield dt 158912469Sglenn.bergmans@arm.com 159013356Sciro.santilli@arm.com # On a separate method otherwise certain buggy Python versions 159113356Sciro.santilli@arm.com # would fail with: SyntaxError: unqualified exec is not allowed 159213356Sciro.santilli@arm.com # in function 'apply_config' 159313356Sciro.santilli@arm.com def _apply_config_get_dict(self): 159413356Sciro.santilli@arm.com return { 159513356Sciro.santilli@arm.com child_name: SimObjectCliWrapper( 159613356Sciro.santilli@arm.com iter(self._children[child_name])) 159713356Sciro.santilli@arm.com for child_name in self._children 159813356Sciro.santilli@arm.com } 159913356Sciro.santilli@arm.com 160013356Sciro.santilli@arm.com def apply_config(self, params): 160113356Sciro.santilli@arm.com """ 160213356Sciro.santilli@arm.com exec a list of Python code strings contained in params. 160313356Sciro.santilli@arm.com 160413356Sciro.santilli@arm.com The only exposed globals to those strings are the child 160513356Sciro.santilli@arm.com SimObjects of this node. 160613356Sciro.santilli@arm.com 160713356Sciro.santilli@arm.com This function is intended to allow users to modify SimObject 160813356Sciro.santilli@arm.com parameters from the command line with Python statements. 160913356Sciro.santilli@arm.com """ 161013356Sciro.santilli@arm.com d = self._apply_config_get_dict() 161113356Sciro.santilli@arm.com for param in params: 161213356Sciro.santilli@arm.com exec(param, d) 161313356Sciro.santilli@arm.com 16143101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 16153101Sstever@eecs.umich.edudef resolveSimObject(name): 16163101Sstever@eecs.umich.edu obj = instanceDict[name] 16173101Sstever@eecs.umich.edu return obj.getCCObject() 1618679SN/A 16196654Snate@binkert.orgdef isSimObject(value): 16206654Snate@binkert.org return isinstance(value, SimObject) 16216654Snate@binkert.org 16226654Snate@binkert.orgdef isSimObjectClass(value): 16236654Snate@binkert.org return issubclass(value, SimObject) 16246654Snate@binkert.org 16257528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 16267528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 16277528Ssteve.reinhardt@amd.com 16286654Snate@binkert.orgdef isSimObjectSequence(value): 16296654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 16306654Snate@binkert.org return False 16316654Snate@binkert.org 16326654Snate@binkert.org for val in value: 16336654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 16346654Snate@binkert.org return False 16356654Snate@binkert.org 16366654Snate@binkert.org return True 16376654Snate@binkert.org 16386654Snate@binkert.orgdef isSimObjectOrSequence(value): 16396654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 16406654Snate@binkert.org 16417526Ssteve.reinhardt@amd.comdef isRoot(obj): 16427526Ssteve.reinhardt@amd.com from m5.objects import Root 16437526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 16447526Ssteve.reinhardt@amd.com 16457528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 16467528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 16477528Ssteve.reinhardt@amd.com 16487528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 16497528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 16507528Ssteve.reinhardt@amd.com return value 16517528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 16527528Ssteve.reinhardt@amd.com return SimObjectVector(value) 16537528Ssteve.reinhardt@amd.com return None 16547528Ssteve.reinhardt@amd.com 16557528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 16567528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 16577528Ssteve.reinhardt@amd.com if value is None: 165813663Sandreas.sandberg@arm.com raise TypeError("SimObject or SimObjectVector expected") 16597528Ssteve.reinhardt@amd.com return value 16607528Ssteve.reinhardt@amd.com 16616654Snate@binkert.orgbaseClasses = allClasses.copy() 16626654Snate@binkert.orgbaseInstances = instanceDict.copy() 16636654Snate@binkert.org 16646654Snate@binkert.orgdef clear(): 16659338SAndreas.Sandberg@arm.com global allClasses, instanceDict, noCxxHeader 16666654Snate@binkert.org 16676654Snate@binkert.org allClasses = baseClasses.copy() 16686654Snate@binkert.org instanceDict = baseInstances.copy() 16699338SAndreas.Sandberg@arm.com noCxxHeader = False 16706654Snate@binkert.org 16711528SN/A# __all__ defines the list of symbols that get exported when 16721528SN/A# 'from config import *' is invoked. Try to keep this reasonably 16731528SN/A# short to avoid polluting other namespaces. 167411988Sandreas.sandberg@arm.com__all__ = [ 167511988Sandreas.sandberg@arm.com 'SimObject', 167611988Sandreas.sandberg@arm.com 'cxxMethod', 167711988Sandreas.sandberg@arm.com 'PyBindMethod', 167811988Sandreas.sandberg@arm.com 'PyBindProperty', 167911988Sandreas.sandberg@arm.com] 1680