SimObject.py revision 11988
111988Sandreas.sandberg@arm.com# Copyright (c) 2017 ARM Limited 28840Sandreas.hansson@arm.com# All rights reserved. 38840Sandreas.hansson@arm.com# 48840Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 58840Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 68840Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 78840Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 88840Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 98840Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 108840Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 118840Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 128840Sandreas.hansson@arm.com# 132740SN/A# Copyright (c) 2004-2006 The Regents of The University of Michigan 149983Sstever@gmail.com# Copyright (c) 2010-20013 Advanced Micro Devices, Inc. 159983Sstever@gmail.com# Copyright (c) 2013 Mark D. Hill and David A. Wood 161046SN/A# All rights reserved. 171046SN/A# 181046SN/A# Redistribution and use in source and binary forms, with or without 191046SN/A# modification, are permitted provided that the following conditions are 201046SN/A# met: redistributions of source code must retain the above copyright 211046SN/A# notice, this list of conditions and the following disclaimer; 221046SN/A# redistributions in binary form must reproduce the above copyright 231046SN/A# notice, this list of conditions and the following disclaimer in the 241046SN/A# documentation and/or other materials provided with the distribution; 251046SN/A# neither the name of the copyright holders nor the names of its 261046SN/A# contributors may be used to endorse or promote products derived from 271046SN/A# this software without specific prior written permission. 281046SN/A# 291046SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 301046SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 311046SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 321046SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 331046SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 341046SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 351046SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 361046SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 371046SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 381046SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 391046SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 402665SN/A# 412665SN/A# Authors: Steve Reinhardt 422665SN/A# Nathan Binkert 438840Sandreas.hansson@arm.com# Andreas Hansson 4411988Sandreas.sandberg@arm.com# Andreas Sandberg 451046SN/A 465766Snate@binkert.orgimport sys 478331Ssteve.reinhardt@amd.comfrom types import FunctionType, MethodType, ModuleType 4811988Sandreas.sandberg@arm.comfrom functools import wraps 4911988Sandreas.sandberg@arm.comimport inspect 501438SN/A 514762Snate@binkert.orgimport m5 526654Snate@binkert.orgfrom m5.util import * 5311988Sandreas.sandberg@arm.comfrom m5.util.pybind import * 543102Sstever@eecs.umich.edu 553102Sstever@eecs.umich.edu# Have to import params up top since Param is referenced on initial 563102Sstever@eecs.umich.edu# load (when SimObject class references Param to create a class 573102Sstever@eecs.umich.edu# variable, the 'name' param)... 586654Snate@binkert.orgfrom m5.params import * 593102Sstever@eecs.umich.edu# There are a few things we need that aren't in params.__all__ since 603102Sstever@eecs.umich.edu# normal users don't need them 617528Ssteve.reinhardt@amd.comfrom m5.params import ParamDesc, VectorParamDesc, \ 628839Sandreas.hansson@arm.com isNullPointer, SimObjectVector, Port 633102Sstever@eecs.umich.edu 646654Snate@binkert.orgfrom m5.proxy import * 656654Snate@binkert.orgfrom m5.proxy import isproxy 66679SN/A 67679SN/A##################################################################### 68679SN/A# 69679SN/A# M5 Python Configuration Utility 70679SN/A# 71679SN/A# The basic idea is to write simple Python programs that build Python 721692SN/A# objects corresponding to M5 SimObjects for the desired simulation 73679SN/A# configuration. For now, the Python emits a .ini file that can be 74679SN/A# parsed by M5. In the future, some tighter integration between M5 75679SN/A# and the Python interpreter may allow bypassing the .ini file. 76679SN/A# 77679SN/A# Each SimObject class in M5 is represented by a Python class with the 78679SN/A# same name. The Python inheritance tree mirrors the M5 C++ tree 79679SN/A# (e.g., SimpleCPU derives from BaseCPU in both cases, and all 80679SN/A# SimObjects inherit from a single SimObject base class). To specify 81679SN/A# an instance of an M5 SimObject in a configuration, the user simply 82679SN/A# instantiates the corresponding Python object. The parameters for 83679SN/A# that SimObject are given by assigning to attributes of the Python 84679SN/A# object, either using keyword assignment in the constructor or in 85679SN/A# separate assignment statements. For example: 86679SN/A# 871692SN/A# cache = BaseCache(size='64KB') 88679SN/A# cache.hit_latency = 3 89679SN/A# cache.assoc = 8 90679SN/A# 91679SN/A# The magic lies in the mapping of the Python attributes for SimObject 92679SN/A# classes to the actual SimObject parameter specifications. This 93679SN/A# allows parameter validity checking in the Python code. Continuing 94679SN/A# the example above, the statements "cache.blurfl=3" or 95679SN/A# "cache.assoc='hello'" would both result in runtime errors in Python, 96679SN/A# since the BaseCache object has no 'blurfl' parameter and the 'assoc' 97679SN/A# parameter requires an integer, respectively. This magic is done 98679SN/A# primarily by overriding the special __setattr__ method that controls 99679SN/A# assignment to object attributes. 100679SN/A# 101679SN/A# Once a set of Python objects have been instantiated in a hierarchy, 102679SN/A# calling 'instantiate(obj)' (where obj is the root of the hierarchy) 1032740SN/A# will generate a .ini file. 104679SN/A# 105679SN/A##################################################################### 106679SN/A 1074762Snate@binkert.org# list of all SimObject classes 1084762Snate@binkert.orgallClasses = {} 1094762Snate@binkert.org 1102738SN/A# dict to look up SimObjects based on path 1112738SN/AinstanceDict = {} 1122738SN/A 1139338SAndreas.Sandberg@arm.com# Did any of the SimObjects lack a header file? 1149338SAndreas.Sandberg@arm.comnoCxxHeader = False 1159338SAndreas.Sandberg@arm.com 1167673Snate@binkert.orgdef public_value(key, value): 1177673Snate@binkert.org return key.startswith('_') or \ 1188331Ssteve.reinhardt@amd.com isinstance(value, (FunctionType, MethodType, ModuleType, 1198331Ssteve.reinhardt@amd.com classmethod, type)) 1207673Snate@binkert.org 12110458Sandreas.hansson@arm.comdef createCxxConfigDirectoryEntryFile(code, name, simobj, is_header): 12210458Sandreas.hansson@arm.com entry_class = 'CxxConfigDirectoryEntry_%s' % name 12310458Sandreas.hansson@arm.com param_class = '%sCxxConfigParams' % name 12410458Sandreas.hansson@arm.com 12510458Sandreas.hansson@arm.com code('#include "params/%s.hh"' % name) 12610458Sandreas.hansson@arm.com 12710458Sandreas.hansson@arm.com if not is_header: 12810458Sandreas.hansson@arm.com for param in simobj._params.values(): 12910458Sandreas.hansson@arm.com if isSimObjectClass(param.ptype): 13010458Sandreas.hansson@arm.com code('#include "%s"' % param.ptype._value_dict['cxx_header']) 13110458Sandreas.hansson@arm.com code('#include "params/%s.hh"' % param.ptype.__name__) 13210458Sandreas.hansson@arm.com else: 13310458Sandreas.hansson@arm.com param.ptype.cxx_ini_predecls(code) 13410458Sandreas.hansson@arm.com 13510458Sandreas.hansson@arm.com if is_header: 13610458Sandreas.hansson@arm.com member_prefix = '' 13710458Sandreas.hansson@arm.com end_of_decl = ';' 13810458Sandreas.hansson@arm.com code('#include "sim/cxx_config.hh"') 13910458Sandreas.hansson@arm.com code() 14010458Sandreas.hansson@arm.com code('class ${param_class} : public CxxConfigParams,' 14110458Sandreas.hansson@arm.com ' public ${name}Params') 14210458Sandreas.hansson@arm.com code('{') 14310458Sandreas.hansson@arm.com code(' private:') 14410458Sandreas.hansson@arm.com code.indent() 14510458Sandreas.hansson@arm.com code('class DirectoryEntry : public CxxConfigDirectoryEntry') 14610458Sandreas.hansson@arm.com code('{') 14710458Sandreas.hansson@arm.com code(' public:') 14810458Sandreas.hansson@arm.com code.indent() 14910458Sandreas.hansson@arm.com code('DirectoryEntry();'); 15010458Sandreas.hansson@arm.com code() 15110458Sandreas.hansson@arm.com code('CxxConfigParams *makeParamsObject() const') 15210458Sandreas.hansson@arm.com code('{ return new ${param_class}; }') 15310458Sandreas.hansson@arm.com code.dedent() 15410458Sandreas.hansson@arm.com code('};') 15510458Sandreas.hansson@arm.com code() 15610458Sandreas.hansson@arm.com code.dedent() 15710458Sandreas.hansson@arm.com code(' public:') 15810458Sandreas.hansson@arm.com code.indent() 15910458Sandreas.hansson@arm.com else: 16010458Sandreas.hansson@arm.com member_prefix = '%s::' % param_class 16110458Sandreas.hansson@arm.com end_of_decl = '' 16210458Sandreas.hansson@arm.com code('#include "%s"' % simobj._value_dict['cxx_header']) 16310458Sandreas.hansson@arm.com code('#include "base/str.hh"') 16410458Sandreas.hansson@arm.com code('#include "cxx_config/${name}.hh"') 16510458Sandreas.hansson@arm.com 16610458Sandreas.hansson@arm.com if simobj._ports.values() != []: 16710458Sandreas.hansson@arm.com code('#include "mem/mem_object.hh"') 16810458Sandreas.hansson@arm.com code('#include "mem/port.hh"') 16910458Sandreas.hansson@arm.com 17010458Sandreas.hansson@arm.com code() 17110458Sandreas.hansson@arm.com code('${member_prefix}DirectoryEntry::DirectoryEntry()'); 17210458Sandreas.hansson@arm.com code('{') 17310458Sandreas.hansson@arm.com 17410458Sandreas.hansson@arm.com def cxx_bool(b): 17510458Sandreas.hansson@arm.com return 'true' if b else 'false' 17610458Sandreas.hansson@arm.com 17710458Sandreas.hansson@arm.com code.indent() 17810458Sandreas.hansson@arm.com for param in simobj._params.values(): 17910458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 18010458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 18110458Sandreas.hansson@arm.com 18210458Sandreas.hansson@arm.com code('parameters["%s"] = new ParamDesc("%s", %s, %s);' % 18310458Sandreas.hansson@arm.com (param.name, param.name, cxx_bool(is_vector), 18410458Sandreas.hansson@arm.com cxx_bool(is_simobj))); 18510458Sandreas.hansson@arm.com 18610458Sandreas.hansson@arm.com for port in simobj._ports.values(): 18710458Sandreas.hansson@arm.com is_vector = isinstance(port, m5.params.VectorPort) 18810458Sandreas.hansson@arm.com is_master = port.role == 'MASTER' 18910458Sandreas.hansson@arm.com 19010458Sandreas.hansson@arm.com code('ports["%s"] = new PortDesc("%s", %s, %s);' % 19110458Sandreas.hansson@arm.com (port.name, port.name, cxx_bool(is_vector), 19210458Sandreas.hansson@arm.com cxx_bool(is_master))) 19310458Sandreas.hansson@arm.com 19410458Sandreas.hansson@arm.com code.dedent() 19510458Sandreas.hansson@arm.com code('}') 19610458Sandreas.hansson@arm.com code() 19710458Sandreas.hansson@arm.com 19810458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObject(const std::string &name,') 19910458Sandreas.hansson@arm.com code(' SimObject *simObject)${end_of_decl}') 20010458Sandreas.hansson@arm.com 20110458Sandreas.hansson@arm.com if not is_header: 20210458Sandreas.hansson@arm.com code('{') 20310458Sandreas.hansson@arm.com code.indent() 20410458Sandreas.hansson@arm.com code('bool ret = true;') 20510458Sandreas.hansson@arm.com code() 20610458Sandreas.hansson@arm.com code('if (false) {') 20710458Sandreas.hansson@arm.com for param in simobj._params.values(): 20810458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 20910458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 21010458Sandreas.hansson@arm.com 21110458Sandreas.hansson@arm.com if is_simobj and not is_vector: 21210458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 21310458Sandreas.hansson@arm.com code.indent() 21410458Sandreas.hansson@arm.com code('this->${{param.name}} = ' 21510458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(simObject);') 21610458Sandreas.hansson@arm.com code('if (simObject && !this->${{param.name}})') 21710458Sandreas.hansson@arm.com code(' ret = false;') 21810458Sandreas.hansson@arm.com code.dedent() 21910458Sandreas.hansson@arm.com code('} else {') 22010458Sandreas.hansson@arm.com code(' ret = false;') 22110458Sandreas.hansson@arm.com code('}') 22210458Sandreas.hansson@arm.com code() 22310458Sandreas.hansson@arm.com code('return ret;') 22410458Sandreas.hansson@arm.com code.dedent() 22510458Sandreas.hansson@arm.com code('}') 22610458Sandreas.hansson@arm.com 22710458Sandreas.hansson@arm.com code() 22810458Sandreas.hansson@arm.com code('bool ${member_prefix}setSimObjectVector(' 22910458Sandreas.hansson@arm.com 'const std::string &name,') 23010458Sandreas.hansson@arm.com code(' const std::vector<SimObject *> &simObjects)${end_of_decl}') 23110458Sandreas.hansson@arm.com 23210458Sandreas.hansson@arm.com if not is_header: 23310458Sandreas.hansson@arm.com code('{') 23410458Sandreas.hansson@arm.com code.indent() 23510458Sandreas.hansson@arm.com code('bool ret = true;') 23610458Sandreas.hansson@arm.com code() 23710458Sandreas.hansson@arm.com code('if (false) {') 23810458Sandreas.hansson@arm.com for param in simobj._params.values(): 23910458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 24010458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 24110458Sandreas.hansson@arm.com 24210458Sandreas.hansson@arm.com if is_simobj and is_vector: 24310458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 24410458Sandreas.hansson@arm.com code.indent() 24510458Sandreas.hansson@arm.com code('this->${{param.name}}.clear();') 24610458Sandreas.hansson@arm.com code('for (auto i = simObjects.begin(); ' 24710458Sandreas.hansson@arm.com 'ret && i != simObjects.end(); i ++)') 24810458Sandreas.hansson@arm.com code('{') 24910458Sandreas.hansson@arm.com code.indent() 25010458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} object = ' 25110458Sandreas.hansson@arm.com 'dynamic_cast<${{param.ptype.cxx_type}}>(*i);') 25210458Sandreas.hansson@arm.com code('if (*i && !object)') 25310458Sandreas.hansson@arm.com code(' ret = false;') 25410458Sandreas.hansson@arm.com code('else') 25510458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(object);') 25610458Sandreas.hansson@arm.com code.dedent() 25710458Sandreas.hansson@arm.com code('}') 25810458Sandreas.hansson@arm.com code.dedent() 25910458Sandreas.hansson@arm.com code('} else {') 26010458Sandreas.hansson@arm.com code(' ret = false;') 26110458Sandreas.hansson@arm.com code('}') 26210458Sandreas.hansson@arm.com code() 26310458Sandreas.hansson@arm.com code('return ret;') 26410458Sandreas.hansson@arm.com code.dedent() 26510458Sandreas.hansson@arm.com code('}') 26610458Sandreas.hansson@arm.com 26710458Sandreas.hansson@arm.com code() 26810458Sandreas.hansson@arm.com code('void ${member_prefix}setName(const std::string &name_)' 26910458Sandreas.hansson@arm.com '${end_of_decl}') 27010458Sandreas.hansson@arm.com 27110458Sandreas.hansson@arm.com if not is_header: 27210458Sandreas.hansson@arm.com code('{') 27310458Sandreas.hansson@arm.com code.indent() 27410458Sandreas.hansson@arm.com code('this->name = name_;') 27510458Sandreas.hansson@arm.com code.dedent() 27610458Sandreas.hansson@arm.com code('}') 27710458Sandreas.hansson@arm.com 27810458Sandreas.hansson@arm.com if is_header: 27910458Sandreas.hansson@arm.com code('const std::string &${member_prefix}getName()') 28010458Sandreas.hansson@arm.com code('{ return this->name; }') 28110458Sandreas.hansson@arm.com 28210458Sandreas.hansson@arm.com code() 28310458Sandreas.hansson@arm.com code('bool ${member_prefix}setParam(const std::string &name,') 28410458Sandreas.hansson@arm.com code(' const std::string &value, const Flags flags)${end_of_decl}') 28510458Sandreas.hansson@arm.com 28610458Sandreas.hansson@arm.com if not is_header: 28710458Sandreas.hansson@arm.com code('{') 28810458Sandreas.hansson@arm.com code.indent() 28910458Sandreas.hansson@arm.com code('bool ret = true;') 29010458Sandreas.hansson@arm.com code() 29110458Sandreas.hansson@arm.com code('if (false) {') 29210458Sandreas.hansson@arm.com for param in simobj._params.values(): 29310458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 29410458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 29510458Sandreas.hansson@arm.com 29610458Sandreas.hansson@arm.com if not is_simobj and not is_vector: 29710458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 29810458Sandreas.hansson@arm.com code.indent() 29910458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 30010458Sandreas.hansson@arm.com 'value', 'this->%s' % param.name, 'ret =') 30110458Sandreas.hansson@arm.com code.dedent() 30210458Sandreas.hansson@arm.com code('} else {') 30310458Sandreas.hansson@arm.com code(' ret = false;') 30410458Sandreas.hansson@arm.com code('}') 30510458Sandreas.hansson@arm.com code() 30610458Sandreas.hansson@arm.com code('return ret;') 30710458Sandreas.hansson@arm.com code.dedent() 30810458Sandreas.hansson@arm.com code('}') 30910458Sandreas.hansson@arm.com 31010458Sandreas.hansson@arm.com code() 31110458Sandreas.hansson@arm.com code('bool ${member_prefix}setParamVector(' 31210458Sandreas.hansson@arm.com 'const std::string &name,') 31310458Sandreas.hansson@arm.com code(' const std::vector<std::string> &values,') 31410458Sandreas.hansson@arm.com code(' const Flags flags)${end_of_decl}') 31510458Sandreas.hansson@arm.com 31610458Sandreas.hansson@arm.com if not is_header: 31710458Sandreas.hansson@arm.com code('{') 31810458Sandreas.hansson@arm.com code.indent() 31910458Sandreas.hansson@arm.com code('bool ret = true;') 32010458Sandreas.hansson@arm.com code() 32110458Sandreas.hansson@arm.com code('if (false) {') 32210458Sandreas.hansson@arm.com for param in simobj._params.values(): 32310458Sandreas.hansson@arm.com is_vector = isinstance(param, m5.params.VectorParamDesc) 32410458Sandreas.hansson@arm.com is_simobj = issubclass(param.ptype, m5.SimObject.SimObject) 32510458Sandreas.hansson@arm.com 32610458Sandreas.hansson@arm.com if not is_simobj and is_vector: 32710458Sandreas.hansson@arm.com code('} else if (name == "${{param.name}}") {') 32810458Sandreas.hansson@arm.com code.indent() 32910458Sandreas.hansson@arm.com code('${{param.name}}.clear();') 33010458Sandreas.hansson@arm.com code('for (auto i = values.begin(); ' 33110458Sandreas.hansson@arm.com 'ret && i != values.end(); i ++)') 33210458Sandreas.hansson@arm.com code('{') 33310458Sandreas.hansson@arm.com code.indent() 33410458Sandreas.hansson@arm.com code('${{param.ptype.cxx_type}} elem;') 33510458Sandreas.hansson@arm.com param.ptype.cxx_ini_parse(code, 33610458Sandreas.hansson@arm.com '*i', 'elem', 'ret =') 33710458Sandreas.hansson@arm.com code('if (ret)') 33810458Sandreas.hansson@arm.com code(' this->${{param.name}}.push_back(elem);') 33910458Sandreas.hansson@arm.com code.dedent() 34010458Sandreas.hansson@arm.com code('}') 34110458Sandreas.hansson@arm.com code.dedent() 34210458Sandreas.hansson@arm.com code('} else {') 34310458Sandreas.hansson@arm.com code(' ret = false;') 34410458Sandreas.hansson@arm.com code('}') 34510458Sandreas.hansson@arm.com code() 34610458Sandreas.hansson@arm.com code('return ret;') 34710458Sandreas.hansson@arm.com code.dedent() 34810458Sandreas.hansson@arm.com code('}') 34910458Sandreas.hansson@arm.com 35010458Sandreas.hansson@arm.com code() 35110458Sandreas.hansson@arm.com code('bool ${member_prefix}setPortConnectionCount(' 35210458Sandreas.hansson@arm.com 'const std::string &name,') 35310458Sandreas.hansson@arm.com code(' unsigned int count)${end_of_decl}') 35410458Sandreas.hansson@arm.com 35510458Sandreas.hansson@arm.com if not is_header: 35610458Sandreas.hansson@arm.com code('{') 35710458Sandreas.hansson@arm.com code.indent() 35810458Sandreas.hansson@arm.com code('bool ret = true;') 35910458Sandreas.hansson@arm.com code() 36010458Sandreas.hansson@arm.com code('if (false)') 36110458Sandreas.hansson@arm.com code(' ;') 36210458Sandreas.hansson@arm.com for port in simobj._ports.values(): 36310458Sandreas.hansson@arm.com code('else if (name == "${{port.name}}")') 36410458Sandreas.hansson@arm.com code(' this->port_${{port.name}}_connection_count = count;') 36510458Sandreas.hansson@arm.com code('else') 36610458Sandreas.hansson@arm.com code(' ret = false;') 36710458Sandreas.hansson@arm.com code() 36810458Sandreas.hansson@arm.com code('return ret;') 36910458Sandreas.hansson@arm.com code.dedent() 37010458Sandreas.hansson@arm.com code('}') 37110458Sandreas.hansson@arm.com 37210458Sandreas.hansson@arm.com code() 37310458Sandreas.hansson@arm.com code('SimObject *${member_prefix}simObjectCreate()${end_of_decl}') 37410458Sandreas.hansson@arm.com 37510458Sandreas.hansson@arm.com if not is_header: 37610458Sandreas.hansson@arm.com code('{') 37710458Sandreas.hansson@arm.com if hasattr(simobj, 'abstract') and simobj.abstract: 37810458Sandreas.hansson@arm.com code(' return NULL;') 37910458Sandreas.hansson@arm.com else: 38010458Sandreas.hansson@arm.com code(' return this->create();') 38110458Sandreas.hansson@arm.com code('}') 38210458Sandreas.hansson@arm.com 38310458Sandreas.hansson@arm.com if is_header: 38410458Sandreas.hansson@arm.com code() 38510458Sandreas.hansson@arm.com code('static CxxConfigDirectoryEntry' 38610458Sandreas.hansson@arm.com ' *${member_prefix}makeDirectoryEntry()') 38710458Sandreas.hansson@arm.com code('{ return new DirectoryEntry; }') 38810458Sandreas.hansson@arm.com 38910458Sandreas.hansson@arm.com if is_header: 39010458Sandreas.hansson@arm.com code.dedent() 39110458Sandreas.hansson@arm.com code('};') 39210458Sandreas.hansson@arm.com 3932740SN/A# The metaclass for SimObject. This class controls how new classes 3942740SN/A# that derive from SimObject are instantiated, and provides inherited 3952740SN/A# class behavior (just like a class controls how instances of that 3962740SN/A# class are instantiated, and provides inherited instance behavior). 3971692SN/Aclass MetaSimObject(type): 3981427SN/A # Attributes that can be set only at initialization time 39911988Sandreas.sandberg@arm.com init_keywords = { 40011988Sandreas.sandberg@arm.com 'abstract' : bool, 40111988Sandreas.sandberg@arm.com 'cxx_class' : str, 40211988Sandreas.sandberg@arm.com 'cxx_type' : str, 40311988Sandreas.sandberg@arm.com 'cxx_header' : str, 40411988Sandreas.sandberg@arm.com 'type' : str, 40511988Sandreas.sandberg@arm.com 'cxx_bases' : list, 40611988Sandreas.sandberg@arm.com 'cxx_exports' : list, 40711988Sandreas.sandberg@arm.com 'cxx_param_exports' : list, 40811988Sandreas.sandberg@arm.com } 4091427SN/A # Attributes that can be set any time 4107493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 411679SN/A 412679SN/A # __new__ is called before __init__, and is where the statements 413679SN/A # in the body of the class definition get loaded into the class's 4142740SN/A # __dict__. We intercept this to filter out parameter & port assignments 415679SN/A # and only allow "private" attributes to be passed to the base 416679SN/A # __new__ (starting with underscore). 4171310SN/A def __new__(mcls, name, bases, dict): 4186654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 4194762Snate@binkert.org 4202740SN/A # Copy "private" attributes, functions, and classes to the 4212740SN/A # official dict. Everything else goes in _init_dict to be 4222740SN/A # filtered in __init__. 4232740SN/A cls_dict = {} 4242740SN/A value_dict = {} 42511988Sandreas.sandberg@arm.com cxx_exports = [] 4262740SN/A for key,val in dict.items(): 42711988Sandreas.sandberg@arm.com try: 42811988Sandreas.sandberg@arm.com cxx_exports.append(getattr(val, "__pybind")) 42911988Sandreas.sandberg@arm.com except AttributeError: 43011988Sandreas.sandberg@arm.com pass 43111988Sandreas.sandberg@arm.com 4327673Snate@binkert.org if public_value(key, val): 4332740SN/A cls_dict[key] = val 4342740SN/A else: 4352740SN/A # must be a param/port setting 4362740SN/A value_dict[key] = val 4374762Snate@binkert.org if 'abstract' not in value_dict: 4384762Snate@binkert.org value_dict['abstract'] = False 4399342SAndreas.Sandberg@arm.com if 'cxx_bases' not in value_dict: 4409342SAndreas.Sandberg@arm.com value_dict['cxx_bases'] = [] 44111988Sandreas.sandberg@arm.com if 'cxx_exports' not in value_dict: 44211988Sandreas.sandberg@arm.com value_dict['cxx_exports'] = cxx_exports 44311988Sandreas.sandberg@arm.com else: 44411988Sandreas.sandberg@arm.com value_dict['cxx_exports'] += cxx_exports 44511988Sandreas.sandberg@arm.com if 'cxx_param_exports' not in value_dict: 44611988Sandreas.sandberg@arm.com value_dict['cxx_param_exports'] = [] 4472740SN/A cls_dict['_value_dict'] = value_dict 4484762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 4494762Snate@binkert.org if 'type' in value_dict: 4504762Snate@binkert.org allClasses[name] = cls 4514762Snate@binkert.org return cls 452679SN/A 4532711SN/A # subclass initialization 454679SN/A def __init__(cls, name, bases, dict): 4552711SN/A # calls type.__init__()... I think that's a no-op, but leave 4562711SN/A # it here just in case it's not. 4571692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 4581310SN/A 4591427SN/A # initialize required attributes 4602740SN/A 4612740SN/A # class-only attributes 4622740SN/A cls._params = multidict() # param descriptions 4632740SN/A cls._ports = multidict() # port descriptions 4642740SN/A 4652740SN/A # class or instance attributes 4662740SN/A cls._values = multidict() # param values 46710267SGeoffrey.Blake@arm.com cls._hr_values = multidict() # human readable param values 4687528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 4693105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 4702740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 4711310SN/A 4729100SBrad.Beckmann@amd.com # We don't support multiple inheritance of sim objects. If you want 4739100SBrad.Beckmann@amd.com # to, you must fix multidict to deal with it properly. Non sim-objects 4749100SBrad.Beckmann@amd.com # are ok, though 4759100SBrad.Beckmann@amd.com bTotal = 0 4769100SBrad.Beckmann@amd.com for c in bases: 4779100SBrad.Beckmann@amd.com if isinstance(c, MetaSimObject): 4789100SBrad.Beckmann@amd.com bTotal += 1 4799100SBrad.Beckmann@amd.com if bTotal > 1: 4809100SBrad.Beckmann@amd.com raise TypeError, "SimObjects do not support multiple inheritance" 4811692SN/A 4821692SN/A base = bases[0] 4831692SN/A 4842740SN/A # Set up general inheritance via multidicts. A subclass will 4852740SN/A # inherit all its settings from the base class. The only time 4862740SN/A # the following is not true is when we define the SimObject 4872740SN/A # class itself (in which case the multidicts have no parent). 4881692SN/A if isinstance(base, MetaSimObject): 4895610Snate@binkert.org cls._base = base 4901692SN/A cls._params.parent = base._params 4912740SN/A cls._ports.parent = base._ports 4921692SN/A cls._values.parent = base._values 49310267SGeoffrey.Blake@arm.com cls._hr_values.parent = base._hr_values 4947528Ssteve.reinhardt@amd.com cls._children.parent = base._children 4953105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 4962740SN/A # mark base as having been subclassed 4972712SN/A base._instantiated = True 4985610Snate@binkert.org else: 4995610Snate@binkert.org cls._base = None 5001692SN/A 5014762Snate@binkert.org # default keyword values 5024762Snate@binkert.org if 'type' in cls._value_dict: 5034762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 5045610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 5054762Snate@binkert.org 5065610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 5074859Snate@binkert.org 5089338SAndreas.Sandberg@arm.com if 'cxx_header' not in cls._value_dict: 5099338SAndreas.Sandberg@arm.com global noCxxHeader 5109338SAndreas.Sandberg@arm.com noCxxHeader = True 5119528Ssascha.bischoff@arm.com warn("No header file specified for SimObject: %s", name) 5129338SAndreas.Sandberg@arm.com 5138597Ssteve.reinhardt@amd.com # Export methods are automatically inherited via C++, so we 5148597Ssteve.reinhardt@amd.com # don't want the method declarations to get inherited on the 5158597Ssteve.reinhardt@amd.com # python side (and thus end up getting repeated in the wrapped 5168597Ssteve.reinhardt@amd.com # versions of derived classes). The code below basicallly 5178597Ssteve.reinhardt@amd.com # suppresses inheritance by substituting in the base (null) 5188597Ssteve.reinhardt@amd.com # versions of these methods unless a different version is 5198597Ssteve.reinhardt@amd.com # explicitly supplied. 52011787Sandreas.sandberg@arm.com for method_name in ('export_methods', 'export_method_swig_predecls'): 5218597Ssteve.reinhardt@amd.com if method_name not in cls.__dict__: 5228597Ssteve.reinhardt@amd.com base_method = getattr(MetaSimObject, method_name) 5238597Ssteve.reinhardt@amd.com m = MethodType(base_method, cls, MetaSimObject) 5248597Ssteve.reinhardt@amd.com setattr(cls, method_name, m) 5258597Ssteve.reinhardt@amd.com 5262740SN/A # Now process the _value_dict items. They could be defining 5272740SN/A # new (or overriding existing) parameters or ports, setting 5282740SN/A # class keywords (e.g., 'abstract'), or setting parameter 5292740SN/A # values or port bindings. The first 3 can only be set when 5302740SN/A # the class is defined, so we handle them here. The others 5312740SN/A # can be set later too, so just emulate that by calling 5322740SN/A # setattr(). 5332740SN/A for key,val in cls._value_dict.items(): 5341527SN/A # param descriptions 5352740SN/A if isinstance(val, ParamDesc): 5361585SN/A cls._new_param(key, val) 5371427SN/A 5382738SN/A # port objects 5392738SN/A elif isinstance(val, Port): 5403105Sstever@eecs.umich.edu cls._new_port(key, val) 5412738SN/A 5421427SN/A # init-time-only keywords 5431427SN/A elif cls.init_keywords.has_key(key): 5441427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 5451427SN/A 5461427SN/A # default: use normal path (ends up in __setattr__) 5471427SN/A else: 5481427SN/A setattr(cls, key, val) 5491427SN/A 5501427SN/A def _set_keyword(cls, keyword, val, kwtype): 5511427SN/A if not isinstance(val, kwtype): 5521427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 5531427SN/A (keyword, type(val), kwtype) 5547493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 5551427SN/A val = classmethod(val) 5561427SN/A type.__setattr__(cls, keyword, val) 5571427SN/A 5583100SN/A def _new_param(cls, name, pdesc): 5593100SN/A # each param desc should be uniquely assigned to one variable 5603100SN/A assert(not hasattr(pdesc, 'name')) 5613100SN/A pdesc.name = name 5623100SN/A cls._params[name] = pdesc 5633100SN/A if hasattr(pdesc, 'default'): 5643105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 5653105Sstever@eecs.umich.edu 5663105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 5673105Sstever@eecs.umich.edu assert(param.name == name) 5683105Sstever@eecs.umich.edu try: 56910267SGeoffrey.Blake@arm.com hr_value = value 5708321Ssteve.reinhardt@amd.com value = param.convert(value) 5713105Sstever@eecs.umich.edu except Exception, e: 5723105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 5733105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 5743105Sstever@eecs.umich.edu e.args = (msg, ) 5753105Sstever@eecs.umich.edu raise 5768321Ssteve.reinhardt@amd.com cls._values[name] = value 5778321Ssteve.reinhardt@amd.com # if param value is a SimObject, make it a child too, so that 5788321Ssteve.reinhardt@amd.com # it gets cloned properly when the class is instantiated 5798321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 5808321Ssteve.reinhardt@amd.com cls._add_cls_child(name, value) 58110267SGeoffrey.Blake@arm.com # update human-readable values of the param if it has a literal 58210267SGeoffrey.Blake@arm.com # value and is not an object or proxy. 58310267SGeoffrey.Blake@arm.com if not (isSimObjectOrVector(value) or\ 58410267SGeoffrey.Blake@arm.com isinstance(value, m5.proxy.BaseProxy)): 58510267SGeoffrey.Blake@arm.com cls._hr_values[name] = hr_value 5868321Ssteve.reinhardt@amd.com 5878321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 5888321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 5898321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 5908321Ssteve.reinhardt@amd.com # clears the parent pointer), and this makes it clear that the 5918321Ssteve.reinhardt@amd.com # object is not an orphan and can provide better error 5928321Ssteve.reinhardt@amd.com # messages. 5938321Ssteve.reinhardt@amd.com child.set_parent(cls, name) 5948321Ssteve.reinhardt@amd.com cls._children[name] = child 5953105Sstever@eecs.umich.edu 5963105Sstever@eecs.umich.edu def _new_port(cls, name, port): 5973105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 5983105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 5993105Sstever@eecs.umich.edu port.name = name 6003105Sstever@eecs.umich.edu cls._ports[name] = port 6013105Sstever@eecs.umich.edu 6023105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 6033105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 6043105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 6053105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 6063105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 6073105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 6083105Sstever@eecs.umich.edu if not ref: 6093105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 6103105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 6113105Sstever@eecs.umich.edu return ref 6121585SN/A 6131310SN/A # Set attribute (called on foo.attr = value when foo is an 6141310SN/A # instance of class cls). 6151310SN/A def __setattr__(cls, attr, value): 6161310SN/A # normal processing for private attributes 6177673Snate@binkert.org if public_value(attr, value): 6181310SN/A type.__setattr__(cls, attr, value) 6191310SN/A return 6201310SN/A 6211310SN/A if cls.keywords.has_key(attr): 6221427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 6231310SN/A return 6241310SN/A 6252738SN/A if cls._ports.has_key(attr): 6263105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 6272738SN/A return 6282738SN/A 6292740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 6302740SN/A raise RuntimeError, \ 6312740SN/A "cannot set SimObject parameter '%s' after\n" \ 6322740SN/A " class %s has been instantiated or subclassed" \ 6332740SN/A % (attr, cls.__name__) 6342740SN/A 6352740SN/A # check for param 6363105Sstever@eecs.umich.edu param = cls._params.get(attr) 6371310SN/A if param: 6383105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 6393105Sstever@eecs.umich.edu return 6403105Sstever@eecs.umich.edu 6413105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 6423105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 6438321Ssteve.reinhardt@amd.com cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 6443105Sstever@eecs.umich.edu return 6453105Sstever@eecs.umich.edu 6463105Sstever@eecs.umich.edu # no valid assignment... raise exception 6473105Sstever@eecs.umich.edu raise AttributeError, \ 6483105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 6491310SN/A 6501585SN/A def __getattr__(cls, attr): 6517675Snate@binkert.org if attr == 'cxx_class_path': 6527675Snate@binkert.org return cls.cxx_class.split('::') 6537675Snate@binkert.org 6547675Snate@binkert.org if attr == 'cxx_class_name': 6557675Snate@binkert.org return cls.cxx_class_path[-1] 6567675Snate@binkert.org 6577675Snate@binkert.org if attr == 'cxx_namespaces': 6587675Snate@binkert.org return cls.cxx_class_path[:-1] 6597675Snate@binkert.org 6601692SN/A if cls._values.has_key(attr): 6611692SN/A return cls._values[attr] 6621585SN/A 6637528Ssteve.reinhardt@amd.com if cls._children.has_key(attr): 6647528Ssteve.reinhardt@amd.com return cls._children[attr] 6657528Ssteve.reinhardt@amd.com 6661585SN/A raise AttributeError, \ 6671585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 6681585SN/A 6693100SN/A def __str__(cls): 6703100SN/A return cls.__name__ 6713100SN/A 6728596Ssteve.reinhardt@amd.com # See ParamValue.cxx_predecls for description. 6738596Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 6748596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 6758596Ssteve.reinhardt@amd.com 67611988Sandreas.sandberg@arm.com def pybind_predecls(cls, code): 67711988Sandreas.sandberg@arm.com code('#include "${{cls.cxx_header}}"') 67811988Sandreas.sandberg@arm.com 6798596Ssteve.reinhardt@amd.com # See ParamValue.swig_predecls for description. 6808596Ssteve.reinhardt@amd.com def swig_predecls(cls, code): 68111802Sandreas.sandberg@arm.com code('%import "python/_m5/param_$cls.i"') 6828596Ssteve.reinhardt@amd.com 6838597Ssteve.reinhardt@amd.com # Hook for exporting additional C++ methods to Python via SWIG. 6848597Ssteve.reinhardt@amd.com # Default is none, override using @classmethod in class definition. 6858597Ssteve.reinhardt@amd.com def export_methods(cls, code): 6868597Ssteve.reinhardt@amd.com pass 6878597Ssteve.reinhardt@amd.com 6888597Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 6898597Ssteve.reinhardt@amd.com # exported via export_methods() to be processed by SWIG. 6908597Ssteve.reinhardt@amd.com # Typically generates one or more %include or %import statements. 6918597Ssteve.reinhardt@amd.com # If any methods are exported, typically at least the C++ header 6928597Ssteve.reinhardt@amd.com # declaring the relevant SimObject class must be included. 6938597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 6948597Ssteve.reinhardt@amd.com pass 6958597Ssteve.reinhardt@amd.com 6968596Ssteve.reinhardt@amd.com # Generate the declaration for this object for wrapping with SWIG. 6978596Ssteve.reinhardt@amd.com # Generates code that goes into a SWIG .i file. Called from 6988596Ssteve.reinhardt@amd.com # src/SConscript. 6998596Ssteve.reinhardt@amd.com def swig_decl(cls, code): 7008596Ssteve.reinhardt@amd.com class_path = cls.cxx_class.split('::') 7018596Ssteve.reinhardt@amd.com classname = class_path[-1] 7028596Ssteve.reinhardt@amd.com namespaces = class_path[:-1] 7038596Ssteve.reinhardt@amd.com 7048596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 7058596Ssteve.reinhardt@amd.com # the object itself, not including inherited params (which 7068596Ssteve.reinhardt@amd.com # will also be inherited from the base class's param struct 70710584Sandreas.hansson@arm.com # here). Sort the params based on their key 70810584Sandreas.hansson@arm.com params = map(lambda (k, v): v, sorted(cls._params.local.items())) 7098840Sandreas.hansson@arm.com ports = cls._ports.local 7108596Ssteve.reinhardt@amd.com 71111802Sandreas.sandberg@arm.com code('%module(package="_m5") param_$cls') 7128596Ssteve.reinhardt@amd.com code() 7138596Ssteve.reinhardt@amd.com code('%{') 7149342SAndreas.Sandberg@arm.com code('#include "sim/sim_object.hh"') 7158596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 7168596Ssteve.reinhardt@amd.com for param in params: 7178596Ssteve.reinhardt@amd.com param.cxx_predecls(code) 7189338SAndreas.Sandberg@arm.com code('#include "${{cls.cxx_header}}"') 7198860Sandreas.hansson@arm.com code('''\ 7208860Sandreas.hansson@arm.com/** 7218860Sandreas.hansson@arm.com * This is a workaround for bug in swig. Prior to gcc 4.6.1 the STL 7228860Sandreas.hansson@arm.com * headers like vector, string, etc. used to automatically pull in 7238860Sandreas.hansson@arm.com * the cstddef header but starting with gcc 4.6.1 they no longer do. 7248860Sandreas.hansson@arm.com * This leads to swig generated a file that does not compile so we 7258860Sandreas.hansson@arm.com * explicitly include cstddef. Additionally, including version 2.0.4, 7268860Sandreas.hansson@arm.com * swig uses ptrdiff_t without the std:: namespace prefix which is 7278860Sandreas.hansson@arm.com * required with gcc 4.6.1. We explicitly provide access to it. 7288860Sandreas.hansson@arm.com */ 7298860Sandreas.hansson@arm.com#include <cstddef> 7308860Sandreas.hansson@arm.comusing std::ptrdiff_t; 7318860Sandreas.hansson@arm.com''') 7328596Ssteve.reinhardt@amd.com code('%}') 7338596Ssteve.reinhardt@amd.com code() 7348596Ssteve.reinhardt@amd.com 7358596Ssteve.reinhardt@amd.com for param in params: 7368596Ssteve.reinhardt@amd.com param.swig_predecls(code) 7378597Ssteve.reinhardt@amd.com cls.export_method_swig_predecls(code) 7388596Ssteve.reinhardt@amd.com 7398596Ssteve.reinhardt@amd.com code() 7408596Ssteve.reinhardt@amd.com if cls._base: 74111802Sandreas.sandberg@arm.com code('%import "python/_m5/param_${{cls._base}}.i"') 7428596Ssteve.reinhardt@amd.com code() 7438596Ssteve.reinhardt@amd.com 7448596Ssteve.reinhardt@amd.com for ns in namespaces: 7458596Ssteve.reinhardt@amd.com code('namespace $ns {') 7468596Ssteve.reinhardt@amd.com 7478596Ssteve.reinhardt@amd.com if namespaces: 7488596Ssteve.reinhardt@amd.com code('// avoid name conflicts') 7498596Ssteve.reinhardt@amd.com sep_string = '_COLONS_' 7508596Ssteve.reinhardt@amd.com flat_name = sep_string.join(class_path) 7518596Ssteve.reinhardt@amd.com code('%rename($flat_name) $classname;') 7528596Ssteve.reinhardt@amd.com 7538597Ssteve.reinhardt@amd.com code() 7548597Ssteve.reinhardt@amd.com code('// stop swig from creating/wrapping default ctor/dtor') 7558597Ssteve.reinhardt@amd.com code('%nodefault $classname;') 7568597Ssteve.reinhardt@amd.com code('class $classname') 7578597Ssteve.reinhardt@amd.com if cls._base: 7589342SAndreas.Sandberg@arm.com bases = [ cls._base.cxx_class ] + cls.cxx_bases 7599342SAndreas.Sandberg@arm.com else: 7609342SAndreas.Sandberg@arm.com bases = cls.cxx_bases 7619342SAndreas.Sandberg@arm.com base_first = True 7629342SAndreas.Sandberg@arm.com for base in bases: 7639342SAndreas.Sandberg@arm.com if base_first: 7649342SAndreas.Sandberg@arm.com code(' : public ${{base}}') 7659342SAndreas.Sandberg@arm.com base_first = False 7669342SAndreas.Sandberg@arm.com else: 7679342SAndreas.Sandberg@arm.com code(' , public ${{base}}') 7689342SAndreas.Sandberg@arm.com 7698597Ssteve.reinhardt@amd.com code('{') 7708597Ssteve.reinhardt@amd.com code(' public:') 7718597Ssteve.reinhardt@amd.com cls.export_methods(code) 7728597Ssteve.reinhardt@amd.com code('};') 7738596Ssteve.reinhardt@amd.com 7748596Ssteve.reinhardt@amd.com for ns in reversed(namespaces): 7758596Ssteve.reinhardt@amd.com code('} // namespace $ns') 7768596Ssteve.reinhardt@amd.com 7778596Ssteve.reinhardt@amd.com code() 7788596Ssteve.reinhardt@amd.com code('%include "params/$cls.hh"') 7798596Ssteve.reinhardt@amd.com 78011988Sandreas.sandberg@arm.com def pybind_decl(cls, code): 78111988Sandreas.sandberg@arm.com class_path = cls.cxx_class.split('::') 78211988Sandreas.sandberg@arm.com namespaces, classname = class_path[:-1], class_path[-1] 78311988Sandreas.sandberg@arm.com py_class_name = '_COLONS_'.join(class_path) if namespaces else \ 78411988Sandreas.sandberg@arm.com classname; 78511988Sandreas.sandberg@arm.com 78611988Sandreas.sandberg@arm.com # The 'local' attribute restricts us to the params declared in 78711988Sandreas.sandberg@arm.com # the object itself, not including inherited params (which 78811988Sandreas.sandberg@arm.com # will also be inherited from the base class's param struct 78911988Sandreas.sandberg@arm.com # here). Sort the params based on their key 79011988Sandreas.sandberg@arm.com params = map(lambda (k, v): v, sorted(cls._params.local.items())) 79111988Sandreas.sandberg@arm.com ports = cls._ports.local 79211988Sandreas.sandberg@arm.com 79311988Sandreas.sandberg@arm.com code('''#include "pybind11/pybind11.h" 79411988Sandreas.sandberg@arm.com#include "pybind11/stl.h" 79511988Sandreas.sandberg@arm.com 79611988Sandreas.sandberg@arm.com#include "sim/sim_object.hh" 79711988Sandreas.sandberg@arm.com#include "params/$cls.hh" 79811988Sandreas.sandberg@arm.com#include "sim/init.hh" 79911988Sandreas.sandberg@arm.com#include "${{cls.cxx_header}}" 80011988Sandreas.sandberg@arm.com 80111988Sandreas.sandberg@arm.com''') 80211988Sandreas.sandberg@arm.com 80311988Sandreas.sandberg@arm.com for param in params: 80411988Sandreas.sandberg@arm.com param.pybind_predecls(code) 80511988Sandreas.sandberg@arm.com 80611988Sandreas.sandberg@arm.com code('''namespace py = pybind11; 80711988Sandreas.sandberg@arm.com 80811988Sandreas.sandberg@arm.comstatic void 80911988Sandreas.sandberg@arm.commodule_init(py::module &m_internal) 81011988Sandreas.sandberg@arm.com{ 81111988Sandreas.sandberg@arm.com py::module m = m_internal.def_submodule("param_${cls}"); 81211988Sandreas.sandberg@arm.com''') 81311988Sandreas.sandberg@arm.com code.indent() 81411988Sandreas.sandberg@arm.com if cls._base: 81511988Sandreas.sandberg@arm.com code('py::class_<${cls}Params, ${{cls._base.type}}Params>(m, ' \ 81611988Sandreas.sandberg@arm.com '"${cls}Params")') 81711988Sandreas.sandberg@arm.com else: 81811988Sandreas.sandberg@arm.com code('py::class_<${cls}Params>(m, "${cls}Params")') 81911988Sandreas.sandberg@arm.com 82011988Sandreas.sandberg@arm.com code.indent() 82111988Sandreas.sandberg@arm.com if not hasattr(cls, 'abstract') or not cls.abstract: 82211988Sandreas.sandberg@arm.com code('.def(py::init<>())') 82311988Sandreas.sandberg@arm.com code('.def("create", &${cls}Params::create)') 82411988Sandreas.sandberg@arm.com 82511988Sandreas.sandberg@arm.com param_exports = cls.cxx_param_exports + [ 82611988Sandreas.sandberg@arm.com PyBindProperty(k) 82711988Sandreas.sandberg@arm.com for k, v in sorted(cls._params.local.items()) 82811988Sandreas.sandberg@arm.com ] + [ 82911988Sandreas.sandberg@arm.com PyBindProperty("port_%s_connection_count" % port.name) 83011988Sandreas.sandberg@arm.com for port in ports.itervalues() 83111988Sandreas.sandberg@arm.com ] 83211988Sandreas.sandberg@arm.com for exp in param_exports: 83311988Sandreas.sandberg@arm.com exp.export(code, "%sParams" % cls) 83411988Sandreas.sandberg@arm.com 83511988Sandreas.sandberg@arm.com code(';') 83611988Sandreas.sandberg@arm.com code() 83711988Sandreas.sandberg@arm.com code.dedent() 83811988Sandreas.sandberg@arm.com 83911988Sandreas.sandberg@arm.com bases = [ cls._base.cxx_class ] + cls.cxx_bases if cls._base else \ 84011988Sandreas.sandberg@arm.com cls.cxx_bases 84111988Sandreas.sandberg@arm.com if bases: 84211988Sandreas.sandberg@arm.com base_str = ", ".join(bases) 84311988Sandreas.sandberg@arm.com code('py::class_<${{cls.cxx_class}}, ${base_str}>(m, ' \ 84411988Sandreas.sandberg@arm.com '"${py_class_name}")') 84511988Sandreas.sandberg@arm.com else: 84611988Sandreas.sandberg@arm.com code('py::class_<${{cls.cxx_class}}>(m, "${py_class_name}")') 84711988Sandreas.sandberg@arm.com code.indent() 84811988Sandreas.sandberg@arm.com for exp in cls.cxx_exports: 84911988Sandreas.sandberg@arm.com exp.export(code, cls.cxx_class) 85011988Sandreas.sandberg@arm.com code(';') 85111988Sandreas.sandberg@arm.com code.dedent() 85211988Sandreas.sandberg@arm.com code() 85311988Sandreas.sandberg@arm.com code.dedent() 85411988Sandreas.sandberg@arm.com code('}') 85511988Sandreas.sandberg@arm.com code() 85611988Sandreas.sandberg@arm.com code('static EmbeddedPyBind embed_obj("${0}", module_init, "${1}");', 85711988Sandreas.sandberg@arm.com cls, cls._base.type if cls._base else "") 85811988Sandreas.sandberg@arm.com 8598596Ssteve.reinhardt@amd.com 8608596Ssteve.reinhardt@amd.com # Generate the C++ declaration (.hh file) for this SimObject's 8618596Ssteve.reinhardt@amd.com # param struct. Called from src/SConscript. 8628596Ssteve.reinhardt@amd.com def cxx_param_decl(cls, code): 8638596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 8643100SN/A # the object itself, not including inherited params (which 8653100SN/A # will also be inherited from the base class's param struct 86610584Sandreas.hansson@arm.com # here). Sort the params based on their key 86710584Sandreas.hansson@arm.com params = map(lambda (k, v): v, sorted(cls._params.local.items())) 8688840Sandreas.hansson@arm.com ports = cls._ports.local 8693100SN/A try: 8703100SN/A ptypes = [p.ptype for p in params] 8713100SN/A except: 8723100SN/A print cls, p, p.ptype_str 8733100SN/A print params 8743100SN/A raise 8753100SN/A 8767675Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 8777675Snate@binkert.org 8787675Snate@binkert.org code('''\ 8797675Snate@binkert.org#ifndef __PARAMS__${cls}__ 8807675Snate@binkert.org#define __PARAMS__${cls}__ 8817675Snate@binkert.org 8827675Snate@binkert.org''') 8837675Snate@binkert.org 88411988Sandreas.sandberg@arm.com 88511988Sandreas.sandberg@arm.com # The base SimObject has a couple of params that get 88611988Sandreas.sandberg@arm.com # automatically set from Python without being declared through 88711988Sandreas.sandberg@arm.com # the normal Param mechanism; we slip them in here (needed 88811988Sandreas.sandberg@arm.com # predecls now, actual declarations below) 88911988Sandreas.sandberg@arm.com if cls == SimObject: 89011988Sandreas.sandberg@arm.com code('''#include <string>''') 89111988Sandreas.sandberg@arm.com 8927675Snate@binkert.org # A forward class declaration is sufficient since we are just 8937675Snate@binkert.org # declaring a pointer. 8947675Snate@binkert.org for ns in class_path[:-1]: 8957675Snate@binkert.org code('namespace $ns {') 8967675Snate@binkert.org code('class $0;', class_path[-1]) 8977675Snate@binkert.org for ns in reversed(class_path[:-1]): 8987811Ssteve.reinhardt@amd.com code('} // namespace $ns') 8997675Snate@binkert.org code() 9007675Snate@binkert.org 9017673Snate@binkert.org for param in params: 9027673Snate@binkert.org param.cxx_predecls(code) 9038840Sandreas.hansson@arm.com for port in ports.itervalues(): 9048840Sandreas.hansson@arm.com port.cxx_predecls(code) 9057673Snate@binkert.org code() 9064762Snate@binkert.org 9075610Snate@binkert.org if cls._base: 9087673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 9097673Snate@binkert.org code() 9104762Snate@binkert.org 9114762Snate@binkert.org for ptype in ptypes: 9124762Snate@binkert.org if issubclass(ptype, Enum): 9137673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 9147673Snate@binkert.org code() 9154762Snate@binkert.org 9168596Ssteve.reinhardt@amd.com # now generate the actual param struct 9178597Ssteve.reinhardt@amd.com code("struct ${cls}Params") 9188597Ssteve.reinhardt@amd.com if cls._base: 9198597Ssteve.reinhardt@amd.com code(" : public ${{cls._base.type}}Params") 9208597Ssteve.reinhardt@amd.com code("{") 9218597Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 9228597Ssteve.reinhardt@amd.com if 'type' in cls.__dict__: 9238597Ssteve.reinhardt@amd.com code(" ${{cls.cxx_type}} create();") 9248597Ssteve.reinhardt@amd.com 9258597Ssteve.reinhardt@amd.com code.indent() 9268596Ssteve.reinhardt@amd.com if cls == SimObject: 9278597Ssteve.reinhardt@amd.com code(''' 9289983Sstever@gmail.com SimObjectParams() {} 9298597Ssteve.reinhardt@amd.com virtual ~SimObjectParams() {} 9308596Ssteve.reinhardt@amd.com 9318597Ssteve.reinhardt@amd.com std::string name; 9328597Ssteve.reinhardt@amd.com ''') 93311988Sandreas.sandberg@arm.com 9348597Ssteve.reinhardt@amd.com for param in params: 9358597Ssteve.reinhardt@amd.com param.cxx_decl(code) 9368840Sandreas.hansson@arm.com for port in ports.itervalues(): 9378840Sandreas.hansson@arm.com port.cxx_decl(code) 9388840Sandreas.hansson@arm.com 9398597Ssteve.reinhardt@amd.com code.dedent() 9408597Ssteve.reinhardt@amd.com code('};') 9415488Snate@binkert.org 9427673Snate@binkert.org code() 9437673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 9445488Snate@binkert.org return code 9455488Snate@binkert.org 94610458Sandreas.hansson@arm.com # Generate the C++ declaration/definition files for this SimObject's 94710458Sandreas.hansson@arm.com # param struct to allow C++ initialisation 94810458Sandreas.hansson@arm.com def cxx_config_param_file(cls, code, is_header): 94910458Sandreas.hansson@arm.com createCxxConfigDirectoryEntryFile(code, cls.__name__, cls, is_header) 95010458Sandreas.hansson@arm.com return code 9515488Snate@binkert.org 9529983Sstever@gmail.com# This *temporary* definition is required to support calls from the 9539983Sstever@gmail.com# SimObject class definition to the MetaSimObject methods (in 9549983Sstever@gmail.com# particular _set_param, which gets called for parameters with default 9559983Sstever@gmail.com# values defined on the SimObject class itself). It will get 9569983Sstever@gmail.com# overridden by the permanent definition (which requires that 9579983Sstever@gmail.com# SimObject be defined) lower in this file. 9589983Sstever@gmail.comdef isSimObjectOrVector(value): 9599983Sstever@gmail.com return False 9603100SN/A 96111988Sandreas.sandberg@arm.comdef cxxMethod(*args, **kwargs): 96211988Sandreas.sandberg@arm.com """Decorator to export C++ functions to Python""" 96311988Sandreas.sandberg@arm.com 96411988Sandreas.sandberg@arm.com def decorate(func): 96511988Sandreas.sandberg@arm.com name = func.func_name 96611988Sandreas.sandberg@arm.com override = kwargs.get("override", False) 96711988Sandreas.sandberg@arm.com cxx_name = kwargs.get("cxx_name", name) 96811988Sandreas.sandberg@arm.com 96911988Sandreas.sandberg@arm.com args, varargs, keywords, defaults = inspect.getargspec(func) 97011988Sandreas.sandberg@arm.com if varargs or keywords: 97111988Sandreas.sandberg@arm.com raise ValueError("Wrapped methods must not contain variable " \ 97211988Sandreas.sandberg@arm.com "arguments") 97311988Sandreas.sandberg@arm.com 97411988Sandreas.sandberg@arm.com # Create tuples of (argument, default) 97511988Sandreas.sandberg@arm.com if defaults: 97611988Sandreas.sandberg@arm.com args = args[:-len(defaults)] + zip(args[-len(defaults):], defaults) 97711988Sandreas.sandberg@arm.com # Don't include self in the argument list to PyBind 97811988Sandreas.sandberg@arm.com args = args[1:] 97911988Sandreas.sandberg@arm.com 98011988Sandreas.sandberg@arm.com 98111988Sandreas.sandberg@arm.com @wraps(func) 98211988Sandreas.sandberg@arm.com def cxx_call(self, *args, **kwargs): 98311988Sandreas.sandberg@arm.com ccobj = self.getCCObject() 98411988Sandreas.sandberg@arm.com return getattr(ccobj, name)(*args, **kwargs) 98511988Sandreas.sandberg@arm.com 98611988Sandreas.sandberg@arm.com @wraps(func) 98711988Sandreas.sandberg@arm.com def py_call(self, *args, **kwargs): 98811988Sandreas.sandberg@arm.com return self.func(*args, **kwargs) 98911988Sandreas.sandberg@arm.com 99011988Sandreas.sandberg@arm.com f = py_call if override else cxx_call 99111988Sandreas.sandberg@arm.com f.__pybind = PyBindMethod(name, cxx_name=cxx_name, args=args) 99211988Sandreas.sandberg@arm.com 99311988Sandreas.sandberg@arm.com return f 99411988Sandreas.sandberg@arm.com 99511988Sandreas.sandberg@arm.com if len(args) == 0: 99611988Sandreas.sandberg@arm.com return decorate 99711988Sandreas.sandberg@arm.com elif len(args) == 1 and len(kwargs) == 0: 99811988Sandreas.sandberg@arm.com return decorate(*args) 99911988Sandreas.sandberg@arm.com else: 100011988Sandreas.sandberg@arm.com raise TypeError("One argument and no kwargs, or only kwargs expected") 100111988Sandreas.sandberg@arm.com 100210267SGeoffrey.Blake@arm.com# This class holds information about each simobject parameter 100310267SGeoffrey.Blake@arm.com# that should be displayed on the command line for use in the 100410267SGeoffrey.Blake@arm.com# configuration system. 100510267SGeoffrey.Blake@arm.comclass ParamInfo(object): 100610267SGeoffrey.Blake@arm.com def __init__(self, type, desc, type_str, example, default_val, access_str): 100710267SGeoffrey.Blake@arm.com self.type = type 100810267SGeoffrey.Blake@arm.com self.desc = desc 100910267SGeoffrey.Blake@arm.com self.type_str = type_str 101010267SGeoffrey.Blake@arm.com self.example_str = example 101110267SGeoffrey.Blake@arm.com self.default_val = default_val 101210267SGeoffrey.Blake@arm.com # The string representation used to access this param through python. 101310267SGeoffrey.Blake@arm.com # The method to access this parameter presented on the command line may 101410267SGeoffrey.Blake@arm.com # be different, so this needs to be stored for later use. 101510267SGeoffrey.Blake@arm.com self.access_str = access_str 101610267SGeoffrey.Blake@arm.com self.created = True 101710267SGeoffrey.Blake@arm.com 101810267SGeoffrey.Blake@arm.com # Make it so we can only set attributes at initialization time 101910267SGeoffrey.Blake@arm.com # and effectively make this a const object. 102010267SGeoffrey.Blake@arm.com def __setattr__(self, name, value): 102110267SGeoffrey.Blake@arm.com if not "created" in self.__dict__: 102210267SGeoffrey.Blake@arm.com self.__dict__[name] = value 102310267SGeoffrey.Blake@arm.com 10242740SN/A# The SimObject class is the root of the special hierarchy. Most of 1025679SN/A# the code in this class deals with the configuration hierarchy itself 1026679SN/A# (parent/child node relationships). 10271692SN/Aclass SimObject(object): 10281692SN/A # Specify metaclass. Any class inheriting from SimObject will 1029679SN/A # get this metaclass. 10301692SN/A __metaclass__ = MetaSimObject 10313100SN/A type = 'SimObject' 10324762Snate@binkert.org abstract = True 10339983Sstever@gmail.com 10349338SAndreas.Sandberg@arm.com cxx_header = "sim/sim_object.hh" 10359345SAndreas.Sandberg@ARM.com cxx_bases = [ "Drainable", "Serializable" ] 10369983Sstever@gmail.com eventq_index = Param.UInt32(Parent.eventq_index, "Event Queue Index") 10379342SAndreas.Sandberg@arm.com 10388597Ssteve.reinhardt@amd.com @classmethod 10398597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 10408597Ssteve.reinhardt@amd.com code(''' 10418597Ssteve.reinhardt@amd.com%include <std_string.i> 10429342SAndreas.Sandberg@arm.com 10439342SAndreas.Sandberg@arm.com%import "python/swig/drain.i" 10449345SAndreas.Sandberg@ARM.com%import "python/swig/serialize.i" 10458597Ssteve.reinhardt@amd.com''') 10468597Ssteve.reinhardt@amd.com 10478597Ssteve.reinhardt@amd.com @classmethod 10488597Ssteve.reinhardt@amd.com def export_methods(cls, code): 10498597Ssteve.reinhardt@amd.com code(''' 10508597Ssteve.reinhardt@amd.com void init(); 105110905Sandreas.sandberg@arm.com void loadState(CheckpointIn &cp); 10528597Ssteve.reinhardt@amd.com void initState(); 105310911Sandreas.sandberg@arm.com void memInvalidate(); 105410911Sandreas.sandberg@arm.com void memWriteback(); 10558597Ssteve.reinhardt@amd.com void regStats(); 10568597Ssteve.reinhardt@amd.com void resetStats(); 105710023Smatt.horsnell@ARM.com void regProbePoints(); 105810023Smatt.horsnell@ARM.com void regProbeListeners(); 10598597Ssteve.reinhardt@amd.com void startup(); 10608597Ssteve.reinhardt@amd.com''') 10618597Ssteve.reinhardt@amd.com 106211988Sandreas.sandberg@arm.com cxx_exports = [ 106311988Sandreas.sandberg@arm.com PyBindMethod("init"), 106411988Sandreas.sandberg@arm.com PyBindMethod("initState"), 106511988Sandreas.sandberg@arm.com PyBindMethod("memInvalidate"), 106611988Sandreas.sandberg@arm.com PyBindMethod("memWriteback"), 106711988Sandreas.sandberg@arm.com PyBindMethod("regStats"), 106811988Sandreas.sandberg@arm.com PyBindMethod("resetStats"), 106911988Sandreas.sandberg@arm.com PyBindMethod("regProbePoints"), 107011988Sandreas.sandberg@arm.com PyBindMethod("regProbeListeners"), 107111988Sandreas.sandberg@arm.com PyBindMethod("startup"), 107211988Sandreas.sandberg@arm.com ] 107311988Sandreas.sandberg@arm.com 107411988Sandreas.sandberg@arm.com cxx_param_exports = [ 107511988Sandreas.sandberg@arm.com PyBindProperty("name"), 107611988Sandreas.sandberg@arm.com ] 107711988Sandreas.sandberg@arm.com 107811988Sandreas.sandberg@arm.com @cxxMethod 107911988Sandreas.sandberg@arm.com def loadState(self, cp): 108011988Sandreas.sandberg@arm.com """Load SimObject state from a checkpoint""" 108111988Sandreas.sandberg@arm.com pass 108211988Sandreas.sandberg@arm.com 108310267SGeoffrey.Blake@arm.com # Returns a dict of all the option strings that can be 108410267SGeoffrey.Blake@arm.com # generated as command line options for this simobject instance 108510267SGeoffrey.Blake@arm.com # by tracing all reachable params in the top level instance and 108610267SGeoffrey.Blake@arm.com # any children it contains. 108710267SGeoffrey.Blake@arm.com def enumerateParams(self, flags_dict = {}, 108810267SGeoffrey.Blake@arm.com cmd_line_str = "", access_str = ""): 108910267SGeoffrey.Blake@arm.com if hasattr(self, "_paramEnumed"): 109010267SGeoffrey.Blake@arm.com print "Cycle detected enumerating params" 109110267SGeoffrey.Blake@arm.com else: 109210267SGeoffrey.Blake@arm.com self._paramEnumed = True 109310267SGeoffrey.Blake@arm.com # Scan the children first to pick up all the objects in this SimObj 109410267SGeoffrey.Blake@arm.com for keys in self._children: 109510267SGeoffrey.Blake@arm.com child = self._children[keys] 109610267SGeoffrey.Blake@arm.com next_cmdline_str = cmd_line_str + keys 109710267SGeoffrey.Blake@arm.com next_access_str = access_str + keys 109810267SGeoffrey.Blake@arm.com if not isSimObjectVector(child): 109910267SGeoffrey.Blake@arm.com next_cmdline_str = next_cmdline_str + "." 110010267SGeoffrey.Blake@arm.com next_access_str = next_access_str + "." 110110267SGeoffrey.Blake@arm.com flags_dict = child.enumerateParams(flags_dict, 110210267SGeoffrey.Blake@arm.com next_cmdline_str, 110310267SGeoffrey.Blake@arm.com next_access_str) 110410267SGeoffrey.Blake@arm.com 110510267SGeoffrey.Blake@arm.com # Go through the simple params in the simobject in this level 110610267SGeoffrey.Blake@arm.com # of the simobject hierarchy and save information about the 110710267SGeoffrey.Blake@arm.com # parameter to be used for generating and processing command line 110810267SGeoffrey.Blake@arm.com # options to the simulator to set these parameters. 110910267SGeoffrey.Blake@arm.com for keys,values in self._params.items(): 111010267SGeoffrey.Blake@arm.com if values.isCmdLineSettable(): 111110267SGeoffrey.Blake@arm.com type_str = '' 111210267SGeoffrey.Blake@arm.com ex_str = values.example_str() 111310267SGeoffrey.Blake@arm.com ptype = None 111410267SGeoffrey.Blake@arm.com if isinstance(values, VectorParamDesc): 111510267SGeoffrey.Blake@arm.com type_str = 'Vector_%s' % values.ptype_str 111610267SGeoffrey.Blake@arm.com ptype = values 111710267SGeoffrey.Blake@arm.com else: 111810267SGeoffrey.Blake@arm.com type_str = '%s' % values.ptype_str 111910267SGeoffrey.Blake@arm.com ptype = values.ptype 112010267SGeoffrey.Blake@arm.com 112110267SGeoffrey.Blake@arm.com if keys in self._hr_values\ 112210267SGeoffrey.Blake@arm.com and keys in self._values\ 112310267SGeoffrey.Blake@arm.com and not isinstance(self._values[keys], m5.proxy.BaseProxy): 112410267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 112510267SGeoffrey.Blake@arm.com acc_str = access_str + keys 112610267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 112710267SGeoffrey.Blake@arm.com self._params[keys].desc, type_str, ex_str, 112810267SGeoffrey.Blake@arm.com values.pretty_print(self._hr_values[keys]), 112910267SGeoffrey.Blake@arm.com acc_str) 113010267SGeoffrey.Blake@arm.com elif not keys in self._hr_values\ 113110267SGeoffrey.Blake@arm.com and not keys in self._values: 113210267SGeoffrey.Blake@arm.com # Empty param 113310267SGeoffrey.Blake@arm.com cmd_str = cmd_line_str + keys 113410267SGeoffrey.Blake@arm.com acc_str = access_str + keys 113510267SGeoffrey.Blake@arm.com flags_dict[cmd_str] = ParamInfo(ptype, 113610267SGeoffrey.Blake@arm.com self._params[keys].desc, 113710267SGeoffrey.Blake@arm.com type_str, ex_str, '', acc_str) 113810267SGeoffrey.Blake@arm.com 113910267SGeoffrey.Blake@arm.com return flags_dict 114010267SGeoffrey.Blake@arm.com 11412740SN/A # Initialize new instance. For objects with SimObject-valued 11422740SN/A # children, we need to recursively clone the classes represented 11432740SN/A # by those param values as well in a consistent "deep copy"-style 11442740SN/A # fashion. That is, we want to make sure that each instance is 11452740SN/A # cloned only once, and that if there are multiple references to 11462740SN/A # the same original object, we end up with the corresponding 11472740SN/A # cloned references all pointing to the same cloned instance. 11482740SN/A def __init__(self, **kwargs): 11492740SN/A ancestor = kwargs.get('_ancestor') 11502740SN/A memo_dict = kwargs.get('_memo') 11512740SN/A if memo_dict is None: 11522740SN/A # prepare to memoize any recursively instantiated objects 11532740SN/A memo_dict = {} 11542740SN/A elif ancestor: 11552740SN/A # memoize me now to avoid problems with recursive calls 11562740SN/A memo_dict[ancestor] = self 11572711SN/A 11582740SN/A if not ancestor: 11592740SN/A ancestor = self.__class__ 11602740SN/A ancestor._instantiated = True 11612711SN/A 11622740SN/A # initialize required attributes 11632740SN/A self._parent = None 11647528Ssteve.reinhardt@amd.com self._name = None 11652740SN/A self._ccObject = None # pointer to C++ object 11664762Snate@binkert.org self._ccParams = None 11672740SN/A self._instantiated = False # really "cloned" 11682712SN/A 11698321Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 11708321Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 11718321Ssteve.reinhardt@amd.com # Do children before parameter values so that children that 11728321Ssteve.reinhardt@amd.com # are also param values get cloned properly. 11738321Ssteve.reinhardt@amd.com self._children = {} 11748321Ssteve.reinhardt@amd.com for key,val in ancestor._children.iteritems(): 11758321Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 11768321Ssteve.reinhardt@amd.com 11772711SN/A # Inherit parameter values from class using multidict so 11787528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 11797528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 11802740SN/A self._values = multidict(ancestor._values) 118110267SGeoffrey.Blake@arm.com self._hr_values = multidict(ancestor._hr_values) 11822740SN/A # clone SimObject-valued parameters 11832740SN/A for key,val in ancestor._values.iteritems(): 11847528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 11857528Ssteve.reinhardt@amd.com if val is not None: 11867528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 11877528Ssteve.reinhardt@amd.com 11882740SN/A # clone port references. no need to use a multidict here 11892740SN/A # since we will be creating new references for all ports. 11903105Sstever@eecs.umich.edu self._port_refs = {} 11913105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 11923105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 11931692SN/A # apply attribute assignments from keyword args, if any 11941692SN/A for key,val in kwargs.iteritems(): 11951692SN/A setattr(self, key, val) 1196679SN/A 11972740SN/A # "Clone" the current instance by creating another instance of 11982740SN/A # this instance's class, but that inherits its parameter values 11992740SN/A # and port mappings from the current instance. If we're in a 12002740SN/A # "deep copy" recursive clone, check the _memo dict to see if 12012740SN/A # we've already cloned this instance. 12021692SN/A def __call__(self, **kwargs): 12032740SN/A memo_dict = kwargs.get('_memo') 12042740SN/A if memo_dict is None: 12052740SN/A # no memo_dict: must be top-level clone operation. 12062740SN/A # this is only allowed at the root of a hierarchy 12072740SN/A if self._parent: 12082740SN/A raise RuntimeError, "attempt to clone object %s " \ 12092740SN/A "not at the root of a tree (parent = %s)" \ 12102740SN/A % (self, self._parent) 12112740SN/A # create a new dict and use that. 12122740SN/A memo_dict = {} 12132740SN/A kwargs['_memo'] = memo_dict 12142740SN/A elif memo_dict.has_key(self): 12152740SN/A # clone already done & memoized 12162740SN/A return memo_dict[self] 12172740SN/A return self.__class__(_ancestor = self, **kwargs) 12181343SN/A 12193105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 12203105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 12213105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 12223105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 12233105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 12249940SGeoffrey.Blake@arm.com if ref == None: 12253105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 12263105Sstever@eecs.umich.edu self._port_refs[attr] = ref 12273105Sstever@eecs.umich.edu return ref 12283105Sstever@eecs.umich.edu 12291692SN/A def __getattr__(self, attr): 12302738SN/A if self._ports.has_key(attr): 12313105Sstever@eecs.umich.edu return self._get_port_ref(attr) 12322738SN/A 12331692SN/A if self._values.has_key(attr): 12341692SN/A return self._values[attr] 12351427SN/A 12367528Ssteve.reinhardt@amd.com if self._children.has_key(attr): 12377528Ssteve.reinhardt@amd.com return self._children[attr] 12387528Ssteve.reinhardt@amd.com 12397500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 12407500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 12417500Ssteve.reinhardt@amd.com # SWIG-wrapped methods such as init(), regStats(), 12429195SAndreas.Sandberg@arm.com # resetStats(), startup(), drain(), and 12437527Ssteve.reinhardt@amd.com # resume(). 12447500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 12457500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 12467500Ssteve.reinhardt@amd.com 124710002Ssteve.reinhardt@amd.com err_string = "object '%s' has no attribute '%s'" \ 12481692SN/A % (self.__class__.__name__, attr) 12491427SN/A 125010002Ssteve.reinhardt@amd.com if not self._ccObject: 125110002Ssteve.reinhardt@amd.com err_string += "\n (C++ object is not yet constructed," \ 125210002Ssteve.reinhardt@amd.com " so wrapped C++ methods are unavailable.)" 125310002Ssteve.reinhardt@amd.com 125410002Ssteve.reinhardt@amd.com raise AttributeError, err_string 125510002Ssteve.reinhardt@amd.com 12561692SN/A # Set attribute (called on foo.attr = value when foo is an 12571692SN/A # instance of class cls). 12581692SN/A def __setattr__(self, attr, value): 12591692SN/A # normal processing for private attributes 12601692SN/A if attr.startswith('_'): 12611692SN/A object.__setattr__(self, attr, value) 12621692SN/A return 12631427SN/A 12642738SN/A if self._ports.has_key(attr): 12652738SN/A # set up port connection 12663105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 12672738SN/A return 12682738SN/A 12693105Sstever@eecs.umich.edu param = self._params.get(attr) 12701692SN/A if param: 12711310SN/A try: 127210267SGeoffrey.Blake@arm.com hr_value = value 12731692SN/A value = param.convert(value) 12741587SN/A except Exception, e: 12751692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 12761692SN/A (e, self.__class__.__name__, attr, value) 12771605SN/A e.args = (msg, ) 12781605SN/A raise 12797528Ssteve.reinhardt@amd.com self._values[attr] = value 12808321Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 12818321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 12828321Ssteve.reinhardt@amd.com self.add_child(attr, value) 128310267SGeoffrey.Blake@arm.com # set the human-readable value dict if this is a param 128410267SGeoffrey.Blake@arm.com # with a literal value and is not being set as an object 128510267SGeoffrey.Blake@arm.com # or proxy. 128610267SGeoffrey.Blake@arm.com if not (isSimObjectOrVector(value) or\ 128710267SGeoffrey.Blake@arm.com isinstance(value, m5.proxy.BaseProxy)): 128810267SGeoffrey.Blake@arm.com self._hr_values[attr] = hr_value 128910267SGeoffrey.Blake@arm.com 12903105Sstever@eecs.umich.edu return 12911310SN/A 12927528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 12933105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 12947528Ssteve.reinhardt@amd.com self.add_child(attr, value) 12953105Sstever@eecs.umich.edu return 12961693SN/A 12973105Sstever@eecs.umich.edu # no valid assignment... raise exception 12983105Sstever@eecs.umich.edu raise AttributeError, "Class %s has no parameter %s" \ 12993105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 13001310SN/A 13011310SN/A 13021692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 13031692SN/A # not be vectors, and always getting the first element (e.g. cpus) 13041692SN/A def __getitem__(self, key): 13051692SN/A if key == 0: 13061692SN/A return self 130710267SGeoffrey.Blake@arm.com raise IndexError, "Non-zero index '%s' to SimObject" % key 130810267SGeoffrey.Blake@arm.com 130910267SGeoffrey.Blake@arm.com # this hack allows us to iterate over a SimObject that may 131010267SGeoffrey.Blake@arm.com # not be a vector, so we can call a loop over it and get just one 131110267SGeoffrey.Blake@arm.com # element. 131210267SGeoffrey.Blake@arm.com def __len__(self): 131310267SGeoffrey.Blake@arm.com return 1 13141310SN/A 13157528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13167528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 13177528Ssteve.reinhardt@amd.com assert self._parent is old_parent 13187528Ssteve.reinhardt@amd.com self._parent = None 13197528Ssteve.reinhardt@amd.com 13207528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13217528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 13227528Ssteve.reinhardt@amd.com self._parent = parent 13237528Ssteve.reinhardt@amd.com self._name = name 13247528Ssteve.reinhardt@amd.com 13259953Sgeoffrey.blake@arm.com # Return parent object of this SimObject, not implemented by SimObjectVector 13269953Sgeoffrey.blake@arm.com # because the elements in a SimObjectVector may not share the same parent 13279953Sgeoffrey.blake@arm.com def get_parent(self): 13289953Sgeoffrey.blake@arm.com return self._parent 13299953Sgeoffrey.blake@arm.com 13307528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13317528Ssteve.reinhardt@amd.com def get_name(self): 13327528Ssteve.reinhardt@amd.com return self._name 13337528Ssteve.reinhardt@amd.com 13348321Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 13358321Ssteve.reinhardt@amd.com def has_parent(self): 13368321Ssteve.reinhardt@amd.com return self._parent is not None 13377528Ssteve.reinhardt@amd.com 13387742Sgblack@eecs.umich.edu # clear out child with given name. This code is not likely to be exercised. 13397742Sgblack@eecs.umich.edu # See comment in add_child. 13401693SN/A def clear_child(self, name): 13411693SN/A child = self._children[name] 13427528Ssteve.reinhardt@amd.com child.clear_parent(self) 13431693SN/A del self._children[name] 13441693SN/A 13457528Ssteve.reinhardt@amd.com # Add a new child to this object. 13467528Ssteve.reinhardt@amd.com def add_child(self, name, child): 13477528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 13488321Ssteve.reinhardt@amd.com if child.has_parent(): 13499528Ssascha.bischoff@arm.com warn("add_child('%s'): child '%s' already has parent", name, 13509528Ssascha.bischoff@arm.com child.get_name()) 13517528Ssteve.reinhardt@amd.com if self._children.has_key(name): 13527742Sgblack@eecs.umich.edu # This code path had an undiscovered bug that would make it fail 13537742Sgblack@eecs.umich.edu # at runtime. It had been here for a long time and was only 13547742Sgblack@eecs.umich.edu # exposed by a buggy script. Changes here will probably not be 13557742Sgblack@eecs.umich.edu # exercised without specialized testing. 13567738Sgblack@eecs.umich.edu self.clear_child(name) 13577528Ssteve.reinhardt@amd.com child.set_parent(self, name) 13587528Ssteve.reinhardt@amd.com self._children[name] = child 13591310SN/A 13607528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 13617528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 13627528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 13637528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 13647528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 13657528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 13667528Ssteve.reinhardt@amd.com for key,val in self._values.iteritems(): 13677528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 13687528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 13698321Ssteve.reinhardt@amd.com # SimObjectVector class so we can call has_parent() 13707528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 13717528Ssteve.reinhardt@amd.com self._values[key] = val 13728321Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 13739528Ssascha.bischoff@arm.com warn("%s adopting orphan SimObject param '%s'", self, key) 13747528Ssteve.reinhardt@amd.com self.add_child(key, val) 13753105Sstever@eecs.umich.edu 13761692SN/A def path(self): 13772740SN/A if not self._parent: 13788321Ssteve.reinhardt@amd.com return '<orphan %s>' % self.__class__ 137911231Sandreas.sandberg@arm.com elif isinstance(self._parent, MetaSimObject): 138011231Sandreas.sandberg@arm.com return str(self.__class__) 138111231Sandreas.sandberg@arm.com 13821692SN/A ppath = self._parent.path() 13831692SN/A if ppath == 'root': 13841692SN/A return self._name 13851692SN/A return ppath + "." + self._name 13861310SN/A 13871692SN/A def __str__(self): 13881692SN/A return self.path() 13891310SN/A 139010380SAndrew.Bardsley@arm.com def config_value(self): 139110380SAndrew.Bardsley@arm.com return self.path() 139210380SAndrew.Bardsley@arm.com 13931692SN/A def ini_str(self): 13941692SN/A return self.path() 13951310SN/A 13961692SN/A def find_any(self, ptype): 13971692SN/A if isinstance(self, ptype): 13981692SN/A return self, True 13991310SN/A 14001692SN/A found_obj = None 14011692SN/A for child in self._children.itervalues(): 140210195SGeoffrey.Blake@arm.com visited = False 140310195SGeoffrey.Blake@arm.com if hasattr(child, '_visited'): 140410195SGeoffrey.Blake@arm.com visited = getattr(child, '_visited') 140510195SGeoffrey.Blake@arm.com 140610195SGeoffrey.Blake@arm.com if isinstance(child, ptype) and not visited: 14071692SN/A if found_obj != None and child != found_obj: 14081692SN/A raise AttributeError, \ 14091692SN/A 'parent.any matched more than one: %s %s' % \ 14101814SN/A (found_obj.path, child.path) 14111692SN/A found_obj = child 14121692SN/A # search param space 14131692SN/A for pname,pdesc in self._params.iteritems(): 14141692SN/A if issubclass(pdesc.ptype, ptype): 14151692SN/A match_obj = self._values[pname] 14161692SN/A if found_obj != None and found_obj != match_obj: 14171692SN/A raise AttributeError, \ 14185952Ssaidi@eecs.umich.edu 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 14191692SN/A found_obj = match_obj 14201692SN/A return found_obj, found_obj != None 14211692SN/A 14228459SAli.Saidi@ARM.com def find_all(self, ptype): 14238459SAli.Saidi@ARM.com all = {} 14248459SAli.Saidi@ARM.com # search children 14258459SAli.Saidi@ARM.com for child in self._children.itervalues(): 14269410Sandreas.hansson@arm.com # a child could be a list, so ensure we visit each item 14279410Sandreas.hansson@arm.com if isinstance(child, list): 14289410Sandreas.hansson@arm.com children = child 14299410Sandreas.hansson@arm.com else: 14309410Sandreas.hansson@arm.com children = [child] 14319410Sandreas.hansson@arm.com 14329410Sandreas.hansson@arm.com for child in children: 14339410Sandreas.hansson@arm.com if isinstance(child, ptype) and not isproxy(child) and \ 14349410Sandreas.hansson@arm.com not isNullPointer(child): 14359410Sandreas.hansson@arm.com all[child] = True 14369410Sandreas.hansson@arm.com if isSimObject(child): 14379410Sandreas.hansson@arm.com # also add results from the child itself 14389410Sandreas.hansson@arm.com child_all, done = child.find_all(ptype) 14399410Sandreas.hansson@arm.com all.update(dict(zip(child_all, [done] * len(child_all)))) 14408459SAli.Saidi@ARM.com # search param space 14418459SAli.Saidi@ARM.com for pname,pdesc in self._params.iteritems(): 14428459SAli.Saidi@ARM.com if issubclass(pdesc.ptype, ptype): 14438459SAli.Saidi@ARM.com match_obj = self._values[pname] 14448459SAli.Saidi@ARM.com if not isproxy(match_obj) and not isNullPointer(match_obj): 14458459SAli.Saidi@ARM.com all[match_obj] = True 144610532Sandreas.hansson@arm.com # Also make sure to sort the keys based on the objects' path to 144710532Sandreas.hansson@arm.com # ensure that the order is the same on all hosts 144810532Sandreas.hansson@arm.com return sorted(all.keys(), key = lambda o: o.path()), True 14498459SAli.Saidi@ARM.com 14501815SN/A def unproxy(self, base): 14511815SN/A return self 14521815SN/A 14537527Ssteve.reinhardt@amd.com def unproxyParams(self): 14543105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 14553105Sstever@eecs.umich.edu value = self._values.get(param) 14566654Snate@binkert.org if value != None and isproxy(value): 14573105Sstever@eecs.umich.edu try: 14583105Sstever@eecs.umich.edu value = value.unproxy(self) 14593105Sstever@eecs.umich.edu except: 14603105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 14613105Sstever@eecs.umich.edu (param, self.path()) 14623105Sstever@eecs.umich.edu raise 14633105Sstever@eecs.umich.edu setattr(self, param, value) 14643105Sstever@eecs.umich.edu 14653107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 14663107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 14673107Sstever@eecs.umich.edu port_names = self._ports.keys() 14683107Sstever@eecs.umich.edu port_names.sort() 14693107Sstever@eecs.umich.edu for port_name in port_names: 14703105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 14713105Sstever@eecs.umich.edu if port != None: 14723105Sstever@eecs.umich.edu port.unproxy(self) 14733105Sstever@eecs.umich.edu 14745037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 14755543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 14761692SN/A 14772738SN/A instanceDict[self.path()] = self 14782738SN/A 14794081Sbinkertn@umich.edu if hasattr(self, 'type'): 14805037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 14811692SN/A 14828664SAli.Saidi@ARM.com if len(self._children.keys()): 14837528Ssteve.reinhardt@amd.com print >>ini_file, 'children=%s' % \ 14848664SAli.Saidi@ARM.com ' '.join(self._children[n].get_name() \ 14858664SAli.Saidi@ARM.com for n in sorted(self._children.keys())) 14861692SN/A 14878664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 14883105Sstever@eecs.umich.edu value = self._values.get(param) 14891692SN/A if value != None: 14905037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 14915037Smilesck@eecs.umich.edu self._values[param].ini_str()) 14921692SN/A 14938664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 14943105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 14953105Sstever@eecs.umich.edu if port != None: 14965037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 14973103Sstever@eecs.umich.edu 14985543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 14991692SN/A 15008664SAli.Saidi@ARM.com # generate a tree of dictionaries expressing all the parameters in the 15018664SAli.Saidi@ARM.com # instantiated system for use by scripts that want to do power, thermal 15028664SAli.Saidi@ARM.com # visualization, and other similar tasks 15038664SAli.Saidi@ARM.com def get_config_as_dict(self): 15048664SAli.Saidi@ARM.com d = attrdict() 15058664SAli.Saidi@ARM.com if hasattr(self, 'type'): 15068664SAli.Saidi@ARM.com d.type = self.type 15078664SAli.Saidi@ARM.com if hasattr(self, 'cxx_class'): 15088664SAli.Saidi@ARM.com d.cxx_class = self.cxx_class 15099017Sandreas.hansson@arm.com # Add the name and path of this object to be able to link to 15109017Sandreas.hansson@arm.com # the stats 15119017Sandreas.hansson@arm.com d.name = self.get_name() 15129017Sandreas.hansson@arm.com d.path = self.path() 15138664SAli.Saidi@ARM.com 15148664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 15158664SAli.Saidi@ARM.com value = self._values.get(param) 15168848Ssteve.reinhardt@amd.com if value != None: 151710380SAndrew.Bardsley@arm.com d[param] = value.config_value() 15188664SAli.Saidi@ARM.com 15198664SAli.Saidi@ARM.com for n in sorted(self._children.keys()): 15209017Sandreas.hansson@arm.com child = self._children[n] 15219017Sandreas.hansson@arm.com # Use the name of the attribute (and not get_name()) as 15229017Sandreas.hansson@arm.com # the key in the JSON dictionary to capture the hierarchy 15239017Sandreas.hansson@arm.com # in the Python code that assembled this system 15249017Sandreas.hansson@arm.com d[n] = child.get_config_as_dict() 15258664SAli.Saidi@ARM.com 15268664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 15278664SAli.Saidi@ARM.com port = self._port_refs.get(port_name, None) 15288664SAli.Saidi@ARM.com if port != None: 15299017Sandreas.hansson@arm.com # Represent each port with a dictionary containing the 15309017Sandreas.hansson@arm.com # prominent attributes 15319017Sandreas.hansson@arm.com d[port_name] = port.get_config_as_dict() 15328664SAli.Saidi@ARM.com 15338664SAli.Saidi@ARM.com return d 15348664SAli.Saidi@ARM.com 15354762Snate@binkert.org def getCCParams(self): 15364762Snate@binkert.org if self._ccParams: 15374762Snate@binkert.org return self._ccParams 15384762Snate@binkert.org 15397677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 15404762Snate@binkert.org cc_params = cc_params_struct() 15414762Snate@binkert.org cc_params.name = str(self) 15424762Snate@binkert.org 15434762Snate@binkert.org param_names = self._params.keys() 15444762Snate@binkert.org param_names.sort() 15454762Snate@binkert.org for param in param_names: 15464762Snate@binkert.org value = self._values.get(param) 15474762Snate@binkert.org if value is None: 15486654Snate@binkert.org fatal("%s.%s without default or user set value", 15496654Snate@binkert.org self.path(), param) 15504762Snate@binkert.org 15514762Snate@binkert.org value = value.getValue() 15524762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 15534762Snate@binkert.org assert isinstance(value, list) 15544762Snate@binkert.org vec = getattr(cc_params, param) 15554762Snate@binkert.org assert not len(vec) 155611988Sandreas.sandberg@arm.com setattr(cc_params, param, list(value)) 15574762Snate@binkert.org else: 15584762Snate@binkert.org setattr(cc_params, param, value) 15594762Snate@binkert.org 15604762Snate@binkert.org port_names = self._ports.keys() 15614762Snate@binkert.org port_names.sort() 15624762Snate@binkert.org for port_name in port_names: 15634762Snate@binkert.org port = self._port_refs.get(port_name, None) 15648912Sandreas.hansson@arm.com if port != None: 15658912Sandreas.hansson@arm.com port_count = len(port) 15668912Sandreas.hansson@arm.com else: 15678912Sandreas.hansson@arm.com port_count = 0 15688900Sandreas.hansson@arm.com setattr(cc_params, 'port_' + port_name + '_connection_count', 15698912Sandreas.hansson@arm.com port_count) 15704762Snate@binkert.org self._ccParams = cc_params 15714762Snate@binkert.org return self._ccParams 15722738SN/A 15732740SN/A # Get C++ object corresponding to this object, calling C++ if 15742740SN/A # necessary to construct it. Does *not* recursively create 15752740SN/A # children. 15762740SN/A def getCCObject(self): 15772740SN/A if not self._ccObject: 15787526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 15797526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 15807526Ssteve.reinhardt@amd.com raise RuntimeError, "Attempt to instantiate orphan node" 15817526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 15825244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 15835244Sgblack@eecs.umich.edu self._ccObject = -1 158410267SGeoffrey.Blake@arm.com if not self.abstract: 158510267SGeoffrey.Blake@arm.com params = self.getCCParams() 158610267SGeoffrey.Blake@arm.com self._ccObject = params.create() 15872740SN/A elif self._ccObject == -1: 15887526Ssteve.reinhardt@amd.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 15892740SN/A % self.path() 15902740SN/A return self._ccObject 15912740SN/A 15927527Ssteve.reinhardt@amd.com def descendants(self): 15937527Ssteve.reinhardt@amd.com yield self 159410532Sandreas.hansson@arm.com # The order of the dict is implementation dependent, so sort 159510532Sandreas.hansson@arm.com # it based on the key (name) to ensure the order is the same 159610532Sandreas.hansson@arm.com # on all hosts 159710532Sandreas.hansson@arm.com for (name, child) in sorted(self._children.iteritems()): 15987527Ssteve.reinhardt@amd.com for obj in child.descendants(): 15997527Ssteve.reinhardt@amd.com yield obj 16007527Ssteve.reinhardt@amd.com 16017527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 16024762Snate@binkert.org def createCCObject(self): 16034762Snate@binkert.org self.getCCParams() 16044762Snate@binkert.org self.getCCObject() # force creation 16054762Snate@binkert.org 16064762Snate@binkert.org def getValue(self): 16074762Snate@binkert.org return self.getCCObject() 16084762Snate@binkert.org 16092738SN/A # Create C++ port connections corresponding to the connections in 16107527Ssteve.reinhardt@amd.com # _port_refs 16112738SN/A def connectPorts(self): 161210532Sandreas.hansson@arm.com # Sort the ports based on their attribute name to ensure the 161310532Sandreas.hansson@arm.com # order is the same on all hosts 161410532Sandreas.hansson@arm.com for (attr, portRef) in sorted(self._port_refs.iteritems()): 16153105Sstever@eecs.umich.edu portRef.ccConnect() 16162797SN/A 16173101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 16183101Sstever@eecs.umich.edudef resolveSimObject(name): 16193101Sstever@eecs.umich.edu obj = instanceDict[name] 16203101Sstever@eecs.umich.edu return obj.getCCObject() 1621679SN/A 16226654Snate@binkert.orgdef isSimObject(value): 16236654Snate@binkert.org return isinstance(value, SimObject) 16246654Snate@binkert.org 16256654Snate@binkert.orgdef isSimObjectClass(value): 16266654Snate@binkert.org return issubclass(value, SimObject) 16276654Snate@binkert.org 16287528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 16297528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 16307528Ssteve.reinhardt@amd.com 16316654Snate@binkert.orgdef isSimObjectSequence(value): 16326654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 16336654Snate@binkert.org return False 16346654Snate@binkert.org 16356654Snate@binkert.org for val in value: 16366654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 16376654Snate@binkert.org return False 16386654Snate@binkert.org 16396654Snate@binkert.org return True 16406654Snate@binkert.org 16416654Snate@binkert.orgdef isSimObjectOrSequence(value): 16426654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 16436654Snate@binkert.org 16447526Ssteve.reinhardt@amd.comdef isRoot(obj): 16457526Ssteve.reinhardt@amd.com from m5.objects import Root 16467526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 16477526Ssteve.reinhardt@amd.com 16487528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 16497528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 16507528Ssteve.reinhardt@amd.com 16517528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 16527528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 16537528Ssteve.reinhardt@amd.com return value 16547528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 16557528Ssteve.reinhardt@amd.com return SimObjectVector(value) 16567528Ssteve.reinhardt@amd.com return None 16577528Ssteve.reinhardt@amd.com 16587528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 16597528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 16607528Ssteve.reinhardt@amd.com if value is None: 16617528Ssteve.reinhardt@amd.com raise TypeError, "SimObject or SimObjectVector expected" 16627528Ssteve.reinhardt@amd.com return value 16637528Ssteve.reinhardt@amd.com 16646654Snate@binkert.orgbaseClasses = allClasses.copy() 16656654Snate@binkert.orgbaseInstances = instanceDict.copy() 16666654Snate@binkert.org 16676654Snate@binkert.orgdef clear(): 16689338SAndreas.Sandberg@arm.com global allClasses, instanceDict, noCxxHeader 16696654Snate@binkert.org 16706654Snate@binkert.org allClasses = baseClasses.copy() 16716654Snate@binkert.org instanceDict = baseInstances.copy() 16729338SAndreas.Sandberg@arm.com noCxxHeader = False 16736654Snate@binkert.org 16741528SN/A# __all__ defines the list of symbols that get exported when 16751528SN/A# 'from config import *' is invoked. Try to keep this reasonably 16761528SN/A# short to avoid polluting other namespaces. 167711988Sandreas.sandberg@arm.com__all__ = [ 167811988Sandreas.sandberg@arm.com 'SimObject', 167911988Sandreas.sandberg@arm.com 'cxxMethod', 168011988Sandreas.sandberg@arm.com 'PyBindMethod', 168111988Sandreas.sandberg@arm.com 'PyBindProperty', 168211988Sandreas.sandberg@arm.com] 1683