SimObject.py revision 14205
114061Snikos.nikoleris@arm.com# Copyright (c) 2017-2019 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 17510458Sandreas.hansson@arm.com code() 17610458Sandreas.hansson@arm.com code('${member_prefix}DirectoryEntry::DirectoryEntry()'); 17710458Sandreas.hansson@arm.com code('{') 17810458Sandreas.hansson@arm.com 17910458Sandreas.hansson@arm.com def cxx_bool(b): 18010458Sandreas.hansson@arm.com return 'true' if b else 'false' 18110458Sandreas.hansson@arm.com 18210458Sandreas.hansson@arm.com code.indent() 18310458Sandreas.hansson@arm.com for param in simobj._params.values(): 18410458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 18510458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 18610458Sandreas.hansson@arm.com 18710458Sandreas.hansson@arm.com code('parameters["%s"] = new ParamDesc("%s", %s, %s);' % 18810458Sandreas.hansson@arm.com (param.name, param.name, cxx_bool(is_vector), 18910458Sandreas.hansson@arm.com cxx_bool(is_simobj))); 19010458Sandreas.hansson@arm.com 19110458Sandreas.hansson@arm.com for port in simobj._ports.values(): 19210458Sandreas.hansson@arm.com is_vector = isinstance(port, m5.params.VectorPort) 19310458Sandreas.hansson@arm.com is_master = port.role == 'MASTER' 19410458Sandreas.hansson@arm.com 19510458Sandreas.hansson@arm.com code('ports["%s"] = new PortDesc("%s", %s, %s);' % 19610458Sandreas.hansson@arm.com (port.name, port.name, cxx_bool(is_vector), 19710458Sandreas.hansson@arm.com cxx_bool(is_master))) 19810458Sandreas.hansson@arm.com 19910458Sandreas.hansson@arm.com code.dedent() 20010458Sandreas.hansson@arm.com code('}') 20110458Sandreas.hansson@arm.com code() 20210458Sandreas.hansson@arm.com 20310458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObject(const std::string &name,') 20410458Sandreas.hansson@arm.com code(' SimObject *simObject)${end_of_decl}') 20510458Sandreas.hansson@arm.com 20610458Sandreas.hansson@arm.com if not is_header: 20710458Sandreas.hansson@arm.com code('{') 20810458Sandreas.hansson@arm.com code.indent() 20910458Sandreas.hansson@arm.com code('bool ret = true;') 21010458Sandreas.hansson@arm.com code() 21110458Sandreas.hansson@arm.com code('if (false) {') 21210458Sandreas.hansson@arm.com for param in simobj._params.values(): 21310458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 21410458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 21510458Sandreas.hansson@arm.com 21610458Sandreas.hansson@arm.com if is_simobj and not is_vector: 21710458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 21810458Sandreas.hansson@arm.com code.indent() 21910458Sandreas.hansson@arm.com code('this->${{param.name}} = ' 22010458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(simObject);') 22110458Sandreas.hansson@arm.com code('if (simObject && !this->${{param.name}})') 22210458Sandreas.hansson@arm.com code(' ret = false;') 22310458Sandreas.hansson@arm.com code.dedent() 22410458Sandreas.hansson@arm.com code('} else {') 22510458Sandreas.hansson@arm.com code(' ret = false;') 22610458Sandreas.hansson@arm.com code('}') 22710458Sandreas.hansson@arm.com code() 22810458Sandreas.hansson@arm.com code('return ret;') 22910458Sandreas.hansson@arm.com code.dedent() 23010458Sandreas.hansson@arm.com code('}') 23110458Sandreas.hansson@arm.com 23210458Sandreas.hansson@arm.com code() 23310458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObjectVector(' 23410458Sandreas.hansson@arm.com 'const std::string &name,') 23510458Sandreas.hansson@arm.com code(' const std::vector<SimObject *> &simObjects)${end_of_decl}') 23610458Sandreas.hansson@arm.com 23710458Sandreas.hansson@arm.com if not is_header: 23810458Sandreas.hansson@arm.com code('{') 23910458Sandreas.hansson@arm.com code.indent() 24010458Sandreas.hansson@arm.com code('bool ret = true;') 24110458Sandreas.hansson@arm.com code() 24210458Sandreas.hansson@arm.com code('if (false) {') 24310458Sandreas.hansson@arm.com for param in simobj._params.values(): 24410458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 24510458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 24610458Sandreas.hansson@arm.com 24710458Sandreas.hansson@arm.com if is_simobj and is_vector: 24810458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 24910458Sandreas.hansson@arm.com code.indent() 25010458Sandreas.hansson@arm.com code('this->${{param.name}}.clear();') 25110458Sandreas.hansson@arm.com code('for (auto i = simObjects.begin(); ' 25210458Sandreas.hansson@arm.com 'ret && i != simObjects.end(); i ++)') 25310458Sandreas.hansson@arm.com code('{') 25410458Sandreas.hansson@arm.com code.indent() 25510458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} object = ' 25610458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(*i);') 25710458Sandreas.hansson@arm.com code('if (*i && !object)') 25810458Sandreas.hansson@arm.com code(' ret = false;') 25910458Sandreas.hansson@arm.com code('else') 26010458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(object);') 26110458Sandreas.hansson@arm.com code.dedent() 26210458Sandreas.hansson@arm.com code('}') 26310458Sandreas.hansson@arm.com code.dedent() 26410458Sandreas.hansson@arm.com code('} else {') 26510458Sandreas.hansson@arm.com code(' ret = false;') 26610458Sandreas.hansson@arm.com code('}') 26710458Sandreas.hansson@arm.com code() 26810458Sandreas.hansson@arm.com code('return ret;') 26910458Sandreas.hansson@arm.com code.dedent() 27010458Sandreas.hansson@arm.com code('}') 27110458Sandreas.hansson@arm.com 27210458Sandreas.hansson@arm.com code() 27310458Sandreas.hansson@arm.com code('void ${member_prefix}setName(const std::string &name_)' 27410458Sandreas.hansson@arm.com '${end_of_decl}') 27510458Sandreas.hansson@arm.com 27610458Sandreas.hansson@arm.com if not is_header: 27710458Sandreas.hansson@arm.com code('{') 27810458Sandreas.hansson@arm.com code.indent() 27910458Sandreas.hansson@arm.com code('this->name = name_;') 28010458Sandreas.hansson@arm.com code.dedent() 28110458Sandreas.hansson@arm.com code('}') 28210458Sandreas.hansson@arm.com 28310458Sandreas.hansson@arm.com if is_header: 28410458Sandreas.hansson@arm.com code('const std::string &${member_prefix}getName()') 28510458Sandreas.hansson@arm.com code('{ return this->name; }') 28610458Sandreas.hansson@arm.com 28710458Sandreas.hansson@arm.com code() 28810458Sandreas.hansson@arm.com code('bool ${member_prefix}setParam(const std::string &name,') 28910458Sandreas.hansson@arm.com code(' const std::string &value, const Flags flags)${end_of_decl}') 29010458Sandreas.hansson@arm.com 29110458Sandreas.hansson@arm.com if not is_header: 29210458Sandreas.hansson@arm.com code('{') 29310458Sandreas.hansson@arm.com code.indent() 29410458Sandreas.hansson@arm.com code('bool ret = true;') 29510458Sandreas.hansson@arm.com code() 29610458Sandreas.hansson@arm.com code('if (false) {') 29710458Sandreas.hansson@arm.com for param in simobj._params.values(): 29810458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 29910458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 30010458Sandreas.hansson@arm.com 30110458Sandreas.hansson@arm.com if not is_simobj and not is_vector: 30210458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 30310458Sandreas.hansson@arm.com code.indent() 30410458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 30510458Sandreas.hansson@arm.com 'value', 'this->%s' % param.name, 'ret =') 30610458Sandreas.hansson@arm.com code.dedent() 30710458Sandreas.hansson@arm.com code('} else {') 30810458Sandreas.hansson@arm.com code(' ret = false;') 30910458Sandreas.hansson@arm.com code('}') 31010458Sandreas.hansson@arm.com code() 31110458Sandreas.hansson@arm.com code('return ret;') 31210458Sandreas.hansson@arm.com code.dedent() 31310458Sandreas.hansson@arm.com code('}') 31410458Sandreas.hansson@arm.com 31510458Sandreas.hansson@arm.com code() 31610458Sandreas.hansson@arm.com code('bool ${member_prefix}setParamVector(' 31710458Sandreas.hansson@arm.com 'const std::string &name,') 31810458Sandreas.hansson@arm.com code(' const std::vector<std::string> &values,') 31910458Sandreas.hansson@arm.com code(' const Flags flags)${end_of_decl}') 32010458Sandreas.hansson@arm.com 32110458Sandreas.hansson@arm.com if not is_header: 32210458Sandreas.hansson@arm.com code('{') 32310458Sandreas.hansson@arm.com code.indent() 32410458Sandreas.hansson@arm.com code('bool ret = true;') 32510458Sandreas.hansson@arm.com code() 32610458Sandreas.hansson@arm.com code('if (false) {') 32710458Sandreas.hansson@arm.com for param in simobj._params.values(): 32810458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 32910458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 33010458Sandreas.hansson@arm.com 33110458Sandreas.hansson@arm.com if not is_simobj and is_vector: 33210458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 33310458Sandreas.hansson@arm.com code.indent() 33410458Sandreas.hansson@arm.com code('${{param.name}}.clear();') 33510458Sandreas.hansson@arm.com code('for (auto i = values.begin(); ' 33610458Sandreas.hansson@arm.com 'ret && i != values.end(); i ++)') 33710458Sandreas.hansson@arm.com code('{') 33810458Sandreas.hansson@arm.com code.indent() 33910458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} elem;') 34010458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 34110458Sandreas.hansson@arm.com '*i', 'elem', 'ret =') 34210458Sandreas.hansson@arm.com code('if (ret)') 34310458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(elem);') 34410458Sandreas.hansson@arm.com code.dedent() 34510458Sandreas.hansson@arm.com code('}') 34610458Sandreas.hansson@arm.com code.dedent() 34710458Sandreas.hansson@arm.com code('} else {') 34810458Sandreas.hansson@arm.com code(' ret = false;') 34910458Sandreas.hansson@arm.com code('}') 35010458Sandreas.hansson@arm.com code() 35110458Sandreas.hansson@arm.com code('return ret;') 35210458Sandreas.hansson@arm.com code.dedent() 35310458Sandreas.hansson@arm.com code('}') 35410458Sandreas.hansson@arm.com 35510458Sandreas.hansson@arm.com code() 35610458Sandreas.hansson@arm.com code('bool ${member_prefix}setPortConnectionCount(' 35710458Sandreas.hansson@arm.com 'const std::string &name,') 35810458Sandreas.hansson@arm.com code(' unsigned int count)${end_of_decl}') 35910458Sandreas.hansson@arm.com 36010458Sandreas.hansson@arm.com if not is_header: 36110458Sandreas.hansson@arm.com code('{') 36210458Sandreas.hansson@arm.com code.indent() 36310458Sandreas.hansson@arm.com code('bool ret = true;') 36410458Sandreas.hansson@arm.com code() 36510458Sandreas.hansson@arm.com code('if (false)') 36610458Sandreas.hansson@arm.com code(' ;') 36710458Sandreas.hansson@arm.com for port in simobj._ports.values(): 36810458Sandreas.hansson@arm.com code('else if (name == "${{port.name}}")') 36910458Sandreas.hansson@arm.com code(' this->port_${{port.name}}_connection_count = count;') 37010458Sandreas.hansson@arm.com code('else') 37110458Sandreas.hansson@arm.com code(' ret = false;') 37210458Sandreas.hansson@arm.com code() 37310458Sandreas.hansson@arm.com code('return ret;') 37410458Sandreas.hansson@arm.com code.dedent() 37510458Sandreas.hansson@arm.com code('}') 37610458Sandreas.hansson@arm.com 37710458Sandreas.hansson@arm.com code() 37810458Sandreas.hansson@arm.com code('SimObject *${member_prefix}simObjectCreate()${end_of_decl}') 37910458Sandreas.hansson@arm.com 38010458Sandreas.hansson@arm.com if not is_header: 38110458Sandreas.hansson@arm.com code('{') 38210458Sandreas.hansson@arm.com if hasattr(simobj, 'abstract') and simobj.abstract: 38310458Sandreas.hansson@arm.com code(' return NULL;') 38410458Sandreas.hansson@arm.com else: 38510458Sandreas.hansson@arm.com code(' return this->create();') 38610458Sandreas.hansson@arm.com code('}') 38710458Sandreas.hansson@arm.com 38810458Sandreas.hansson@arm.com if is_header: 38910458Sandreas.hansson@arm.com code() 39010458Sandreas.hansson@arm.com code('static CxxConfigDirectoryEntry' 39110458Sandreas.hansson@arm.com ' *${member_prefix}makeDirectoryEntry()') 39210458Sandreas.hansson@arm.com code('{ return new DirectoryEntry; }') 39310458Sandreas.hansson@arm.com 39410458Sandreas.hansson@arm.com if is_header: 39510458Sandreas.hansson@arm.com code.dedent() 39610458Sandreas.hansson@arm.com code('};') 39710458Sandreas.hansson@arm.com 3982740SN/A# The metaclass for SimObject. This class controls how new classes 3992740SN/A# that derive from SimObject are instantiated, and provides inherited 4002740SN/A# class behavior (just like a class controls how instances of that 4012740SN/A# class are instantiated, and provides inherited instance behavior). 4021692SN/Aclass MetaSimObject(type): 4031427SN/A # Attributes that can be set only at initialization time 40411988Sandreas.sandberg@arm.com init_keywords = { 40511988Sandreas.sandberg@arm.com 'abstract' : bool, 40611988Sandreas.sandberg@arm.com 'cxx_class' : str, 40711988Sandreas.sandberg@arm.com 'cxx_type' : str, 40811988Sandreas.sandberg@arm.com 'cxx_header' : str, 40911988Sandreas.sandberg@arm.com 'type' : str, 41012770Sgabeblack@google.com 'cxx_base' : (str, type(None)), 41112742Sgabeblack@google.com 'cxx_extra_bases' : list, 41211988Sandreas.sandberg@arm.com 'cxx_exports' : list, 41311988Sandreas.sandberg@arm.com 'cxx_param_exports' : list, 41413778Sgabeblack@google.com 'cxx_template_params' : list, 41511988Sandreas.sandberg@arm.com } 4161427SN/A # Attributes that can be set any time 4177493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 418679SN/A 419679SN/A # __new__ is called before __init__, and is where the statements 420679SN/A # in the body of the class definition get loaded into the class's 4212740SN/A # __dict__. We intercept this to filter out parameter & port assignments 422679SN/A # and only allow "private" attributes to be passed to the base 423679SN/A # __new__ (starting with underscore). 4241310SN/A def __new__(mcls, name, bases, dict): 4256654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 4264762Snate@binkert.org 4272740SN/A # Copy "private" attributes, functions, and classes to the 4282740SN/A # official dict. Everything else goes in _init_dict to be 4292740SN/A # filtered in __init__. 4302740SN/A cls_dict = {} 4312740SN/A value_dict = {} 43211988Sandreas.sandberg@arm.com cxx_exports = [] 4332740SN/A for key,val in dict.items(): 43411988Sandreas.sandberg@arm.com try: 43511988Sandreas.sandberg@arm.com cxx_exports.append(getattr(val, "__pybind")) 43611988Sandreas.sandberg@arm.com except AttributeError: 43711988Sandreas.sandberg@arm.com pass 43811988Sandreas.sandberg@arm.com 4397673Snate@binkert.org if public_value(key, val): 4402740SN/A cls_dict[key] = val 4412740SN/A else: 4422740SN/A # must be a param/port setting 4432740SN/A value_dict[key] = val 4444762Snate@binkert.org if 'abstract' not in value_dict: 4454762Snate@binkert.org value_dict['abstract'] = False 44612742Sgabeblack@google.com if 'cxx_extra_bases' not in value_dict: 44712742Sgabeblack@google.com value_dict['cxx_extra_bases'] = [] 44811988Sandreas.sandberg@arm.com if 'cxx_exports' not in value_dict: 44911988Sandreas.sandberg@arm.com value_dict['cxx_exports'] = cxx_exports 45011988Sandreas.sandberg@arm.com else: 45111988Sandreas.sandberg@arm.com value_dict['cxx_exports'] += cxx_exports 45211988Sandreas.sandberg@arm.com if 'cxx_param_exports' not in value_dict: 45311988Sandreas.sandberg@arm.com value_dict['cxx_param_exports'] = [] 45413778Sgabeblack@google.com if 'cxx_template_params' not in value_dict: 45513778Sgabeblack@google.com value_dict['cxx_template_params'] = [] 4562740SN/A cls_dict['_value_dict'] = value_dict 4574762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 4584762Snate@binkert.org if 'type' in value_dict: 4594762Snate@binkert.org allClasses[name] = cls 4604762Snate@binkert.org return cls 461679SN/A 4622711SN/A # subclass initialization 463679SN/A def __init__(cls, name, bases, dict): 4642711SN/A # calls type.__init__()... I think that's a no-op, but leave 4652711SN/A # it here just in case it's not. 4661692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 4671310SN/A 4681427SN/A # initialize required attributes 4692740SN/A 4702740SN/A # class-only attributes 4712740SN/A cls._params = multidict() # param descriptions 4722740SN/A cls._ports = multidict() # port descriptions 4732740SN/A 4742740SN/A # class or instance attributes 4752740SN/A cls._values = multidict() # param values 47610267SGeoffrey.Blake@arm.com cls._hr_values = multidict() # human readable param values 4777528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 4783105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 4792740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 4801310SN/A 4819100SBrad.Beckmann@amd.com # We don't support multiple inheritance of sim objects. If you want 4829100SBrad.Beckmann@amd.com # to, you must fix multidict to deal with it properly. Non sim-objects 4839100SBrad.Beckmann@amd.com # are ok, though 4849100SBrad.Beckmann@amd.com bTotal = 0 4859100SBrad.Beckmann@amd.com for c in bases: 4869100SBrad.Beckmann@amd.com if isinstance(c, MetaSimObject): 4879100SBrad.Beckmann@amd.com bTotal += 1 4889100SBrad.Beckmann@amd.com if bTotal > 1: 48913663Sandreas.sandberg@arm.com raise TypeError( 49013663Sandreas.sandberg@arm.com "SimObjects do not support multiple inheritance") 4911692SN/A 4921692SN/A base = bases[0] 4931692SN/A 4942740SN/A # Set up general inheritance via multidicts. A subclass will 4952740SN/A # inherit all its settings from the base class. The only time 4962740SN/A # the following is not true is when we define the SimObject 4972740SN/A # class itself (in which case the multidicts have no parent). 4981692SN/A if isinstance(base, MetaSimObject): 4995610Snate@binkert.org cls._base = base 5001692SN/A cls._params.parent = base._params 5012740SN/A cls._ports.parent = base._ports 5021692SN/A cls._values.parent = base._values 50310267SGeoffrey.Blake@arm.com cls._hr_values.parent = base._hr_values 5047528Ssteve.reinhardt@amd.com cls._children.parent = base._children 5053105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 5062740SN/A # mark base as having been subclassed 5072712SN/A base._instantiated = True 5085610Snate@binkert.org else: 5095610Snate@binkert.org cls._base = None 5101692SN/A 5114762Snate@binkert.org # default keyword values 5124762Snate@binkert.org if 'type' in cls._value_dict: 5134762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 5145610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 5154762Snate@binkert.org 5165610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 5174859Snate@binkert.org 5189338SAndreas.Sandberg@arm.com if 'cxx_header' not in cls._value_dict: 5199338SAndreas.Sandberg@arm.com global noCxxHeader 5209338SAndreas.Sandberg@arm.com noCxxHeader = True 5219528Ssascha.bischoff@arm.com warn("No header file specified for SimObject: %s", name) 5229338SAndreas.Sandberg@arm.com 5232740SN/A # Now process the _value_dict items. They could be defining 5242740SN/A # new (or overriding existing) parameters or ports, setting 5252740SN/A # class keywords (e.g., 'abstract'), or setting parameter 5262740SN/A # values or port bindings. The first 3 can only be set when 5272740SN/A # the class is defined, so we handle them here. The others 5282740SN/A # can be set later too, so just emulate that by calling 5292740SN/A # setattr(). 5302740SN/A for key,val in cls._value_dict.items(): 5311527SN/A # param descriptions 5322740SN/A if isinstance(val, ParamDesc): 5331585SN/A cls._new_param(key, val) 5341427SN/A 5352738SN/A # port objects 5362738SN/A elif isinstance(val, Port): 5373105Sstever@eecs.umich.edu cls._new_port(key, val) 5382738SN/A 5391427SN/A # init-time-only keywords 54013675Sandreas.sandberg@arm.com elif key in cls.init_keywords: 5411427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 5421427SN/A 5431427SN/A # default: use normal path (ends up in __setattr__) 5441427SN/A else: 5451427SN/A setattr(cls, key, val) 5461427SN/A 5471427SN/A def _set_keyword(cls, keyword, val, kwtype): 5481427SN/A if not isinstance(val, kwtype): 54913663Sandreas.sandberg@arm.com raise TypeError('keyword %s has bad type %s (expecting %s)' % \ 55013663Sandreas.sandberg@arm.com (keyword, type(val), kwtype)) 5517493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 5521427SN/A val = classmethod(val) 5531427SN/A type.__setattr__(cls, keyword, val) 5541427SN/A 5553100SN/A def _new_param(cls, name, pdesc): 5563100SN/A # each param desc should be uniquely assigned to one variable 5573100SN/A assert(not hasattr(pdesc, 'name')) 5583100SN/A pdesc.name = name 5593100SN/A cls._params[name] = pdesc 5603100SN/A if hasattr(pdesc, 'default'): 5613105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 5623105Sstever@eecs.umich.edu 5633105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 5643105Sstever@eecs.umich.edu assert(param.name == name) 5653105Sstever@eecs.umich.edu try: 56610267SGeoffrey.Blake@arm.com hr_value = value 5678321Ssteve.reinhardt@amd.com value = param.convert(value) 56813663Sandreas.sandberg@arm.com except Exception as e: 5693105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 5703105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 5713105Sstever@eecs.umich.edu e.args = (msg, ) 5723105Sstever@eecs.umich.edu raise 5738321Ssteve.reinhardt@amd.com cls._values[name] = value 5748321Ssteve.reinhardt@amd.com # if param value is a SimObject, make it a child too, so that 5758321Ssteve.reinhardt@amd.com # it gets cloned properly when the class is instantiated 5768321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 5778321Ssteve.reinhardt@amd.com cls._add_cls_child(name, value) 57810267SGeoffrey.Blake@arm.com # update human-readable values of the param if it has a literal 57910267SGeoffrey.Blake@arm.com # value and is not an object or proxy. 58010267SGeoffrey.Blake@arm.com if not (isSimObjectOrVector(value) or\ 58110267SGeoffrey.Blake@arm.com isinstance(value, m5.proxy.BaseProxy)): 58210267SGeoffrey.Blake@arm.com cls._hr_values[name] = hr_value 5838321Ssteve.reinhardt@amd.com 5848321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 5858321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 5868321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 5878321Ssteve.reinhardt@amd.com # clears the parent pointer), and this makes it clear that the 5888321Ssteve.reinhardt@amd.com # object is not an orphan and can provide better error 5898321Ssteve.reinhardt@amd.com # messages. 5908321Ssteve.reinhardt@amd.com child.set_parent(cls, name) 59112199Sgabeblack@google.com if not isNullPointer(child): 59212199Sgabeblack@google.com cls._children[name] = child 5933105Sstever@eecs.umich.edu 5943105Sstever@eecs.umich.edu def _new_port(cls, name, port): 5953105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 5963105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 5973105Sstever@eecs.umich.edu port.name = name 5983105Sstever@eecs.umich.edu cls._ports[name] = port 5993105Sstever@eecs.umich.edu 6003105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 6013105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 6023105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 6033105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 6043105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 6053105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 6063105Sstever@eecs.umich.edu if not ref: 6073105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 6083105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 6093105Sstever@eecs.umich.edu return ref 6101585SN/A 6111310SN/A # Set attribute (called on foo.attr = value when foo is an 6121310SN/A # instance of class cls). 6131310SN/A def __setattr__(cls, attr, value): 6141310SN/A # normal processing for private attributes 6157673Snate@binkert.org if public_value(attr, value): 6161310SN/A type.__setattr__(cls, attr, value) 6171310SN/A return 6181310SN/A 61913675Sandreas.sandberg@arm.com if attr in cls.keywords: 6201427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 6211310SN/A return 6221310SN/A 62313675Sandreas.sandberg@arm.com if attr in cls._ports: 6243105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 6252738SN/A return 6262738SN/A 6272740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 62813663Sandreas.sandberg@arm.com raise RuntimeError( 6292740SN/A "cannot set SimObject parameter '%s' after\n" \ 6302740SN/A " class %s has been instantiated or subclassed" \ 63113663Sandreas.sandberg@arm.com % (attr, cls.__name__)) 6322740SN/A 6332740SN/A # check for param 6343105Sstever@eecs.umich.edu param = cls._params.get(attr) 6351310SN/A if param: 6363105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 6373105Sstever@eecs.umich.edu return 6383105Sstever@eecs.umich.edu 6393105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 6403105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 6418321Ssteve.reinhardt@amd.com cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 6423105Sstever@eecs.umich.edu return 6433105Sstever@eecs.umich.edu 6443105Sstever@eecs.umich.edu # no valid assignment... raise exception 64513663Sandreas.sandberg@arm.com raise AttributeError( 64613663Sandreas.sandberg@arm.com "Class %s has no parameter \'%s\'" % (cls.__name__, attr)) 6471310SN/A 6481585SN/A def __getattr__(cls, attr): 6497675Snate@binkert.org if attr == 'cxx_class_path': 6507675Snate@binkert.org return cls.cxx_class.split('::') 6517675Snate@binkert.org 6527675Snate@binkert.org if attr == 'cxx_class_name': 6537675Snate@binkert.org return cls.cxx_class_path[-1] 6547675Snate@binkert.org 6557675Snate@binkert.org if attr == 'cxx_namespaces': 6567675Snate@binkert.org return cls.cxx_class_path[:-1] 6577675Snate@binkert.org 65814061Snikos.nikoleris@arm.com if attr == 'pybind_class': 65914061Snikos.nikoleris@arm.com return '_COLONS_'.join(cls.cxx_class_path) 66014061Snikos.nikoleris@arm.com 66113675Sandreas.sandberg@arm.com if attr in cls._values: 6621692SN/A return cls._values[attr] 6631585SN/A 66413675Sandreas.sandberg@arm.com if attr in cls._children: 6657528Ssteve.reinhardt@amd.com return cls._children[attr] 6667528Ssteve.reinhardt@amd.com 66714061Snikos.nikoleris@arm.com try: 66814061Snikos.nikoleris@arm.com return getattr(cls.getCCClass(), attr) 66914061Snikos.nikoleris@arm.com except AttributeError: 67014061Snikos.nikoleris@arm.com raise AttributeError( 67114061Snikos.nikoleris@arm.com "object '%s' has no attribute '%s'" % (cls.__name__, attr)) 6721585SN/A 6733100SN/A def __str__(cls): 6743100SN/A return cls.__name__ 6753100SN/A 67614061Snikos.nikoleris@arm.com def getCCClass(cls): 67714061Snikos.nikoleris@arm.com return getattr(m5.internal.params, cls.pybind_class) 67814061Snikos.nikoleris@arm.com 6798596Ssteve.reinhardt@amd.com # See ParamValue.cxx_predecls for description. 6808596Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 6818596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 6828596Ssteve.reinhardt@amd.com 68311988Sandreas.sandberg@arm.com def pybind_predecls(cls, code): 68411988Sandreas.sandberg@arm.com code('#include "${{cls.cxx_header}}"') 68511988Sandreas.sandberg@arm.com 68611988Sandreas.sandberg@arm.com def pybind_decl(cls, code): 68714061Snikos.nikoleris@arm.com py_class_name = cls.pybind_class 68811988Sandreas.sandberg@arm.com 68911988Sandreas.sandberg@arm.com # The 'local' attribute restricts us to the params declared in 69011988Sandreas.sandberg@arm.com # the object itself, not including inherited params (which 69111988Sandreas.sandberg@arm.com # will also be inherited from the base class's param struct 69211988Sandreas.sandberg@arm.com # here). Sort the params based on their key 69313683Sandreas.sandberg@arm.com params = map(lambda k_v: k_v[1], sorted(cls._params.local.items())) 69411988Sandreas.sandberg@arm.com ports = cls._ports.local 69511988Sandreas.sandberg@arm.com 69611988Sandreas.sandberg@arm.com code('''#include "pybind11/pybind11.h" 69711988Sandreas.sandberg@arm.com#include "pybind11/stl.h" 69811988Sandreas.sandberg@arm.com 69911988Sandreas.sandberg@arm.com#include "params/$cls.hh" 70012035Sandreas.sandberg@arm.com#include "python/pybind11/core.hh" 70111988Sandreas.sandberg@arm.com#include "sim/init.hh" 70212023Sbrandon.potter@amd.com#include "sim/sim_object.hh" 70312023Sbrandon.potter@amd.com 70411988Sandreas.sandberg@arm.com#include "${{cls.cxx_header}}" 70511988Sandreas.sandberg@arm.com 70611988Sandreas.sandberg@arm.com''') 70711988Sandreas.sandberg@arm.com 70811988Sandreas.sandberg@arm.com for param in params: 70911988Sandreas.sandberg@arm.com param.pybind_predecls(code) 71011988Sandreas.sandberg@arm.com 71111988Sandreas.sandberg@arm.com code('''namespace py = pybind11; 71211988Sandreas.sandberg@arm.com 71311988Sandreas.sandberg@arm.comstatic void 71411988Sandreas.sandberg@arm.commodule_init(py::module &m_internal) 71511988Sandreas.sandberg@arm.com{ 71611988Sandreas.sandberg@arm.com py::module m = m_internal.def_submodule("param_${cls}"); 71711988Sandreas.sandberg@arm.com''') 71811988Sandreas.sandberg@arm.com code.indent() 71911988Sandreas.sandberg@arm.com if cls._base: 72012036Sandreas.sandberg@arm.com code('py::class_<${cls}Params, ${{cls._base.type}}Params, ' \ 72112036Sandreas.sandberg@arm.com 'std::unique_ptr<${{cls}}Params, py::nodelete>>(' \ 72212036Sandreas.sandberg@arm.com 'm, "${cls}Params")') 72311988Sandreas.sandberg@arm.com else: 72412036Sandreas.sandberg@arm.com code('py::class_<${cls}Params, ' \ 72512036Sandreas.sandberg@arm.com 'std::unique_ptr<${cls}Params, py::nodelete>>(' \ 72612036Sandreas.sandberg@arm.com 'm, "${cls}Params")') 72711988Sandreas.sandberg@arm.com 72811988Sandreas.sandberg@arm.com code.indent() 72911988Sandreas.sandberg@arm.com if not hasattr(cls, 'abstract') or not cls.abstract: 73011988Sandreas.sandberg@arm.com code('.def(py::init<>())') 73111988Sandreas.sandberg@arm.com code('.def("create", &${cls}Params::create)') 73211988Sandreas.sandberg@arm.com 73311988Sandreas.sandberg@arm.com param_exports = cls.cxx_param_exports + [ 73411988Sandreas.sandberg@arm.com PyBindProperty(k) 73511988Sandreas.sandberg@arm.com for k, v in sorted(cls._params.local.items()) 73611988Sandreas.sandberg@arm.com ] + [ 73711988Sandreas.sandberg@arm.com PyBindProperty("port_%s_connection_count" % port.name) 73813709Sandreas.sandberg@arm.com for port in ports.values() 73911988Sandreas.sandberg@arm.com ] 74011988Sandreas.sandberg@arm.com for exp in param_exports: 74111988Sandreas.sandberg@arm.com exp.export(code, "%sParams" % cls) 74211988Sandreas.sandberg@arm.com 74311988Sandreas.sandberg@arm.com code(';') 74411988Sandreas.sandberg@arm.com code() 74511988Sandreas.sandberg@arm.com code.dedent() 74611988Sandreas.sandberg@arm.com 74712770Sgabeblack@google.com bases = [] 74812770Sgabeblack@google.com if 'cxx_base' in cls._value_dict: 74912770Sgabeblack@google.com # If the c++ base class implied by python inheritance was 75012770Sgabeblack@google.com # overridden, use that value. 75112770Sgabeblack@google.com if cls.cxx_base: 75212770Sgabeblack@google.com bases.append(cls.cxx_base) 75312770Sgabeblack@google.com elif cls._base: 75412770Sgabeblack@google.com # If not and if there was a SimObject base, use its c++ class 75512770Sgabeblack@google.com # as this class' base. 75612770Sgabeblack@google.com bases.append(cls._base.cxx_class) 75712770Sgabeblack@google.com # Add in any extra bases that were requested. 75812770Sgabeblack@google.com bases.extend(cls.cxx_extra_bases) 75912770Sgabeblack@google.com 76011988Sandreas.sandberg@arm.com if bases: 76111988Sandreas.sandberg@arm.com base_str = ", ".join(bases) 76212036Sandreas.sandberg@arm.com code('py::class_<${{cls.cxx_class}}, ${base_str}, ' \ 76312036Sandreas.sandberg@arm.com 'std::unique_ptr<${{cls.cxx_class}}, py::nodelete>>(' \ 76412036Sandreas.sandberg@arm.com 'm, "${py_class_name}")') 76511988Sandreas.sandberg@arm.com else: 76612036Sandreas.sandberg@arm.com code('py::class_<${{cls.cxx_class}}, ' \ 76712036Sandreas.sandberg@arm.com 'std::unique_ptr<${{cls.cxx_class}}, py::nodelete>>(' \ 76812036Sandreas.sandberg@arm.com 'm, "${py_class_name}")') 76911988Sandreas.sandberg@arm.com code.indent() 77011988Sandreas.sandberg@arm.com for exp in cls.cxx_exports: 77111988Sandreas.sandberg@arm.com exp.export(code, cls.cxx_class) 77211988Sandreas.sandberg@arm.com code(';') 77311988Sandreas.sandberg@arm.com code.dedent() 77411988Sandreas.sandberg@arm.com code() 77511988Sandreas.sandberg@arm.com code.dedent() 77611988Sandreas.sandberg@arm.com code('}') 77711988Sandreas.sandberg@arm.com code() 77811988Sandreas.sandberg@arm.com code('static EmbeddedPyBind embed_obj("${0}", module_init, "${1}");', 77911988Sandreas.sandberg@arm.com cls, cls._base.type if cls._base else "") 78011988Sandreas.sandberg@arm.com 78113778Sgabeblack@google.com _warned_about_nested_templates = False 7828596Ssteve.reinhardt@amd.com 7838596Ssteve.reinhardt@amd.com # Generate the C++ declaration (.hh file) for this SimObject's 7848596Ssteve.reinhardt@amd.com # param struct. Called from src/SConscript. 7858596Ssteve.reinhardt@amd.com def cxx_param_decl(cls, code): 7868596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 7873100SN/A # the object itself, not including inherited params (which 7883100SN/A # will also be inherited from the base class's param struct 78910584Sandreas.hansson@arm.com # here). Sort the params based on their key 79013683Sandreas.sandberg@arm.com params = map(lambda k_v: k_v[1], sorted(cls._params.local.items())) 7918840Sandreas.hansson@arm.com ports = cls._ports.local 7923100SN/A try: 7933100SN/A ptypes = [p.ptype for p in params] 7943100SN/A except: 79512563Sgabeblack@google.com print(cls, p, p.ptype_str) 79612563Sgabeblack@google.com print(params) 7973100SN/A raise 7983100SN/A 79913778Sgabeblack@google.com class CxxClass(object): 80013778Sgabeblack@google.com def __init__(self, sig, template_params=[]): 80113778Sgabeblack@google.com # Split the signature into its constituent parts. This could 80213778Sgabeblack@google.com # potentially be done with regular expressions, but 80313778Sgabeblack@google.com # it's simple enough to pick appart a class signature 80413778Sgabeblack@google.com # manually. 80513778Sgabeblack@google.com parts = sig.split('<', 1) 80613778Sgabeblack@google.com base = parts[0] 80713778Sgabeblack@google.com t_args = [] 80813778Sgabeblack@google.com if len(parts) > 1: 80913778Sgabeblack@google.com # The signature had template arguments. 81013778Sgabeblack@google.com text = parts[1].rstrip(' \t\n>') 81113778Sgabeblack@google.com arg = '' 81213778Sgabeblack@google.com # Keep track of nesting to avoid splitting on ","s embedded 81313778Sgabeblack@google.com # in the arguments themselves. 81413778Sgabeblack@google.com depth = 0 81513778Sgabeblack@google.com for c in text: 81613778Sgabeblack@google.com if c == '<': 81713778Sgabeblack@google.com depth = depth + 1 81813778Sgabeblack@google.com if depth > 0 and not \ 81913778Sgabeblack@google.com self._warned_about_nested_templates: 82013778Sgabeblack@google.com self._warned_about_nested_templates = True 82113778Sgabeblack@google.com print('Nested template argument in cxx_class.' 82213778Sgabeblack@google.com ' This feature is largely untested and ' 82313778Sgabeblack@google.com ' may not work.') 82413778Sgabeblack@google.com elif c == '>': 82513778Sgabeblack@google.com depth = depth - 1 82613778Sgabeblack@google.com elif c == ',' and depth == 0: 82713778Sgabeblack@google.com t_args.append(arg.strip()) 82813778Sgabeblack@google.com arg = '' 82913778Sgabeblack@google.com else: 83013778Sgabeblack@google.com arg = arg + c 83113778Sgabeblack@google.com if arg: 83213778Sgabeblack@google.com t_args.append(arg.strip()) 83313778Sgabeblack@google.com # Split the non-template part on :: boundaries. 83413778Sgabeblack@google.com class_path = base.split('::') 83513778Sgabeblack@google.com 83613778Sgabeblack@google.com # The namespaces are everything except the last part of the 83713778Sgabeblack@google.com # class path. 83813778Sgabeblack@google.com self.namespaces = class_path[:-1] 83913778Sgabeblack@google.com # And the class name is the last part. 84013778Sgabeblack@google.com self.name = class_path[-1] 84113778Sgabeblack@google.com 84213778Sgabeblack@google.com self.template_params = template_params 84313778Sgabeblack@google.com self.template_arguments = [] 84413778Sgabeblack@google.com # Iterate through the template arguments and their values. This 84513778Sgabeblack@google.com # will likely break if parameter packs are used. 84613778Sgabeblack@google.com for arg, param in zip(t_args, template_params): 84713778Sgabeblack@google.com type_keys = ('class', 'typename') 84813778Sgabeblack@google.com # If a parameter is a type, parse it recursively. Otherwise 84913778Sgabeblack@google.com # assume it's a constant, and store it verbatim. 85013778Sgabeblack@google.com if any(param.strip().startswith(kw) for kw in type_keys): 85113778Sgabeblack@google.com self.template_arguments.append(CxxClass(arg)) 85213778Sgabeblack@google.com else: 85313778Sgabeblack@google.com self.template_arguments.append(arg) 85413778Sgabeblack@google.com 85513778Sgabeblack@google.com def declare(self, code): 85613778Sgabeblack@google.com # First declare any template argument types. 85713778Sgabeblack@google.com for arg in self.template_arguments: 85813778Sgabeblack@google.com if isinstance(arg, CxxClass): 85913778Sgabeblack@google.com arg.declare(code) 86013778Sgabeblack@google.com # Re-open the target namespace. 86113778Sgabeblack@google.com for ns in self.namespaces: 86213778Sgabeblack@google.com code('namespace $ns {') 86313778Sgabeblack@google.com # If this is a class template... 86413778Sgabeblack@google.com if self.template_params: 86513778Sgabeblack@google.com code('template <${{", ".join(self.template_params)}}>') 86613778Sgabeblack@google.com # The actual class declaration. 86713778Sgabeblack@google.com code('class ${{self.name}};') 86813778Sgabeblack@google.com # Close the target namespaces. 86913778Sgabeblack@google.com for ns in reversed(self.namespaces): 87013778Sgabeblack@google.com code('} // namespace $ns') 8717675Snate@binkert.org 8727675Snate@binkert.org code('''\ 8737675Snate@binkert.org#ifndef __PARAMS__${cls}__ 8747675Snate@binkert.org#define __PARAMS__${cls}__ 8757675Snate@binkert.org 8767675Snate@binkert.org''') 8777675Snate@binkert.org 87811988Sandreas.sandberg@arm.com 87911988Sandreas.sandberg@arm.com # The base SimObject has a couple of params that get 88011988Sandreas.sandberg@arm.com # automatically set from Python without being declared through 88111988Sandreas.sandberg@arm.com # the normal Param mechanism; we slip them in here (needed 88211988Sandreas.sandberg@arm.com # predecls now, actual declarations below) 88311988Sandreas.sandberg@arm.com if cls == SimObject: 88411988Sandreas.sandberg@arm.com code('''#include <string>''') 88511988Sandreas.sandberg@arm.com 88613778Sgabeblack@google.com cxx_class = CxxClass(cls._value_dict['cxx_class'], 88713778Sgabeblack@google.com cls._value_dict['cxx_template_params']) 88813778Sgabeblack@google.com 8897675Snate@binkert.org # A forward class declaration is sufficient since we are just 8907675Snate@binkert.org # declaring a pointer. 89113778Sgabeblack@google.com cxx_class.declare(code) 8927675Snate@binkert.org 8937673Snate@binkert.org for param in params: 8947673Snate@binkert.org param.cxx_predecls(code) 89513709Sandreas.sandberg@arm.com for port in ports.values(): 8968840Sandreas.hansson@arm.com port.cxx_predecls(code) 8977673Snate@binkert.org code() 8984762Snate@binkert.org 8995610Snate@binkert.org if cls._base: 9007673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 9017673Snate@binkert.org code() 9024762Snate@binkert.org 9034762Snate@binkert.org for ptype in ptypes: 9044762Snate@binkert.org if issubclass(ptype, Enum): 9057673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 9067673Snate@binkert.org code() 9074762Snate@binkert.org 9088596Ssteve.reinhardt@amd.com # now generate the actual param struct 9098597Ssteve.reinhardt@amd.com code("struct ${cls}Params") 9108597Ssteve.reinhardt@amd.com if cls._base: 9118597Ssteve.reinhardt@amd.com code(" : public ${{cls._base.type}}Params") 9128597Ssteve.reinhardt@amd.com code("{") 9138597Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 9148597Ssteve.reinhardt@amd.com if 'type' in cls.__dict__: 9158597Ssteve.reinhardt@amd.com code(" ${{cls.cxx_type}} create();") 9168597Ssteve.reinhardt@amd.com 9178597Ssteve.reinhardt@amd.com code.indent() 9188596Ssteve.reinhardt@amd.com if cls == SimObject: 9198597Ssteve.reinhardt@amd.com code(''' 9209983Sstever@gmail.com SimObjectParams() {} 9218597Ssteve.reinhardt@amd.com virtual ~SimObjectParams() {} 9228596Ssteve.reinhardt@amd.com 9238597Ssteve.reinhardt@amd.com std::string name; 9248597Ssteve.reinhardt@amd.com ''') 92511988Sandreas.sandberg@arm.com 9268597Ssteve.reinhardt@amd.com for param in params: 9278597Ssteve.reinhardt@amd.com param.cxx_decl(code) 92813709Sandreas.sandberg@arm.com for port in ports.values(): 9298840Sandreas.hansson@arm.com port.cxx_decl(code) 9308840Sandreas.hansson@arm.com 9318597Ssteve.reinhardt@amd.com code.dedent() 9328597Ssteve.reinhardt@amd.com code('};') 9335488Snate@binkert.org 9347673Snate@binkert.org code() 9357673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 9365488Snate@binkert.org return code 9375488Snate@binkert.org 93810458Sandreas.hansson@arm.com # Generate the C++ declaration/definition files for this SimObject's 93910458Sandreas.hansson@arm.com # param struct to allow C++ initialisation 94010458Sandreas.hansson@arm.com def cxx_config_param_file(cls, code, is_header): 94110458Sandreas.hansson@arm.com createCxxConfigDirectoryEntryFile(code, cls.__name__, cls, is_header) 94210458Sandreas.hansson@arm.com return code 9435488Snate@binkert.org 9449983Sstever@gmail.com# This *temporary* definition is required to support calls from the 9459983Sstever@gmail.com# SimObject class definition to the MetaSimObject methods (in 9469983Sstever@gmail.com# particular _set_param, which gets called for parameters with default 9479983Sstever@gmail.com# values defined on the SimObject class itself). It will get 9489983Sstever@gmail.com# overridden by the permanent definition (which requires that 9499983Sstever@gmail.com# SimObject be defined) lower in this file. 9509983Sstever@gmail.comdef isSimObjectOrVector(value): 9519983Sstever@gmail.com return False 9523100SN/A 95311988Sandreas.sandberg@arm.comdef cxxMethod(*args, **kwargs): 95411988Sandreas.sandberg@arm.com """Decorator to export C++ functions to Python""" 95511988Sandreas.sandberg@arm.com 95611988Sandreas.sandberg@arm.com def decorate(func): 95713698Sandreas.sandberg@arm.com name = func.__name__ 95811988Sandreas.sandberg@arm.com override = kwargs.get("override", False) 95911988Sandreas.sandberg@arm.com cxx_name = kwargs.get("cxx_name", name) 96013764Sgabeblack@google.com return_value_policy = kwargs.get("return_value_policy", None) 96114061Snikos.nikoleris@arm.com static = kwargs.get("static", False) 96211988Sandreas.sandberg@arm.com 96311988Sandreas.sandberg@arm.com args, varargs, keywords, defaults = inspect.getargspec(func) 96411988Sandreas.sandberg@arm.com if varargs or keywords: 96511988Sandreas.sandberg@arm.com raise ValueError("Wrapped methods must not contain variable " \ 96611988Sandreas.sandberg@arm.com "arguments") 96711988Sandreas.sandberg@arm.com 96811988Sandreas.sandberg@arm.com # Create tuples of (argument, default) 96911988Sandreas.sandberg@arm.com if defaults: 97013709Sandreas.sandberg@arm.com args = args[:-len(defaults)] + \ 97113709Sandreas.sandberg@arm.com list(zip(args[-len(defaults):], defaults)) 97211988Sandreas.sandberg@arm.com # Don't include self in the argument list to PyBind 97311988Sandreas.sandberg@arm.com args = args[1:] 97411988Sandreas.sandberg@arm.com 97511988Sandreas.sandberg@arm.com 97611988Sandreas.sandberg@arm.com @wraps(func) 97711988Sandreas.sandberg@arm.com def cxx_call(self, *args, **kwargs): 97814061Snikos.nikoleris@arm.com ccobj = self.getCCClass() if static else self.getCCObject() 97911988Sandreas.sandberg@arm.com return getattr(ccobj, name)(*args, **kwargs) 98011988Sandreas.sandberg@arm.com 98111988Sandreas.sandberg@arm.com @wraps(func) 98211988Sandreas.sandberg@arm.com def py_call(self, *args, **kwargs): 98312805Sandreas.sandberg@arm.com return func(self, *args, **kwargs) 98411988Sandreas.sandberg@arm.com 98511988Sandreas.sandberg@arm.com f = py_call if override else cxx_call 98613764Sgabeblack@google.com f.__pybind = PyBindMethod(name, cxx_name=cxx_name, args=args, 98714061Snikos.nikoleris@arm.com return_value_policy=return_value_policy, 98814061Snikos.nikoleris@arm.com static=static) 98911988Sandreas.sandberg@arm.com 99011988Sandreas.sandberg@arm.com return f 99111988Sandreas.sandberg@arm.com 99211988Sandreas.sandberg@arm.com if len(args) == 0: 99311988Sandreas.sandberg@arm.com return decorate 99411988Sandreas.sandberg@arm.com elif len(args) == 1 and len(kwargs) == 0: 99511988Sandreas.sandberg@arm.com return decorate(*args) 99611988Sandreas.sandberg@arm.com else: 99711988Sandreas.sandberg@arm.com raise TypeError("One argument and no kwargs, or only kwargs expected") 99811988Sandreas.sandberg@arm.com 99910267SGeoffrey.Blake@arm.com# This class holds information about each simobject parameter 100010267SGeoffrey.Blake@arm.com# that should be displayed on the command line for use in the 100110267SGeoffrey.Blake@arm.com# configuration system. 100210267SGeoffrey.Blake@arm.comclass ParamInfo(object): 100310267SGeoffrey.Blake@arm.com def __init__(self, type, desc, type_str, example, default_val, access_str): 100410267SGeoffrey.Blake@arm.com self.type = type 100510267SGeoffrey.Blake@arm.com self.desc = desc 100610267SGeoffrey.Blake@arm.com self.type_str = type_str 100710267SGeoffrey.Blake@arm.com self.example_str = example 100810267SGeoffrey.Blake@arm.com self.default_val = default_val 100910267SGeoffrey.Blake@arm.com # The string representation used to access this param through python. 101010267SGeoffrey.Blake@arm.com # The method to access this parameter presented on the command line may 101110267SGeoffrey.Blake@arm.com # be different, so this needs to be stored for later use. 101210267SGeoffrey.Blake@arm.com self.access_str = access_str 101310267SGeoffrey.Blake@arm.com self.created = True 101410267SGeoffrey.Blake@arm.com 101510267SGeoffrey.Blake@arm.com # Make it so we can only set attributes at initialization time 101610267SGeoffrey.Blake@arm.com # and effectively make this a const object. 101710267SGeoffrey.Blake@arm.com def __setattr__(self, name, value): 101810267SGeoffrey.Blake@arm.com if not "created" in self.__dict__: 101910267SGeoffrey.Blake@arm.com self.__dict__[name] = value 102010267SGeoffrey.Blake@arm.com 102113356Sciro.santilli@arm.comclass SimObjectCliWrapperException(Exception): 102213356Sciro.santilli@arm.com def __init__(self, message): 102313356Sciro.santilli@arm.com super(Exception, self).__init__(message) 102413356Sciro.santilli@arm.com 102513356Sciro.santilli@arm.comclass SimObjectCliWrapper(object): 102613356Sciro.santilli@arm.com """ 102713356Sciro.santilli@arm.com Wrapper class to restrict operations that may be done 102813356Sciro.santilli@arm.com from the command line on SimObjects. 102913356Sciro.santilli@arm.com 103013356Sciro.santilli@arm.com Only parameters may be set, and only children may be accessed. 103113356Sciro.santilli@arm.com 103213356Sciro.santilli@arm.com Slicing allows for multiple simultaneous assignment of items in 103313356Sciro.santilli@arm.com one statement. 103413356Sciro.santilli@arm.com """ 103513356Sciro.santilli@arm.com 103613356Sciro.santilli@arm.com def __init__(self, sim_objects): 103713356Sciro.santilli@arm.com self.__dict__['_sim_objects'] = list(sim_objects) 103813356Sciro.santilli@arm.com 103913356Sciro.santilli@arm.com def __getattr__(self, key): 104013356Sciro.santilli@arm.com return SimObjectCliWrapper(sim_object._children[key] 104113356Sciro.santilli@arm.com for sim_object in self._sim_objects) 104213356Sciro.santilli@arm.com 104313356Sciro.santilli@arm.com def __setattr__(self, key, val): 104413356Sciro.santilli@arm.com for sim_object in self._sim_objects: 104513356Sciro.santilli@arm.com if key in sim_object._params: 104613356Sciro.santilli@arm.com if sim_object._params[key].isCmdLineSettable(): 104713356Sciro.santilli@arm.com setattr(sim_object, key, val) 104813356Sciro.santilli@arm.com else: 104913356Sciro.santilli@arm.com raise SimObjectCliWrapperException( 105013356Sciro.santilli@arm.com 'tried to set or unsettable' \ 105113356Sciro.santilli@arm.com 'object parameter: ' + key) 105213356Sciro.santilli@arm.com else: 105313356Sciro.santilli@arm.com raise SimObjectCliWrapperException( 105413356Sciro.santilli@arm.com 'tried to set or access non-existent' \ 105513356Sciro.santilli@arm.com 'object parameter: ' + key) 105613356Sciro.santilli@arm.com 105713356Sciro.santilli@arm.com def __getitem__(self, idx): 105813356Sciro.santilli@arm.com """ 105913356Sciro.santilli@arm.com Extends the list() semantics to also allow tuples, 106013356Sciro.santilli@arm.com for example object[1, 3] selects items 1 and 3. 106113356Sciro.santilli@arm.com """ 106213356Sciro.santilli@arm.com out = [] 106313356Sciro.santilli@arm.com if isinstance(idx, tuple): 106413356Sciro.santilli@arm.com for t in idx: 106513356Sciro.santilli@arm.com out.extend(self[t]._sim_objects) 106613356Sciro.santilli@arm.com else: 106713356Sciro.santilli@arm.com if isinstance(idx, int): 106813356Sciro.santilli@arm.com _range = range(idx, idx + 1) 106913356Sciro.santilli@arm.com elif not isinstance(idx, slice): 107013356Sciro.santilli@arm.com raise SimObjectCliWrapperException( \ 107113356Sciro.santilli@arm.com 'invalid index type: ' + repr(idx)) 107213356Sciro.santilli@arm.com for sim_object in self._sim_objects: 107313356Sciro.santilli@arm.com if isinstance(idx, slice): 107413356Sciro.santilli@arm.com _range = range(*idx.indices(len(sim_object))) 107513356Sciro.santilli@arm.com out.extend(sim_object[i] for i in _range) 107613356Sciro.santilli@arm.com return SimObjectCliWrapper(out) 107713356Sciro.santilli@arm.com 10782740SN/A# The SimObject class is the root of the special hierarchy. Most of 1079679SN/A# the code in this class deals with the configuration hierarchy itself 1080679SN/A# (parent/child node relationships). 10811692SN/Aclass SimObject(object): 10821692SN/A # Specify metaclass. Any class inheriting from SimObject will 1083679SN/A # get this metaclass. 10841692SN/A __metaclass__ = MetaSimObject 10853100SN/A type = 'SimObject' 10864762Snate@binkert.org abstract = True 10879983Sstever@gmail.com 10889338SAndreas.Sandberg@arm.com cxx_header = "sim/sim_object.hh" 108914205Sandreas.sandberg@arm.com cxx_extra_bases = [ "Drainable", "Serializable", "Stats::Group" ] 10909983Sstever@gmail.com eventq_index = Param.UInt32(Parent.eventq_index, "Event Queue Index") 10919342SAndreas.Sandberg@arm.com 109211988Sandreas.sandberg@arm.com cxx_exports = [ 109311988Sandreas.sandberg@arm.com PyBindMethod("init"), 109411988Sandreas.sandberg@arm.com PyBindMethod("initState"), 109511988Sandreas.sandberg@arm.com PyBindMethod("memInvalidate"), 109611988Sandreas.sandberg@arm.com PyBindMethod("memWriteback"), 109711988Sandreas.sandberg@arm.com PyBindMethod("regProbePoints"), 109811988Sandreas.sandberg@arm.com PyBindMethod("regProbeListeners"), 109911988Sandreas.sandberg@arm.com PyBindMethod("startup"), 110011988Sandreas.sandberg@arm.com ] 110111988Sandreas.sandberg@arm.com 110211988Sandreas.sandberg@arm.com cxx_param_exports = [ 110311988Sandreas.sandberg@arm.com PyBindProperty("name"), 110411988Sandreas.sandberg@arm.com ] 110511988Sandreas.sandberg@arm.com 110611988Sandreas.sandberg@arm.com @cxxMethod 110711988Sandreas.sandberg@arm.com def loadState(self, cp): 110811988Sandreas.sandberg@arm.com """Load SimObject state from a checkpoint""" 110911988Sandreas.sandberg@arm.com pass 111011988Sandreas.sandberg@arm.com 111110267SGeoffrey.Blake@arm.com # Returns a dict of all the option strings that can be 111210267SGeoffrey.Blake@arm.com # generated as command line options for this simobject instance 111310267SGeoffrey.Blake@arm.com # by tracing all reachable params in the top level instance and 111410267SGeoffrey.Blake@arm.com # any children it contains. 111510267SGeoffrey.Blake@arm.com def enumerateParams(self, flags_dict = {}, 111610267SGeoffrey.Blake@arm.com cmd_line_str = "", access_str = ""): 111710267SGeoffrey.Blake@arm.com if hasattr(self, "_paramEnumed"): 111812563Sgabeblack@google.com print("Cycle detected enumerating params") 111910267SGeoffrey.Blake@arm.com else: 112010267SGeoffrey.Blake@arm.com self._paramEnumed = True 112110267SGeoffrey.Blake@arm.com # Scan the children first to pick up all the objects in this SimObj 112210267SGeoffrey.Blake@arm.com for keys in self._children: 112310267SGeoffrey.Blake@arm.com child = self._children[keys] 112410267SGeoffrey.Blake@arm.com next_cmdline_str = cmd_line_str + keys 112510267SGeoffrey.Blake@arm.com next_access_str = access_str + keys 112610267SGeoffrey.Blake@arm.com if not isSimObjectVector(child): 112710267SGeoffrey.Blake@arm.com next_cmdline_str = next_cmdline_str + "." 112810267SGeoffrey.Blake@arm.com next_access_str = next_access_str + "." 112910267SGeoffrey.Blake@arm.com flags_dict = child.enumerateParams(flags_dict, 113010267SGeoffrey.Blake@arm.com next_cmdline_str, 113110267SGeoffrey.Blake@arm.com next_access_str) 113210267SGeoffrey.Blake@arm.com 113310267SGeoffrey.Blake@arm.com # Go through the simple params in the simobject in this level 113410267SGeoffrey.Blake@arm.com # of the simobject hierarchy and save information about the 113510267SGeoffrey.Blake@arm.com # parameter to be used for generating and processing command line 113610267SGeoffrey.Blake@arm.com # options to the simulator to set these parameters. 113710267SGeoffrey.Blake@arm.com for keys,values in self._params.items(): 113810267SGeoffrey.Blake@arm.com if values.isCmdLineSettable(): 113910267SGeoffrey.Blake@arm.com type_str = '' 114010267SGeoffrey.Blake@arm.com ex_str = values.example_str() 114110267SGeoffrey.Blake@arm.com ptype = None 114210267SGeoffrey.Blake@arm.com if isinstance(values, VectorParamDesc): 114310267SGeoffrey.Blake@arm.com type_str = 'Vector_%s' % values.ptype_str 114410267SGeoffrey.Blake@arm.com ptype = values 114510267SGeoffrey.Blake@arm.com else: 114610267SGeoffrey.Blake@arm.com type_str = '%s' % values.ptype_str 114710267SGeoffrey.Blake@arm.com ptype = values.ptype 114810267SGeoffrey.Blake@arm.com 114910267SGeoffrey.Blake@arm.com if keys in self._hr_values\ 115010267SGeoffrey.Blake@arm.com and keys in self._values\ 115112023Sbrandon.potter@amd.com and not isinstance(self._values[keys], 115212023Sbrandon.potter@amd.com m5.proxy.BaseProxy): 115310267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 115410267SGeoffrey.Blake@arm.com acc_str = access_str + keys 115510267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 115610267SGeoffrey.Blake@arm.com self._params[keys].desc, type_str, ex_str, 115710267SGeoffrey.Blake@arm.com values.pretty_print(self._hr_values[keys]), 115810267SGeoffrey.Blake@arm.com acc_str) 115910267SGeoffrey.Blake@arm.com elif not keys in self._hr_values\ 116010267SGeoffrey.Blake@arm.com and not keys in self._values: 116110267SGeoffrey.Blake@arm.com # Empty param 116210267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 116310267SGeoffrey.Blake@arm.com acc_str = access_str + keys 116410267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 116510267SGeoffrey.Blake@arm.com self._params[keys].desc, 116610267SGeoffrey.Blake@arm.com type_str, ex_str, '', acc_str) 116710267SGeoffrey.Blake@arm.com 116810267SGeoffrey.Blake@arm.com return flags_dict 116910267SGeoffrey.Blake@arm.com 11702740SN/A # Initialize new instance. For objects with SimObject-valued 11712740SN/A # children, we need to recursively clone the classes represented 11722740SN/A # by those param values as well in a consistent "deep copy"-style 11732740SN/A # fashion. That is, we want to make sure that each instance is 11742740SN/A # cloned only once, and that if there are multiple references to 11752740SN/A # the same original object, we end up with the corresponding 11762740SN/A # cloned references all pointing to the same cloned instance. 11772740SN/A def __init__(self, **kwargs): 11782740SN/A ancestor = kwargs.get('_ancestor') 11792740SN/A memo_dict = kwargs.get('_memo') 11802740SN/A if memo_dict is None: 11812740SN/A # prepare to memoize any recursively instantiated objects 11822740SN/A memo_dict = {} 11832740SN/A elif ancestor: 11842740SN/A # memoize me now to avoid problems with recursive calls 11852740SN/A memo_dict[ancestor] = self 11862711SN/A 11872740SN/A if not ancestor: 11882740SN/A ancestor = self.__class__ 11892740SN/A ancestor._instantiated = True 11902711SN/A 11912740SN/A # initialize required attributes 11922740SN/A self._parent = None 11937528Ssteve.reinhardt@amd.com self._name = None 11942740SN/A self._ccObject = None # pointer to C++ object 11954762Snate@binkert.org self._ccParams = None 11962740SN/A self._instantiated = False # really "cloned" 11972712SN/A 11988321Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 11998321Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 12008321Ssteve.reinhardt@amd.com # Do children before parameter values so that children that 12018321Ssteve.reinhardt@amd.com # are also param values get cloned properly. 12028321Ssteve.reinhardt@amd.com self._children = {} 120313709Sandreas.sandberg@arm.com for key,val in ancestor._children.items(): 12048321Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 12058321Ssteve.reinhardt@amd.com 12062711SN/A # Inherit parameter values from class using multidict so 12077528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 12087528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 12092740SN/A self._values = multidict(ancestor._values) 121010267SGeoffrey.Blake@arm.com self._hr_values = multidict(ancestor._hr_values) 12112740SN/A # clone SimObject-valued parameters 121213709Sandreas.sandberg@arm.com for key,val in ancestor._values.items(): 12137528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 12147528Ssteve.reinhardt@amd.com if val is not None: 12157528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 12167528Ssteve.reinhardt@amd.com 12172740SN/A # clone port references. no need to use a multidict here 12182740SN/A # since we will be creating new references for all ports. 12193105Sstever@eecs.umich.edu self._port_refs = {} 122013709Sandreas.sandberg@arm.com for key,val in ancestor._port_refs.items(): 12213105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 12221692SN/A # apply attribute assignments from keyword args, if any 122313709Sandreas.sandberg@arm.com for key,val in kwargs.items(): 12241692SN/A setattr(self, key, val) 1225679SN/A 12262740SN/A # "Clone" the current instance by creating another instance of 12272740SN/A # this instance's class, but that inherits its parameter values 12282740SN/A # and port mappings from the current instance. If we're in a 12292740SN/A # "deep copy" recursive clone, check the _memo dict to see if 12302740SN/A # we've already cloned this instance. 12311692SN/A def __call__(self, **kwargs): 12322740SN/A memo_dict = kwargs.get('_memo') 12332740SN/A if memo_dict is None: 12342740SN/A # no memo_dict: must be top-level clone operation. 12352740SN/A # this is only allowed at the root of a hierarchy 12362740SN/A if self._parent: 123713663Sandreas.sandberg@arm.com raise RuntimeError("attempt to clone object %s " \ 12382740SN/A "not at the root of a tree (parent = %s)" \ 123913663Sandreas.sandberg@arm.com % (self, self._parent)) 12402740SN/A # create a new dict and use that. 12412740SN/A memo_dict = {} 12422740SN/A kwargs['_memo'] = memo_dict 124313675Sandreas.sandberg@arm.com elif self in memo_dict: 12442740SN/A # clone already done & memoized 12452740SN/A return memo_dict[self] 12462740SN/A return self.__class__(_ancestor = self, **kwargs) 12471343SN/A 12483105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 12493105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 12503105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 12513105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 12523105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 12539940SGeoffrey.Blake@arm.com if ref == None: 12543105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 12553105Sstever@eecs.umich.edu self._port_refs[attr] = ref 12563105Sstever@eecs.umich.edu return ref 12573105Sstever@eecs.umich.edu 12581692SN/A def __getattr__(self, attr): 125913675Sandreas.sandberg@arm.com if attr in self._ports: 12603105Sstever@eecs.umich.edu return self._get_port_ref(attr) 12612738SN/A 126213675Sandreas.sandberg@arm.com if attr in self._values: 12631692SN/A return self._values[attr] 12641427SN/A 126513675Sandreas.sandberg@arm.com if attr in self._children: 12667528Ssteve.reinhardt@amd.com return self._children[attr] 12677528Ssteve.reinhardt@amd.com 12687500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 12697500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 127011991Sandreas.sandberg@arm.com # methods exported to Python (e.g., init(), and startup()) 12717500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 12727500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 12737500Ssteve.reinhardt@amd.com 127410002Ssteve.reinhardt@amd.com err_string = "object '%s' has no attribute '%s'" \ 12751692SN/A % (self.__class__.__name__, attr) 12761427SN/A 127710002Ssteve.reinhardt@amd.com if not self._ccObject: 127810002Ssteve.reinhardt@amd.com err_string += "\n (C++ object is not yet constructed," \ 127910002Ssteve.reinhardt@amd.com " so wrapped C++ methods are unavailable.)" 128010002Ssteve.reinhardt@amd.com 128113663Sandreas.sandberg@arm.com raise AttributeError(err_string) 128210002Ssteve.reinhardt@amd.com 12831692SN/A # Set attribute (called on foo.attr = value when foo is an 12841692SN/A # instance of class cls). 12851692SN/A def __setattr__(self, attr, value): 12861692SN/A # normal processing for private attributes 12871692SN/A if attr.startswith('_'): 12881692SN/A object.__setattr__(self, attr, value) 12891692SN/A return 12901427SN/A 129113675Sandreas.sandberg@arm.com if attr in self._ports: 12922738SN/A # set up port connection 12933105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 12942738SN/A return 12952738SN/A 12963105Sstever@eecs.umich.edu param = self._params.get(attr) 12971692SN/A if param: 12981310SN/A try: 129910267SGeoffrey.Blake@arm.com hr_value = value 13001692SN/A value = param.convert(value) 130113663Sandreas.sandberg@arm.com except Exception as e: 13021692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 13031692SN/A (e, self.__class__.__name__, attr, value) 13041605SN/A e.args = (msg, ) 13051605SN/A raise 13067528Ssteve.reinhardt@amd.com self._values[attr] = value 13078321Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 13088321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 13098321Ssteve.reinhardt@amd.com self.add_child(attr, value) 131010267SGeoffrey.Blake@arm.com # set the human-readable value dict if this is a param 131110267SGeoffrey.Blake@arm.com # with a literal value and is not being set as an object 131210267SGeoffrey.Blake@arm.com # or proxy. 131310267SGeoffrey.Blake@arm.com if not (isSimObjectOrVector(value) or\ 131410267SGeoffrey.Blake@arm.com isinstance(value, m5.proxy.BaseProxy)): 131510267SGeoffrey.Blake@arm.com self._hr_values[attr] = hr_value 131610267SGeoffrey.Blake@arm.com 13173105Sstever@eecs.umich.edu return 13181310SN/A 13197528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 13203105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 13217528Ssteve.reinhardt@amd.com self.add_child(attr, value) 13223105Sstever@eecs.umich.edu return 13231693SN/A 13243105Sstever@eecs.umich.edu # no valid assignment... raise exception 132513663Sandreas.sandberg@arm.com raise AttributeError("Class %s has no parameter %s" \ 132613663Sandreas.sandberg@arm.com % (self.__class__.__name__, attr)) 13271310SN/A 13281310SN/A 13291692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 13301692SN/A # not be vectors, and always getting the first element (e.g. cpus) 13311692SN/A def __getitem__(self, key): 13321692SN/A if key == 0: 13331692SN/A return self 133413663Sandreas.sandberg@arm.com raise IndexError("Non-zero index '%s' to SimObject" % key) 133510267SGeoffrey.Blake@arm.com 133610267SGeoffrey.Blake@arm.com # this hack allows us to iterate over a SimObject that may 133710267SGeoffrey.Blake@arm.com # not be a vector, so we can call a loop over it and get just one 133810267SGeoffrey.Blake@arm.com # element. 133910267SGeoffrey.Blake@arm.com def __len__(self): 134010267SGeoffrey.Blake@arm.com return 1 13411310SN/A 13427528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13437528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 13447528Ssteve.reinhardt@amd.com assert self._parent is old_parent 13457528Ssteve.reinhardt@amd.com self._parent = None 13467528Ssteve.reinhardt@amd.com 13477528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13487528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 13497528Ssteve.reinhardt@amd.com self._parent = parent 13507528Ssteve.reinhardt@amd.com self._name = name 13517528Ssteve.reinhardt@amd.com 135212023Sbrandon.potter@amd.com # Return parent object of this SimObject, not implemented by 135312023Sbrandon.potter@amd.com # SimObjectVector because the elements in a SimObjectVector may not share 135412023Sbrandon.potter@amd.com # the same parent 13559953Sgeoffrey.blake@arm.com def get_parent(self): 13569953Sgeoffrey.blake@arm.com return self._parent 13579953Sgeoffrey.blake@arm.com 13587528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13597528Ssteve.reinhardt@amd.com def get_name(self): 13607528Ssteve.reinhardt@amd.com return self._name 13617528Ssteve.reinhardt@amd.com 13628321Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13638321Ssteve.reinhardt@amd.com def has_parent(self): 13648321Ssteve.reinhardt@amd.com return self._parent is not None 13657528Ssteve.reinhardt@amd.com 13667742Sgblack@eecs.umich.edu # clear out child with given name. This code is not likely to be exercised. 13677742Sgblack@eecs.umich.edu # See comment in add_child. 13681693SN/A def clear_child(self, name): 13691693SN/A child = self._children[name] 13707528Ssteve.reinhardt@amd.com child.clear_parent(self) 13711693SN/A del self._children[name] 13721693SN/A 13737528Ssteve.reinhardt@amd.com # Add a new child to this object. 13747528Ssteve.reinhardt@amd.com def add_child(self, name, child): 13757528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 13768321Ssteve.reinhardt@amd.com if child.has_parent(): 13779528Ssascha.bischoff@arm.com warn("add_child('%s'): child '%s' already has parent", name, 13789528Ssascha.bischoff@arm.com child.get_name()) 137913675Sandreas.sandberg@arm.com if name in self._children: 13807742Sgblack@eecs.umich.edu # This code path had an undiscovered bug that would make it fail 13817742Sgblack@eecs.umich.edu # at runtime. It had been here for a long time and was only 13827742Sgblack@eecs.umich.edu # exposed by a buggy script. Changes here will probably not be 13837742Sgblack@eecs.umich.edu # exercised without specialized testing. 13847738Sgblack@eecs.umich.edu self.clear_child(name) 13857528Ssteve.reinhardt@amd.com child.set_parent(self, name) 138612199Sgabeblack@google.com if not isNullPointer(child): 138712199Sgabeblack@google.com self._children[name] = child 13881310SN/A 13897528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 13907528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 13917528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 13927528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 13937528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 13947528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 139513709Sandreas.sandberg@arm.com for key,val in self._values.items(): 13967528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 13977528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 13988321Ssteve.reinhardt@amd.com # SimObjectVector class so we can call has_parent() 13997528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 14007528Ssteve.reinhardt@amd.com self._values[key] = val 14018321Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 14029528Ssascha.bischoff@arm.com warn("%s adopting orphan SimObject param '%s'", self, key) 14037528Ssteve.reinhardt@amd.com self.add_child(key, val) 14043105Sstever@eecs.umich.edu 14051692SN/A def path(self): 14062740SN/A if not self._parent: 14078321Ssteve.reinhardt@amd.com return '<orphan %s>' % self.__class__ 140811231Sandreas.sandberg@arm.com elif isinstance(self._parent, MetaSimObject): 140911231Sandreas.sandberg@arm.com return str(self.__class__) 141011231Sandreas.sandberg@arm.com 14111692SN/A ppath = self._parent.path() 14121692SN/A if ppath == 'root': 14131692SN/A return self._name 14141692SN/A return ppath + "." + self._name 14151310SN/A 14161692SN/A def __str__(self): 14171692SN/A return self.path() 14181310SN/A 141910380SAndrew.Bardsley@arm.com def config_value(self): 142010380SAndrew.Bardsley@arm.com return self.path() 142110380SAndrew.Bardsley@arm.com 14221692SN/A def ini_str(self): 14231692SN/A return self.path() 14241310SN/A 14251692SN/A def find_any(self, ptype): 14261692SN/A if isinstance(self, ptype): 14271692SN/A return self, True 14281310SN/A 14291692SN/A found_obj = None 143013709Sandreas.sandberg@arm.com for child in self._children.values(): 143110195SGeoffrey.Blake@arm.com visited = False 143210195SGeoffrey.Blake@arm.com if hasattr(child, '_visited'): 143310195SGeoffrey.Blake@arm.com visited = getattr(child, '_visited') 143410195SGeoffrey.Blake@arm.com 143510195SGeoffrey.Blake@arm.com if isinstance(child, ptype) and not visited: 14361692SN/A if found_obj != None and child != found_obj: 143713663Sandreas.sandberg@arm.com raise AttributeError( 14381692SN/A 'parent.any matched more than one: %s %s' % \ 143913663Sandreas.sandberg@arm.com (found_obj.path, child.path)) 14401692SN/A found_obj = child 14411692SN/A # search param space 144213709Sandreas.sandberg@arm.com for pname,pdesc in self._params.items(): 14431692SN/A if issubclass(pdesc.ptype, ptype): 14441692SN/A match_obj = self._values[pname] 14451692SN/A if found_obj != None and found_obj != match_obj: 144613663Sandreas.sandberg@arm.com raise AttributeError( 144712023Sbrandon.potter@amd.com 'parent.any matched more than one: %s and %s' % \ 144813663Sandreas.sandberg@arm.com (found_obj.path, match_obj.path)) 14491692SN/A found_obj = match_obj 14501692SN/A return found_obj, found_obj != None 14511692SN/A 14528459SAli.Saidi@ARM.com def find_all(self, ptype): 14538459SAli.Saidi@ARM.com all = {} 14548459SAli.Saidi@ARM.com # search children 145513709Sandreas.sandberg@arm.com for child in self._children.values(): 14569410Sandreas.hansson@arm.com # a child could be a list, so ensure we visit each item 14579410Sandreas.hansson@arm.com if isinstance(child, list): 14589410Sandreas.hansson@arm.com children = child 14599410Sandreas.hansson@arm.com else: 14609410Sandreas.hansson@arm.com children = [child] 14619410Sandreas.hansson@arm.com 14629410Sandreas.hansson@arm.com for child in children: 14639410Sandreas.hansson@arm.com if isinstance(child, ptype) and not isproxy(child) and \ 14649410Sandreas.hansson@arm.com not isNullPointer(child): 14659410Sandreas.hansson@arm.com all[child] = True 14669410Sandreas.hansson@arm.com if isSimObject(child): 14679410Sandreas.hansson@arm.com # also add results from the child itself 14689410Sandreas.hansson@arm.com child_all, done = child.find_all(ptype) 14699410Sandreas.hansson@arm.com all.update(dict(zip(child_all, [done] * len(child_all)))) 14708459SAli.Saidi@ARM.com # search param space 147113709Sandreas.sandberg@arm.com for pname,pdesc in self._params.items(): 14728459SAli.Saidi@ARM.com if issubclass(pdesc.ptype, ptype): 14738459SAli.Saidi@ARM.com match_obj = self._values[pname] 14748459SAli.Saidi@ARM.com if not isproxy(match_obj) and not isNullPointer(match_obj): 14758459SAli.Saidi@ARM.com all[match_obj] = True 147610532Sandreas.hansson@arm.com # Also make sure to sort the keys based on the objects' path to 147710532Sandreas.hansson@arm.com # ensure that the order is the same on all hosts 147810532Sandreas.hansson@arm.com return sorted(all.keys(), key = lambda o: o.path()), True 14798459SAli.Saidi@ARM.com 14801815SN/A def unproxy(self, base): 14811815SN/A return self 14821815SN/A 14837527Ssteve.reinhardt@amd.com def unproxyParams(self): 148413709Sandreas.sandberg@arm.com for param in self._params.keys(): 14853105Sstever@eecs.umich.edu value = self._values.get(param) 14866654Snate@binkert.org if value != None and isproxy(value): 14873105Sstever@eecs.umich.edu try: 14883105Sstever@eecs.umich.edu value = value.unproxy(self) 14893105Sstever@eecs.umich.edu except: 149012563Sgabeblack@google.com print("Error in unproxying param '%s' of %s" % 149112563Sgabeblack@google.com (param, self.path())) 14923105Sstever@eecs.umich.edu raise 14933105Sstever@eecs.umich.edu setattr(self, param, value) 14943105Sstever@eecs.umich.edu 14953107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 14963107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 149713709Sandreas.sandberg@arm.com port_names = list(self._ports.keys()) 14983107Sstever@eecs.umich.edu port_names.sort() 14993107Sstever@eecs.umich.edu for port_name in port_names: 15003105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 15013105Sstever@eecs.umich.edu if port != None: 15023105Sstever@eecs.umich.edu port.unproxy(self) 15033105Sstever@eecs.umich.edu 15045037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 150512563Sgabeblack@google.com print('[' + self.path() + ']', file=ini_file) # .ini section header 15061692SN/A 15072738SN/A instanceDict[self.path()] = self 15082738SN/A 15094081Sbinkertn@umich.edu if hasattr(self, 'type'): 151012563Sgabeblack@google.com print('type=%s' % self.type, file=ini_file) 15111692SN/A 15128664SAli.Saidi@ARM.com if len(self._children.keys()): 151312563Sgabeblack@google.com print('children=%s' % 151412563Sgabeblack@google.com ' '.join(self._children[n].get_name() 151512563Sgabeblack@google.com for n in sorted(self._children.keys())), 151612563Sgabeblack@google.com file=ini_file) 15171692SN/A 15188664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 15193105Sstever@eecs.umich.edu value = self._values.get(param) 15201692SN/A if value != None: 152112563Sgabeblack@google.com print('%s=%s' % (param, self._values[param].ini_str()), 152212563Sgabeblack@google.com file=ini_file) 15231692SN/A 15248664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 15253105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 15263105Sstever@eecs.umich.edu if port != None: 152712563Sgabeblack@google.com print('%s=%s' % (port_name, port.ini_str()), file=ini_file) 15283103Sstever@eecs.umich.edu 152912563Sgabeblack@google.com print(file=ini_file) # blank line between objects 15301692SN/A 15318664SAli.Saidi@ARM.com # generate a tree of dictionaries expressing all the parameters in the 15328664SAli.Saidi@ARM.com # instantiated system for use by scripts that want to do power, thermal 15338664SAli.Saidi@ARM.com # visualization, and other similar tasks 15348664SAli.Saidi@ARM.com def get_config_as_dict(self): 15358664SAli.Saidi@ARM.com d = attrdict() 15368664SAli.Saidi@ARM.com if hasattr(self, 'type'): 15378664SAli.Saidi@ARM.com d.type = self.type 15388664SAli.Saidi@ARM.com if hasattr(self, 'cxx_class'): 15398664SAli.Saidi@ARM.com d.cxx_class = self.cxx_class 15409017Sandreas.hansson@arm.com # Add the name and path of this object to be able to link to 15419017Sandreas.hansson@arm.com # the stats 15429017Sandreas.hansson@arm.com d.name = self.get_name() 15439017Sandreas.hansson@arm.com d.path = self.path() 15448664SAli.Saidi@ARM.com 15458664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 15468664SAli.Saidi@ARM.com value = self._values.get(param) 15478848Ssteve.reinhardt@amd.com if value != None: 154810380SAndrew.Bardsley@arm.com d[param] = value.config_value() 15498664SAli.Saidi@ARM.com 15508664SAli.Saidi@ARM.com for n in sorted(self._children.keys()): 15519017Sandreas.hansson@arm.com child = self._children[n] 15529017Sandreas.hansson@arm.com # Use the name of the attribute (and not get_name()) as 15539017Sandreas.hansson@arm.com # the key in the JSON dictionary to capture the hierarchy 15549017Sandreas.hansson@arm.com # in the Python code that assembled this system 15559017Sandreas.hansson@arm.com d[n] = child.get_config_as_dict() 15568664SAli.Saidi@ARM.com 15578664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 15588664SAli.Saidi@ARM.com port = self._port_refs.get(port_name, None) 15598664SAli.Saidi@ARM.com if port != None: 15609017Sandreas.hansson@arm.com # Represent each port with a dictionary containing the 15619017Sandreas.hansson@arm.com # prominent attributes 15629017Sandreas.hansson@arm.com d[port_name] = port.get_config_as_dict() 15638664SAli.Saidi@ARM.com 15648664SAli.Saidi@ARM.com return d 15658664SAli.Saidi@ARM.com 15664762Snate@binkert.org def getCCParams(self): 15674762Snate@binkert.org if self._ccParams: 15684762Snate@binkert.org return self._ccParams 15694762Snate@binkert.org 15707677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 15714762Snate@binkert.org cc_params = cc_params_struct() 15724762Snate@binkert.org cc_params.name = str(self) 15734762Snate@binkert.org 157413709Sandreas.sandberg@arm.com param_names = list(self._params.keys()) 15754762Snate@binkert.org param_names.sort() 15764762Snate@binkert.org for param in param_names: 15774762Snate@binkert.org value = self._values.get(param) 15784762Snate@binkert.org if value is None: 15796654Snate@binkert.org fatal("%s.%s without default or user set value", 15806654Snate@binkert.org self.path(), param) 15814762Snate@binkert.org 15824762Snate@binkert.org value = value.getValue() 15834762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 15844762Snate@binkert.org assert isinstance(value, list) 15854762Snate@binkert.org vec = getattr(cc_params, param) 15864762Snate@binkert.org assert not len(vec) 158712035Sandreas.sandberg@arm.com # Some types are exposed as opaque types. They support 158812035Sandreas.sandberg@arm.com # the append operation unlike the automatically 158912035Sandreas.sandberg@arm.com # wrapped types. 159012035Sandreas.sandberg@arm.com if isinstance(vec, list): 159112035Sandreas.sandberg@arm.com setattr(cc_params, param, list(value)) 159212035Sandreas.sandberg@arm.com else: 159312035Sandreas.sandberg@arm.com for v in value: 159412035Sandreas.sandberg@arm.com getattr(cc_params, param).append(v) 15954762Snate@binkert.org else: 15964762Snate@binkert.org setattr(cc_params, param, value) 15974762Snate@binkert.org 159813709Sandreas.sandberg@arm.com port_names = list(self._ports.keys()) 15994762Snate@binkert.org port_names.sort() 16004762Snate@binkert.org for port_name in port_names: 16014762Snate@binkert.org port = self._port_refs.get(port_name, None) 16028912Sandreas.hansson@arm.com if port != None: 16038912Sandreas.hansson@arm.com port_count = len(port) 16048912Sandreas.hansson@arm.com else: 16058912Sandreas.hansson@arm.com port_count = 0 16068900Sandreas.hansson@arm.com setattr(cc_params, 'port_' + port_name + '_connection_count', 16078912Sandreas.hansson@arm.com port_count) 16084762Snate@binkert.org self._ccParams = cc_params 16094762Snate@binkert.org return self._ccParams 16102738SN/A 16112740SN/A # Get C++ object corresponding to this object, calling C++ if 16122740SN/A # necessary to construct it. Does *not* recursively create 16132740SN/A # children. 16142740SN/A def getCCObject(self): 16152740SN/A if not self._ccObject: 16167526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 16177526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 161813663Sandreas.sandberg@arm.com raise RuntimeError("Attempt to instantiate orphan node") 16197526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 16205244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 16215244Sgblack@eecs.umich.edu self._ccObject = -1 162210267SGeoffrey.Blake@arm.com if not self.abstract: 162310267SGeoffrey.Blake@arm.com params = self.getCCParams() 162410267SGeoffrey.Blake@arm.com self._ccObject = params.create() 16252740SN/A elif self._ccObject == -1: 162613663Sandreas.sandberg@arm.com raise RuntimeError("%s: Cycle found in configuration hierarchy." \ 162713663Sandreas.sandberg@arm.com % self.path()) 16282740SN/A return self._ccObject 16292740SN/A 16307527Ssteve.reinhardt@amd.com def descendants(self): 16317527Ssteve.reinhardt@amd.com yield self 163210532Sandreas.hansson@arm.com # The order of the dict is implementation dependent, so sort 163310532Sandreas.hansson@arm.com # it based on the key (name) to ensure the order is the same 163410532Sandreas.hansson@arm.com # on all hosts 163513709Sandreas.sandberg@arm.com for (name, child) in sorted(self._children.items()): 16367527Ssteve.reinhardt@amd.com for obj in child.descendants(): 16377527Ssteve.reinhardt@amd.com yield obj 16387527Ssteve.reinhardt@amd.com 16397527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 16404762Snate@binkert.org def createCCObject(self): 16414762Snate@binkert.org self.getCCParams() 16424762Snate@binkert.org self.getCCObject() # force creation 16434762Snate@binkert.org 16444762Snate@binkert.org def getValue(self): 16454762Snate@binkert.org return self.getCCObject() 16464762Snate@binkert.org 164713781Sgabeblack@google.com @cxxMethod(return_value_policy="reference") 164813781Sgabeblack@google.com def getPort(self, if_name, idx): 164913781Sgabeblack@google.com pass 165013781Sgabeblack@google.com 16512738SN/A # Create C++ port connections corresponding to the connections in 16527527Ssteve.reinhardt@amd.com # _port_refs 16532738SN/A def connectPorts(self): 165410532Sandreas.hansson@arm.com # Sort the ports based on their attribute name to ensure the 165510532Sandreas.hansson@arm.com # order is the same on all hosts 165613709Sandreas.sandberg@arm.com for (attr, portRef) in sorted(self._port_refs.items()): 16573105Sstever@eecs.umich.edu portRef.ccConnect() 16582797SN/A 165912469Sglenn.bergmans@arm.com # Default function for generating the device structure. 166012469Sglenn.bergmans@arm.com # Can be overloaded by the inheriting class 166112469Sglenn.bergmans@arm.com def generateDeviceTree(self, state): 166212469Sglenn.bergmans@arm.com return # return without yielding anything 166312469Sglenn.bergmans@arm.com yield # make this function a (null) generator 166412469Sglenn.bergmans@arm.com 166512469Sglenn.bergmans@arm.com def recurseDeviceTree(self, state): 166613709Sandreas.sandberg@arm.com for child in self._children.values(): 166712469Sglenn.bergmans@arm.com for item in child: # For looping over SimObjectVectors 166812786Sandreas.sandberg@arm.com for dt in item.generateDeviceTree(state): 166912786Sandreas.sandberg@arm.com yield dt 167012469Sglenn.bergmans@arm.com 167113356Sciro.santilli@arm.com # On a separate method otherwise certain buggy Python versions 167213356Sciro.santilli@arm.com # would fail with: SyntaxError: unqualified exec is not allowed 167313356Sciro.santilli@arm.com # in function 'apply_config' 167413356Sciro.santilli@arm.com def _apply_config_get_dict(self): 167513356Sciro.santilli@arm.com return { 167613356Sciro.santilli@arm.com child_name: SimObjectCliWrapper( 167713356Sciro.santilli@arm.com iter(self._children[child_name])) 167813356Sciro.santilli@arm.com for child_name in self._children 167913356Sciro.santilli@arm.com } 168013356Sciro.santilli@arm.com 168113356Sciro.santilli@arm.com def apply_config(self, params): 168213356Sciro.santilli@arm.com """ 168313356Sciro.santilli@arm.com exec a list of Python code strings contained in params. 168413356Sciro.santilli@arm.com 168513356Sciro.santilli@arm.com The only exposed globals to those strings are the child 168613356Sciro.santilli@arm.com SimObjects of this node. 168713356Sciro.santilli@arm.com 168813356Sciro.santilli@arm.com This function is intended to allow users to modify SimObject 168913356Sciro.santilli@arm.com parameters from the command line with Python statements. 169013356Sciro.santilli@arm.com """ 169113356Sciro.santilli@arm.com d = self._apply_config_get_dict() 169213356Sciro.santilli@arm.com for param in params: 169313356Sciro.santilli@arm.com exec(param, d) 169413356Sciro.santilli@arm.com 16953101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 16963101Sstever@eecs.umich.edudef resolveSimObject(name): 16973101Sstever@eecs.umich.edu obj = instanceDict[name] 16983101Sstever@eecs.umich.edu return obj.getCCObject() 1699679SN/A 17006654Snate@binkert.orgdef isSimObject(value): 17016654Snate@binkert.org return isinstance(value, SimObject) 17026654Snate@binkert.org 17036654Snate@binkert.orgdef isSimObjectClass(value): 17046654Snate@binkert.org return issubclass(value, SimObject) 17056654Snate@binkert.org 17067528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 17077528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 17087528Ssteve.reinhardt@amd.com 17096654Snate@binkert.orgdef isSimObjectSequence(value): 17106654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 17116654Snate@binkert.org return False 17126654Snate@binkert.org 17136654Snate@binkert.org for val in value: 17146654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 17156654Snate@binkert.org return False 17166654Snate@binkert.org 17176654Snate@binkert.org return True 17186654Snate@binkert.org 17196654Snate@binkert.orgdef isSimObjectOrSequence(value): 17206654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 17216654Snate@binkert.org 17227526Ssteve.reinhardt@amd.comdef isRoot(obj): 17237526Ssteve.reinhardt@amd.com from m5.objects import Root 17247526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 17257526Ssteve.reinhardt@amd.com 17267528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 17277528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 17287528Ssteve.reinhardt@amd.com 17297528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 17307528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 17317528Ssteve.reinhardt@amd.com return value 17327528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 17337528Ssteve.reinhardt@amd.com return SimObjectVector(value) 17347528Ssteve.reinhardt@amd.com return None 17357528Ssteve.reinhardt@amd.com 17367528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 17377528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 17387528Ssteve.reinhardt@amd.com if value is None: 173913663Sandreas.sandberg@arm.com raise TypeError("SimObject or SimObjectVector expected") 17407528Ssteve.reinhardt@amd.com return value 17417528Ssteve.reinhardt@amd.com 17426654Snate@binkert.orgbaseClasses = allClasses.copy() 17436654Snate@binkert.orgbaseInstances = instanceDict.copy() 17446654Snate@binkert.org 17456654Snate@binkert.orgdef clear(): 17469338SAndreas.Sandberg@arm.com global allClasses, instanceDict, noCxxHeader 17476654Snate@binkert.org 17486654Snate@binkert.org allClasses = baseClasses.copy() 17496654Snate@binkert.org instanceDict = baseInstances.copy() 17509338SAndreas.Sandberg@arm.com noCxxHeader = False 17516654Snate@binkert.org 17521528SN/A# __all__ defines the list of symbols that get exported when 17531528SN/A# 'from config import *' is invoked. Try to keep this reasonably 17541528SN/A# short to avoid polluting other namespaces. 175511988Sandreas.sandberg@arm.com__all__ = [ 175611988Sandreas.sandberg@arm.com 'SimObject', 175711988Sandreas.sandberg@arm.com 'cxxMethod', 175811988Sandreas.sandberg@arm.com 'PyBindMethod', 175911988Sandreas.sandberg@arm.com 'PyBindProperty', 176011988Sandreas.sandberg@arm.com] 1761