SimObject.py revision 7528
12740SN/A# Copyright (c) 2004-2006 The Regents of The University of Michigan 21046SN/A# All rights reserved. 31046SN/A# 41046SN/A# Redistribution and use in source and binary forms, with or without 51046SN/A# modification, are permitted provided that the following conditions are 61046SN/A# met: redistributions of source code must retain the above copyright 71046SN/A# notice, this list of conditions and the following disclaimer; 81046SN/A# redistributions in binary form must reproduce the above copyright 91046SN/A# notice, this list of conditions and the following disclaimer in the 101046SN/A# documentation and/or other materials provided with the distribution; 111046SN/A# neither the name of the copyright holders nor the names of its 121046SN/A# contributors may be used to endorse or promote products derived from 131046SN/A# this software without specific prior written permission. 141046SN/A# 151046SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 161046SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 171046SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 181046SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 191046SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 201046SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 211046SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 221046SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 231046SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 241046SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 251046SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 262665SN/A# 272665SN/A# Authors: Steve Reinhardt 282665SN/A# Nathan Binkert 291046SN/A 305766Snate@binkert.orgimport sys 317493Ssteve.reinhardt@amd.comfrom types import FunctionType 321438SN/A 336654Snate@binkert.orgtry: 346654Snate@binkert.org import pydot 356654Snate@binkert.orgexcept: 366654Snate@binkert.org pydot = False 376654Snate@binkert.org 384762Snate@binkert.orgimport m5 396654Snate@binkert.orgfrom m5.util import * 403102Sstever@eecs.umich.edu 413102Sstever@eecs.umich.edu# Have to import params up top since Param is referenced on initial 423102Sstever@eecs.umich.edu# load (when SimObject class references Param to create a class 433102Sstever@eecs.umich.edu# variable, the 'name' param)... 446654Snate@binkert.orgfrom m5.params import * 453102Sstever@eecs.umich.edu# There are a few things we need that aren't in params.__all__ since 463102Sstever@eecs.umich.edu# normal users don't need them 477528Ssteve.reinhardt@amd.comfrom m5.params import ParamDesc, VectorParamDesc, \ 487528Ssteve.reinhardt@amd.com isNullPointer, SimObjectVector 493102Sstever@eecs.umich.edu 506654Snate@binkert.orgfrom m5.proxy import * 516654Snate@binkert.orgfrom m5.proxy import isproxy 52679SN/A 53679SN/A##################################################################### 54679SN/A# 55679SN/A# M5 Python Configuration Utility 56679SN/A# 57679SN/A# The basic idea is to write simple Python programs that build Python 581692SN/A# objects corresponding to M5 SimObjects for the desired simulation 59679SN/A# configuration. For now, the Python emits a .ini file that can be 60679SN/A# parsed by M5. In the future, some tighter integration between M5 61679SN/A# and the Python interpreter may allow bypassing the .ini file. 62679SN/A# 63679SN/A# Each SimObject class in M5 is represented by a Python class with the 64679SN/A# same name. The Python inheritance tree mirrors the M5 C++ tree 65679SN/A# (e.g., SimpleCPU derives from BaseCPU in both cases, and all 66679SN/A# SimObjects inherit from a single SimObject base class). To specify 67679SN/A# an instance of an M5 SimObject in a configuration, the user simply 68679SN/A# instantiates the corresponding Python object. The parameters for 69679SN/A# that SimObject are given by assigning to attributes of the Python 70679SN/A# object, either using keyword assignment in the constructor or in 71679SN/A# separate assignment statements. For example: 72679SN/A# 731692SN/A# cache = BaseCache(size='64KB') 74679SN/A# cache.hit_latency = 3 75679SN/A# cache.assoc = 8 76679SN/A# 77679SN/A# The magic lies in the mapping of the Python attributes for SimObject 78679SN/A# classes to the actual SimObject parameter specifications. This 79679SN/A# allows parameter validity checking in the Python code. Continuing 80679SN/A# the example above, the statements "cache.blurfl=3" or 81679SN/A# "cache.assoc='hello'" would both result in runtime errors in Python, 82679SN/A# since the BaseCache object has no 'blurfl' parameter and the 'assoc' 83679SN/A# parameter requires an integer, respectively. This magic is done 84679SN/A# primarily by overriding the special __setattr__ method that controls 85679SN/A# assignment to object attributes. 86679SN/A# 87679SN/A# Once a set of Python objects have been instantiated in a hierarchy, 88679SN/A# calling 'instantiate(obj)' (where obj is the root of the hierarchy) 892740SN/A# will generate a .ini file. 90679SN/A# 91679SN/A##################################################################### 92679SN/A 934762Snate@binkert.org# list of all SimObject classes 944762Snate@binkert.orgallClasses = {} 954762Snate@binkert.org 962738SN/A# dict to look up SimObjects based on path 972738SN/AinstanceDict = {} 982738SN/A 992740SN/A# The metaclass for SimObject. This class controls how new classes 1002740SN/A# that derive from SimObject are instantiated, and provides inherited 1012740SN/A# class behavior (just like a class controls how instances of that 1022740SN/A# class are instantiated, and provides inherited instance behavior). 1031692SN/Aclass MetaSimObject(type): 1041427SN/A # Attributes that can be set only at initialization time 1057493Ssteve.reinhardt@amd.com init_keywords = { 'abstract' : bool, 1067493Ssteve.reinhardt@amd.com 'cxx_class' : str, 1077493Ssteve.reinhardt@amd.com 'cxx_type' : str, 1087493Ssteve.reinhardt@amd.com 'cxx_predecls' : list, 1097493Ssteve.reinhardt@amd.com 'swig_objdecls' : list, 1107493Ssteve.reinhardt@amd.com 'swig_predecls' : list, 1117493Ssteve.reinhardt@amd.com 'type' : str } 1121427SN/A # Attributes that can be set any time 1137493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 114679SN/A 115679SN/A # __new__ is called before __init__, and is where the statements 116679SN/A # in the body of the class definition get loaded into the class's 1172740SN/A # __dict__. We intercept this to filter out parameter & port assignments 118679SN/A # and only allow "private" attributes to be passed to the base 119679SN/A # __new__ (starting with underscore). 1201310SN/A def __new__(mcls, name, bases, dict): 1216654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 1224762Snate@binkert.org 1232740SN/A # Copy "private" attributes, functions, and classes to the 1242740SN/A # official dict. Everything else goes in _init_dict to be 1252740SN/A # filtered in __init__. 1262740SN/A cls_dict = {} 1272740SN/A value_dict = {} 1282740SN/A for key,val in dict.items(): 1297493Ssteve.reinhardt@amd.com if key.startswith('_') or isinstance(val, (FunctionType, 1307493Ssteve.reinhardt@amd.com classmethod, 1317493Ssteve.reinhardt@amd.com type)): 1322740SN/A cls_dict[key] = val 1332740SN/A else: 1342740SN/A # must be a param/port setting 1352740SN/A value_dict[key] = val 1364762Snate@binkert.org if 'abstract' not in value_dict: 1374762Snate@binkert.org value_dict['abstract'] = False 1382740SN/A cls_dict['_value_dict'] = value_dict 1394762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 1404762Snate@binkert.org if 'type' in value_dict: 1414762Snate@binkert.org allClasses[name] = cls 1424762Snate@binkert.org return cls 143679SN/A 1442711SN/A # subclass initialization 145679SN/A def __init__(cls, name, bases, dict): 1462711SN/A # calls type.__init__()... I think that's a no-op, but leave 1472711SN/A # it here just in case it's not. 1481692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 1491310SN/A 1501427SN/A # initialize required attributes 1512740SN/A 1522740SN/A # class-only attributes 1532740SN/A cls._params = multidict() # param descriptions 1542740SN/A cls._ports = multidict() # port descriptions 1552740SN/A 1562740SN/A # class or instance attributes 1572740SN/A cls._values = multidict() # param values 1587528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 1593105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 1602740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 1611310SN/A 1621692SN/A # We don't support multiple inheritance. If you want to, you 1631585SN/A # must fix multidict to deal with it properly. 1641692SN/A if len(bases) > 1: 1651692SN/A raise TypeError, "SimObjects do not support multiple inheritance" 1661692SN/A 1671692SN/A base = bases[0] 1681692SN/A 1692740SN/A # Set up general inheritance via multidicts. A subclass will 1702740SN/A # inherit all its settings from the base class. The only time 1712740SN/A # the following is not true is when we define the SimObject 1722740SN/A # class itself (in which case the multidicts have no parent). 1731692SN/A if isinstance(base, MetaSimObject): 1745610Snate@binkert.org cls._base = base 1751692SN/A cls._params.parent = base._params 1762740SN/A cls._ports.parent = base._ports 1771692SN/A cls._values.parent = base._values 1787528Ssteve.reinhardt@amd.com cls._children.parent = base._children 1793105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 1802740SN/A # mark base as having been subclassed 1812712SN/A base._instantiated = True 1825610Snate@binkert.org else: 1835610Snate@binkert.org cls._base = None 1841692SN/A 1854762Snate@binkert.org # default keyword values 1864762Snate@binkert.org if 'type' in cls._value_dict: 1874762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 1885610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 1894762Snate@binkert.org 1905610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 1915610Snate@binkert.org 1924762Snate@binkert.org if 'cxx_predecls' not in cls._value_dict: 1934762Snate@binkert.org # A forward class declaration is sufficient since we are 1944762Snate@binkert.org # just declaring a pointer. 1955610Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 1965610Snate@binkert.org class_path.reverse() 1975610Snate@binkert.org decl = 'class %s;' % class_path[0] 1985610Snate@binkert.org for ns in class_path[1:]: 1995610Snate@binkert.org decl = 'namespace %s { %s }' % (ns, decl) 2004762Snate@binkert.org cls._value_dict['cxx_predecls'] = [decl] 2014762Snate@binkert.org 2024762Snate@binkert.org if 'swig_predecls' not in cls._value_dict: 2034762Snate@binkert.org # A forward class declaration is sufficient since we are 2044762Snate@binkert.org # just declaring a pointer. 2054762Snate@binkert.org cls._value_dict['swig_predecls'] = \ 2064762Snate@binkert.org cls._value_dict['cxx_predecls'] 2074762Snate@binkert.org 2084859Snate@binkert.org if 'swig_objdecls' not in cls._value_dict: 2094859Snate@binkert.org cls._value_dict['swig_objdecls'] = [] 2104859Snate@binkert.org 2112740SN/A # Now process the _value_dict items. They could be defining 2122740SN/A # new (or overriding existing) parameters or ports, setting 2132740SN/A # class keywords (e.g., 'abstract'), or setting parameter 2142740SN/A # values or port bindings. The first 3 can only be set when 2152740SN/A # the class is defined, so we handle them here. The others 2162740SN/A # can be set later too, so just emulate that by calling 2172740SN/A # setattr(). 2182740SN/A for key,val in cls._value_dict.items(): 2191527SN/A # param descriptions 2202740SN/A if isinstance(val, ParamDesc): 2211585SN/A cls._new_param(key, val) 2221427SN/A 2232738SN/A # port objects 2242738SN/A elif isinstance(val, Port): 2253105Sstever@eecs.umich.edu cls._new_port(key, val) 2262738SN/A 2271427SN/A # init-time-only keywords 2281427SN/A elif cls.init_keywords.has_key(key): 2291427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 2301427SN/A 2311427SN/A # default: use normal path (ends up in __setattr__) 2321427SN/A else: 2331427SN/A setattr(cls, key, val) 2341427SN/A 2351427SN/A def _set_keyword(cls, keyword, val, kwtype): 2361427SN/A if not isinstance(val, kwtype): 2371427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 2381427SN/A (keyword, type(val), kwtype) 2397493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 2401427SN/A val = classmethod(val) 2411427SN/A type.__setattr__(cls, keyword, val) 2421427SN/A 2433100SN/A def _new_param(cls, name, pdesc): 2443100SN/A # each param desc should be uniquely assigned to one variable 2453100SN/A assert(not hasattr(pdesc, 'name')) 2463100SN/A pdesc.name = name 2473100SN/A cls._params[name] = pdesc 2483100SN/A if hasattr(pdesc, 'default'): 2493105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 2503105Sstever@eecs.umich.edu 2513105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 2523105Sstever@eecs.umich.edu assert(param.name == name) 2533105Sstever@eecs.umich.edu try: 2543105Sstever@eecs.umich.edu cls._values[name] = param.convert(value) 2553105Sstever@eecs.umich.edu except Exception, e: 2563105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 2573105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 2583105Sstever@eecs.umich.edu e.args = (msg, ) 2593105Sstever@eecs.umich.edu raise 2603105Sstever@eecs.umich.edu 2613105Sstever@eecs.umich.edu def _new_port(cls, name, port): 2623105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 2633105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 2643105Sstever@eecs.umich.edu port.name = name 2653105Sstever@eecs.umich.edu cls._ports[name] = port 2663105Sstever@eecs.umich.edu if hasattr(port, 'default'): 2673105Sstever@eecs.umich.edu cls._cls_get_port_ref(name).connect(port.default) 2683105Sstever@eecs.umich.edu 2693105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 2703105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 2713105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 2723105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 2733105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 2743105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 2753105Sstever@eecs.umich.edu if not ref: 2763105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 2773105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 2783105Sstever@eecs.umich.edu return ref 2791585SN/A 2801310SN/A # Set attribute (called on foo.attr = value when foo is an 2811310SN/A # instance of class cls). 2821310SN/A def __setattr__(cls, attr, value): 2831310SN/A # normal processing for private attributes 2841310SN/A if attr.startswith('_'): 2851310SN/A type.__setattr__(cls, attr, value) 2861310SN/A return 2871310SN/A 2881310SN/A if cls.keywords.has_key(attr): 2891427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 2901310SN/A return 2911310SN/A 2922738SN/A if cls._ports.has_key(attr): 2933105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 2942738SN/A return 2952738SN/A 2962740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 2972740SN/A raise RuntimeError, \ 2982740SN/A "cannot set SimObject parameter '%s' after\n" \ 2992740SN/A " class %s has been instantiated or subclassed" \ 3002740SN/A % (attr, cls.__name__) 3012740SN/A 3022740SN/A # check for param 3033105Sstever@eecs.umich.edu param = cls._params.get(attr) 3041310SN/A if param: 3053105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 3063105Sstever@eecs.umich.edu return 3073105Sstever@eecs.umich.edu 3083105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 3093105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 3107528Ssteve.reinhardt@amd.com cls._children[attr] = coerceSimObjectOrVector(value) 3113105Sstever@eecs.umich.edu return 3123105Sstever@eecs.umich.edu 3133105Sstever@eecs.umich.edu # no valid assignment... raise exception 3143105Sstever@eecs.umich.edu raise AttributeError, \ 3153105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 3161310SN/A 3171585SN/A def __getattr__(cls, attr): 3181692SN/A if cls._values.has_key(attr): 3191692SN/A return cls._values[attr] 3201585SN/A 3217528Ssteve.reinhardt@amd.com if cls._children.has_key(attr): 3227528Ssteve.reinhardt@amd.com return cls._children[attr] 3237528Ssteve.reinhardt@amd.com 3241585SN/A raise AttributeError, \ 3251585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 3261585SN/A 3273100SN/A def __str__(cls): 3283100SN/A return cls.__name__ 3293100SN/A 3303100SN/A def cxx_decl(cls): 3314762Snate@binkert.org code = "#ifndef __PARAMS__%s\n" % cls 3324762Snate@binkert.org code += "#define __PARAMS__%s\n\n" % cls 3334762Snate@binkert.org 3343100SN/A # The 'dict' attribute restricts us to the params declared in 3353100SN/A # the object itself, not including inherited params (which 3363100SN/A # will also be inherited from the base class's param struct 3373100SN/A # here). 3384762Snate@binkert.org params = cls._params.local.values() 3393100SN/A try: 3403100SN/A ptypes = [p.ptype for p in params] 3413100SN/A except: 3423100SN/A print cls, p, p.ptype_str 3433100SN/A print params 3443100SN/A raise 3453100SN/A 3463100SN/A # get a list of lists of predeclaration lines 3474762Snate@binkert.org predecls = [] 3484762Snate@binkert.org predecls.extend(cls.cxx_predecls) 3494762Snate@binkert.org for p in params: 3504762Snate@binkert.org predecls.extend(p.cxx_predecls()) 3514762Snate@binkert.org # remove redundant lines 3524762Snate@binkert.org predecls2 = [] 3534762Snate@binkert.org for pd in predecls: 3544762Snate@binkert.org if pd not in predecls2: 3554762Snate@binkert.org predecls2.append(pd) 3564762Snate@binkert.org predecls2.sort() 3574762Snate@binkert.org code += "\n".join(predecls2) 3584762Snate@binkert.org code += "\n\n"; 3594762Snate@binkert.org 3605610Snate@binkert.org if cls._base: 3615610Snate@binkert.org code += '#include "params/%s.hh"\n\n' % cls._base.type 3624762Snate@binkert.org 3634762Snate@binkert.org for ptype in ptypes: 3644762Snate@binkert.org if issubclass(ptype, Enum): 3654762Snate@binkert.org code += '#include "enums/%s.hh"\n' % ptype.__name__ 3664762Snate@binkert.org code += "\n\n" 3674762Snate@binkert.org 3685610Snate@binkert.org code += cls.cxx_struct(cls._base, params) 3695488Snate@binkert.org 3705488Snate@binkert.org # close #ifndef __PARAMS__* guard 3715488Snate@binkert.org code += "\n#endif\n" 3725488Snate@binkert.org return code 3735488Snate@binkert.org 3745488Snate@binkert.org def cxx_struct(cls, base, params): 3755488Snate@binkert.org if cls == SimObject: 3765488Snate@binkert.org return '#include "sim/sim_object_params.hh"\n' 3775488Snate@binkert.org 3784762Snate@binkert.org # now generate the actual param struct 3795488Snate@binkert.org code = "struct %sParams" % cls 3804762Snate@binkert.org if base: 3815610Snate@binkert.org code += " : public %sParams" % base.type 3824762Snate@binkert.org code += "\n{\n" 3834762Snate@binkert.org if not hasattr(cls, 'abstract') or not cls.abstract: 3844762Snate@binkert.org if 'type' in cls.__dict__: 3854762Snate@binkert.org code += " %s create();\n" % cls.cxx_type 3864762Snate@binkert.org decls = [p.cxx_decl() for p in params] 3874762Snate@binkert.org decls.sort() 3884762Snate@binkert.org code += "".join([" %s\n" % d for d in decls]) 3894762Snate@binkert.org code += "};\n" 3904762Snate@binkert.org 3914762Snate@binkert.org return code 3924762Snate@binkert.org 3934762Snate@binkert.org def swig_decl(cls): 3944762Snate@binkert.org code = '%%module %s\n' % cls 3954762Snate@binkert.org 3964762Snate@binkert.org code += '%{\n' 3974762Snate@binkert.org code += '#include "params/%s.hh"\n' % cls 3984762Snate@binkert.org code += '%}\n\n' 3994762Snate@binkert.org 4004762Snate@binkert.org # The 'dict' attribute restricts us to the params declared in 4014762Snate@binkert.org # the object itself, not including inherited params (which 4024762Snate@binkert.org # will also be inherited from the base class's param struct 4034762Snate@binkert.org # here). 4044762Snate@binkert.org params = cls._params.local.values() 4054762Snate@binkert.org ptypes = [p.ptype for p in params] 4064762Snate@binkert.org 4074762Snate@binkert.org # get a list of lists of predeclaration lines 4084762Snate@binkert.org predecls = [] 4094762Snate@binkert.org predecls.extend([ p.swig_predecls() for p in params ]) 4103100SN/A # flatten 4113100SN/A predecls = reduce(lambda x,y:x+y, predecls, []) 4123100SN/A # remove redundant lines 4133100SN/A predecls2 = [] 4143100SN/A for pd in predecls: 4153100SN/A if pd not in predecls2: 4163100SN/A predecls2.append(pd) 4173100SN/A predecls2.sort() 4183100SN/A code += "\n".join(predecls2) 4193100SN/A code += "\n\n"; 4203100SN/A 4215610Snate@binkert.org if cls._base: 4225610Snate@binkert.org code += '%%import "params/%s.i"\n\n' % cls._base.type 4233100SN/A 4244762Snate@binkert.org for ptype in ptypes: 4254762Snate@binkert.org if issubclass(ptype, Enum): 4264762Snate@binkert.org code += '%%import "enums/%s.hh"\n' % ptype.__name__ 4274762Snate@binkert.org code += "\n\n" 4283100SN/A 4294762Snate@binkert.org code += '%%import "params/%s_type.hh"\n\n' % cls 4303100SN/A code += '%%include "params/%s.hh"\n\n' % cls 4313100SN/A 4323100SN/A return code 4333100SN/A 4342740SN/A# The SimObject class is the root of the special hierarchy. Most of 435679SN/A# the code in this class deals with the configuration hierarchy itself 436679SN/A# (parent/child node relationships). 4371692SN/Aclass SimObject(object): 4381692SN/A # Specify metaclass. Any class inheriting from SimObject will 439679SN/A # get this metaclass. 4401692SN/A __metaclass__ = MetaSimObject 4413100SN/A type = 'SimObject' 4424762Snate@binkert.org abstract = True 4433100SN/A 4444859Snate@binkert.org swig_objdecls = [ '%include "python/swig/sim_object.i"' ] 445679SN/A 4462740SN/A # Initialize new instance. For objects with SimObject-valued 4472740SN/A # children, we need to recursively clone the classes represented 4482740SN/A # by those param values as well in a consistent "deep copy"-style 4492740SN/A # fashion. That is, we want to make sure that each instance is 4502740SN/A # cloned only once, and that if there are multiple references to 4512740SN/A # the same original object, we end up with the corresponding 4522740SN/A # cloned references all pointing to the same cloned instance. 4532740SN/A def __init__(self, **kwargs): 4542740SN/A ancestor = kwargs.get('_ancestor') 4552740SN/A memo_dict = kwargs.get('_memo') 4562740SN/A if memo_dict is None: 4572740SN/A # prepare to memoize any recursively instantiated objects 4582740SN/A memo_dict = {} 4592740SN/A elif ancestor: 4602740SN/A # memoize me now to avoid problems with recursive calls 4612740SN/A memo_dict[ancestor] = self 4622711SN/A 4632740SN/A if not ancestor: 4642740SN/A ancestor = self.__class__ 4652740SN/A ancestor._instantiated = True 4662711SN/A 4672740SN/A # initialize required attributes 4682740SN/A self._parent = None 4697528Ssteve.reinhardt@amd.com self._name = None 4702740SN/A self._ccObject = None # pointer to C++ object 4714762Snate@binkert.org self._ccParams = None 4722740SN/A self._instantiated = False # really "cloned" 4732712SN/A 4742711SN/A # Inherit parameter values from class using multidict so 4757528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 4767528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 4772740SN/A self._values = multidict(ancestor._values) 4782740SN/A # clone SimObject-valued parameters 4792740SN/A for key,val in ancestor._values.iteritems(): 4807528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 4817528Ssteve.reinhardt@amd.com if val is not None: 4827528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 4837528Ssteve.reinhardt@amd.com 4847528Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 4857528Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 4867528Ssteve.reinhardt@amd.com self._children = {} 4877528Ssteve.reinhardt@amd.com for key,val in ancestor._children.iteritems(): 4887528Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 4897528Ssteve.reinhardt@amd.com 4902740SN/A # clone port references. no need to use a multidict here 4912740SN/A # since we will be creating new references for all ports. 4923105Sstever@eecs.umich.edu self._port_refs = {} 4933105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 4943105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 4951692SN/A # apply attribute assignments from keyword args, if any 4961692SN/A for key,val in kwargs.iteritems(): 4971692SN/A setattr(self, key, val) 498679SN/A 4992740SN/A # "Clone" the current instance by creating another instance of 5002740SN/A # this instance's class, but that inherits its parameter values 5012740SN/A # and port mappings from the current instance. If we're in a 5022740SN/A # "deep copy" recursive clone, check the _memo dict to see if 5032740SN/A # we've already cloned this instance. 5041692SN/A def __call__(self, **kwargs): 5052740SN/A memo_dict = kwargs.get('_memo') 5062740SN/A if memo_dict is None: 5072740SN/A # no memo_dict: must be top-level clone operation. 5082740SN/A # this is only allowed at the root of a hierarchy 5092740SN/A if self._parent: 5102740SN/A raise RuntimeError, "attempt to clone object %s " \ 5112740SN/A "not at the root of a tree (parent = %s)" \ 5122740SN/A % (self, self._parent) 5132740SN/A # create a new dict and use that. 5142740SN/A memo_dict = {} 5152740SN/A kwargs['_memo'] = memo_dict 5162740SN/A elif memo_dict.has_key(self): 5172740SN/A # clone already done & memoized 5182740SN/A return memo_dict[self] 5192740SN/A return self.__class__(_ancestor = self, **kwargs) 5201343SN/A 5213105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 5223105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 5233105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 5243105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 5253105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 5263105Sstever@eecs.umich.edu if not ref: 5273105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 5283105Sstever@eecs.umich.edu self._port_refs[attr] = ref 5293105Sstever@eecs.umich.edu return ref 5303105Sstever@eecs.umich.edu 5311692SN/A def __getattr__(self, attr): 5322738SN/A if self._ports.has_key(attr): 5333105Sstever@eecs.umich.edu return self._get_port_ref(attr) 5342738SN/A 5351692SN/A if self._values.has_key(attr): 5361692SN/A return self._values[attr] 5371427SN/A 5387528Ssteve.reinhardt@amd.com if self._children.has_key(attr): 5397528Ssteve.reinhardt@amd.com return self._children[attr] 5407528Ssteve.reinhardt@amd.com 5417500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 5427500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 5437500Ssteve.reinhardt@amd.com # SWIG-wrapped methods such as init(), regStats(), 5447527Ssteve.reinhardt@amd.com # regFormulas(), resetStats(), startup(), drain(), and 5457527Ssteve.reinhardt@amd.com # resume(). 5467500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 5477500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 5487500Ssteve.reinhardt@amd.com 5491692SN/A raise AttributeError, "object '%s' has no attribute '%s'" \ 5501692SN/A % (self.__class__.__name__, attr) 5511427SN/A 5521692SN/A # Set attribute (called on foo.attr = value when foo is an 5531692SN/A # instance of class cls). 5541692SN/A def __setattr__(self, attr, value): 5551692SN/A # normal processing for private attributes 5561692SN/A if attr.startswith('_'): 5571692SN/A object.__setattr__(self, attr, value) 5581692SN/A return 5591427SN/A 5602738SN/A if self._ports.has_key(attr): 5612738SN/A # set up port connection 5623105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 5632738SN/A return 5642738SN/A 5652740SN/A if isSimObjectOrSequence(value) and self._instantiated: 5662740SN/A raise RuntimeError, \ 5672740SN/A "cannot set SimObject parameter '%s' after\n" \ 5682740SN/A " instance been cloned %s" % (attr, `self`) 5692740SN/A 5703105Sstever@eecs.umich.edu param = self._params.get(attr) 5711692SN/A if param: 5721310SN/A try: 5731692SN/A value = param.convert(value) 5741587SN/A except Exception, e: 5751692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 5761692SN/A (e, self.__class__.__name__, attr, value) 5771605SN/A e.args = (msg, ) 5781605SN/A raise 5797528Ssteve.reinhardt@amd.com self._values[attr] = value 5803105Sstever@eecs.umich.edu return 5811310SN/A 5827528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 5833105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 5847528Ssteve.reinhardt@amd.com self.add_child(attr, value) 5853105Sstever@eecs.umich.edu return 5861693SN/A 5873105Sstever@eecs.umich.edu # no valid assignment... raise exception 5883105Sstever@eecs.umich.edu raise AttributeError, "Class %s has no parameter %s" \ 5893105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 5901310SN/A 5911310SN/A 5921692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 5931692SN/A # not be vectors, and always getting the first element (e.g. cpus) 5941692SN/A def __getitem__(self, key): 5951692SN/A if key == 0: 5961692SN/A return self 5971692SN/A raise TypeError, "Non-zero index '%s' to SimObject" % key 5981310SN/A 5997528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6007528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 6017528Ssteve.reinhardt@amd.com assert self._parent is old_parent 6027528Ssteve.reinhardt@amd.com self._parent = None 6037528Ssteve.reinhardt@amd.com 6047528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6057528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 6067528Ssteve.reinhardt@amd.com self._parent = parent 6077528Ssteve.reinhardt@amd.com self._name = name 6087528Ssteve.reinhardt@amd.com 6097528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6107528Ssteve.reinhardt@amd.com def get_name(self): 6117528Ssteve.reinhardt@amd.com return self._name 6127528Ssteve.reinhardt@amd.com 6137528Ssteve.reinhardt@amd.com # use this rather than directly accessing _parent for symmetry 6147528Ssteve.reinhardt@amd.com # with SimObjectVector 6157528Ssteve.reinhardt@amd.com def get_parent(self): 6167528Ssteve.reinhardt@amd.com return self._parent 6177528Ssteve.reinhardt@amd.com 6187528Ssteve.reinhardt@amd.com # clear out child with given name 6191693SN/A def clear_child(self, name): 6201693SN/A child = self._children[name] 6217528Ssteve.reinhardt@amd.com child.clear_parent(self) 6221693SN/A del self._children[name] 6231693SN/A 6247528Ssteve.reinhardt@amd.com # Add a new child to this object. 6257528Ssteve.reinhardt@amd.com def add_child(self, name, child): 6267528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 6277528Ssteve.reinhardt@amd.com if child.get_parent(): 6287528Ssteve.reinhardt@amd.com raise RuntimeError, \ 6297528Ssteve.reinhardt@amd.com "add_child('%s'): child '%s' already has parent '%s'" % \ 6307528Ssteve.reinhardt@amd.com (name, child._name, child._parent) 6317528Ssteve.reinhardt@amd.com if self._children.has_key(name): 6327528Ssteve.reinhardt@amd.com clear_child(name) 6337528Ssteve.reinhardt@amd.com child.set_parent(self, name) 6347528Ssteve.reinhardt@amd.com self._children[name] = child 6351310SN/A 6367528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 6377528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 6387528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 6397528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 6407528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 6417528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 6427528Ssteve.reinhardt@amd.com for key,val in self._values.iteritems(): 6437528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 6447528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 6457528Ssteve.reinhardt@amd.com # SimObjectVector class so we can call get_parent() 6467528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 6477528Ssteve.reinhardt@amd.com self._values[key] = val 6487528Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.get_parent(): 6497528Ssteve.reinhardt@amd.com self.add_child(key, val) 6503105Sstever@eecs.umich.edu 6511692SN/A def path(self): 6522740SN/A if not self._parent: 6537525Ssteve.reinhardt@amd.com return '(orphan)' 6541692SN/A ppath = self._parent.path() 6551692SN/A if ppath == 'root': 6561692SN/A return self._name 6571692SN/A return ppath + "." + self._name 6581310SN/A 6591692SN/A def __str__(self): 6601692SN/A return self.path() 6611310SN/A 6621692SN/A def ini_str(self): 6631692SN/A return self.path() 6641310SN/A 6651692SN/A def find_any(self, ptype): 6661692SN/A if isinstance(self, ptype): 6671692SN/A return self, True 6681310SN/A 6691692SN/A found_obj = None 6701692SN/A for child in self._children.itervalues(): 6711692SN/A if isinstance(child, ptype): 6721692SN/A if found_obj != None and child != found_obj: 6731692SN/A raise AttributeError, \ 6741692SN/A 'parent.any matched more than one: %s %s' % \ 6751814SN/A (found_obj.path, child.path) 6761692SN/A found_obj = child 6771692SN/A # search param space 6781692SN/A for pname,pdesc in self._params.iteritems(): 6791692SN/A if issubclass(pdesc.ptype, ptype): 6801692SN/A match_obj = self._values[pname] 6811692SN/A if found_obj != None and found_obj != match_obj: 6821692SN/A raise AttributeError, \ 6835952Ssaidi@eecs.umich.edu 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 6841692SN/A found_obj = match_obj 6851692SN/A return found_obj, found_obj != None 6861692SN/A 6871815SN/A def unproxy(self, base): 6881815SN/A return self 6891815SN/A 6907527Ssteve.reinhardt@amd.com def unproxyParams(self): 6913105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 6923105Sstever@eecs.umich.edu value = self._values.get(param) 6936654Snate@binkert.org if value != None and isproxy(value): 6943105Sstever@eecs.umich.edu try: 6953105Sstever@eecs.umich.edu value = value.unproxy(self) 6963105Sstever@eecs.umich.edu except: 6973105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 6983105Sstever@eecs.umich.edu (param, self.path()) 6993105Sstever@eecs.umich.edu raise 7003105Sstever@eecs.umich.edu setattr(self, param, value) 7013105Sstever@eecs.umich.edu 7023107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 7033107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 7043107Sstever@eecs.umich.edu port_names = self._ports.keys() 7053107Sstever@eecs.umich.edu port_names.sort() 7063107Sstever@eecs.umich.edu for port_name in port_names: 7073105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 7083105Sstever@eecs.umich.edu if port != None: 7093105Sstever@eecs.umich.edu port.unproxy(self) 7103105Sstever@eecs.umich.edu 7115037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 7125543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 7131692SN/A 7142738SN/A instanceDict[self.path()] = self 7152738SN/A 7164081Sbinkertn@umich.edu if hasattr(self, 'type'): 7175037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 7181692SN/A 7191692SN/A child_names = self._children.keys() 7201692SN/A child_names.sort() 7214081Sbinkertn@umich.edu if len(child_names): 7227528Ssteve.reinhardt@amd.com print >>ini_file, 'children=%s' % \ 7237528Ssteve.reinhardt@amd.com ' '.join(self._children[n].get_name() for n in child_names) 7241692SN/A 7251692SN/A param_names = self._params.keys() 7261692SN/A param_names.sort() 7271692SN/A for param in param_names: 7283105Sstever@eecs.umich.edu value = self._values.get(param) 7291692SN/A if value != None: 7305037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 7315037Smilesck@eecs.umich.edu self._values[param].ini_str()) 7321692SN/A 7333103Sstever@eecs.umich.edu port_names = self._ports.keys() 7343103Sstever@eecs.umich.edu port_names.sort() 7353103Sstever@eecs.umich.edu for port_name in port_names: 7363105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 7373105Sstever@eecs.umich.edu if port != None: 7385037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 7393103Sstever@eecs.umich.edu 7405543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 7411692SN/A 7424762Snate@binkert.org def getCCParams(self): 7434762Snate@binkert.org if self._ccParams: 7444762Snate@binkert.org return self._ccParams 7454762Snate@binkert.org 7465033Smilesck@eecs.umich.edu cc_params_struct = getattr(m5.objects.params, '%sParams' % self.type) 7474762Snate@binkert.org cc_params = cc_params_struct() 7485488Snate@binkert.org cc_params.pyobj = self 7494762Snate@binkert.org cc_params.name = str(self) 7504762Snate@binkert.org 7514762Snate@binkert.org param_names = self._params.keys() 7524762Snate@binkert.org param_names.sort() 7534762Snate@binkert.org for param in param_names: 7544762Snate@binkert.org value = self._values.get(param) 7554762Snate@binkert.org if value is None: 7566654Snate@binkert.org fatal("%s.%s without default or user set value", 7576654Snate@binkert.org self.path(), param) 7584762Snate@binkert.org 7594762Snate@binkert.org value = value.getValue() 7604762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 7614762Snate@binkert.org assert isinstance(value, list) 7624762Snate@binkert.org vec = getattr(cc_params, param) 7634762Snate@binkert.org assert not len(vec) 7644762Snate@binkert.org for v in value: 7654762Snate@binkert.org vec.append(v) 7664762Snate@binkert.org else: 7674762Snate@binkert.org setattr(cc_params, param, value) 7684762Snate@binkert.org 7694762Snate@binkert.org port_names = self._ports.keys() 7704762Snate@binkert.org port_names.sort() 7714762Snate@binkert.org for port_name in port_names: 7724762Snate@binkert.org port = self._port_refs.get(port_name, None) 7734762Snate@binkert.org if port != None: 7744762Snate@binkert.org setattr(cc_params, port_name, port) 7754762Snate@binkert.org self._ccParams = cc_params 7764762Snate@binkert.org return self._ccParams 7772738SN/A 7782740SN/A # Get C++ object corresponding to this object, calling C++ if 7792740SN/A # necessary to construct it. Does *not* recursively create 7802740SN/A # children. 7812740SN/A def getCCObject(self): 7822740SN/A if not self._ccObject: 7837526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 7847526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 7857526Ssteve.reinhardt@amd.com raise RuntimeError, "Attempt to instantiate orphan node" 7867526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 7875244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 7885244Sgblack@eecs.umich.edu self._ccObject = -1 7895244Sgblack@eecs.umich.edu params = self.getCCParams() 7904762Snate@binkert.org self._ccObject = params.create() 7912740SN/A elif self._ccObject == -1: 7927526Ssteve.reinhardt@amd.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 7932740SN/A % self.path() 7942740SN/A return self._ccObject 7952740SN/A 7967527Ssteve.reinhardt@amd.com def descendants(self): 7977527Ssteve.reinhardt@amd.com yield self 7987527Ssteve.reinhardt@amd.com for child in self._children.itervalues(): 7997527Ssteve.reinhardt@amd.com for obj in child.descendants(): 8007527Ssteve.reinhardt@amd.com yield obj 8017527Ssteve.reinhardt@amd.com 8027527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 8034762Snate@binkert.org def createCCObject(self): 8044762Snate@binkert.org self.getCCParams() 8054762Snate@binkert.org self.getCCObject() # force creation 8064762Snate@binkert.org 8074762Snate@binkert.org def getValue(self): 8084762Snate@binkert.org return self.getCCObject() 8094762Snate@binkert.org 8102738SN/A # Create C++ port connections corresponding to the connections in 8117527Ssteve.reinhardt@amd.com # _port_refs 8122738SN/A def connectPorts(self): 8133105Sstever@eecs.umich.edu for portRef in self._port_refs.itervalues(): 8143105Sstever@eecs.umich.edu portRef.ccConnect() 8152797SN/A 8164553Sbinkertn@umich.edu def getMemoryMode(self): 8174553Sbinkertn@umich.edu if not isinstance(self, m5.objects.System): 8184553Sbinkertn@umich.edu return None 8194553Sbinkertn@umich.edu 8204859Snate@binkert.org return self._ccObject.getMemoryMode() 8214553Sbinkertn@umich.edu 8222797SN/A def changeTiming(self, mode): 8233202Shsul@eecs.umich.edu if isinstance(self, m5.objects.System): 8243202Shsul@eecs.umich.edu # i don't know if there's a better way to do this - calling 8253202Shsul@eecs.umich.edu # setMemoryMode directly from self._ccObject results in calling 8263202Shsul@eecs.umich.edu # SimObject::setMemoryMode, not the System::setMemoryMode 8274859Snate@binkert.org self._ccObject.setMemoryMode(mode) 8282797SN/A 8292797SN/A def takeOverFrom(self, old_cpu): 8304859Snate@binkert.org self._ccObject.takeOverFrom(old_cpu._ccObject) 8312797SN/A 8321692SN/A # generate output file for 'dot' to display as a pretty graph. 8331692SN/A # this code is currently broken. 8341342SN/A def outputDot(self, dot): 8351342SN/A label = "{%s|" % self.path 8361342SN/A if isSimObject(self.realtype): 8371342SN/A label += '%s|' % self.type 8381342SN/A 8391342SN/A if self.children: 8401342SN/A # instantiate children in same order they were added for 8411342SN/A # backward compatibility (else we can end up with cpu1 8421342SN/A # before cpu0). 8431342SN/A for c in self.children: 8441342SN/A dot.add_edge(pydot.Edge(self.path,c.path, style="bold")) 8451342SN/A 8461342SN/A simobjs = [] 8471342SN/A for param in self.params: 8481342SN/A try: 8491342SN/A if param.value is None: 8501342SN/A raise AttributeError, 'Parameter with no value' 8511342SN/A 8521692SN/A value = param.value 8531342SN/A string = param.string(value) 8541587SN/A except Exception, e: 8551605SN/A msg = 'exception in %s:%s\n%s' % (self.name, param.name, e) 8561605SN/A e.args = (msg, ) 8571342SN/A raise 8581605SN/A 8591692SN/A if isSimObject(param.ptype) and string != "Null": 8601342SN/A simobjs.append(string) 8611342SN/A else: 8621342SN/A label += '%s = %s\\n' % (param.name, string) 8631342SN/A 8641342SN/A for so in simobjs: 8651342SN/A label += "|<%s> %s" % (so, so) 8661587SN/A dot.add_edge(pydot.Edge("%s:%s" % (self.path, so), so, 8671587SN/A tailport="w")) 8681342SN/A label += '}' 8691342SN/A dot.add_node(pydot.Node(self.path,shape="Mrecord",label=label)) 8701342SN/A 8711342SN/A # recursively dump out children 8721342SN/A for c in self.children: 8731342SN/A c.outputDot(dot) 8741342SN/A 8753101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 8763101Sstever@eecs.umich.edudef resolveSimObject(name): 8773101Sstever@eecs.umich.edu obj = instanceDict[name] 8783101Sstever@eecs.umich.edu return obj.getCCObject() 879679SN/A 8806654Snate@binkert.orgdef isSimObject(value): 8816654Snate@binkert.org return isinstance(value, SimObject) 8826654Snate@binkert.org 8836654Snate@binkert.orgdef isSimObjectClass(value): 8846654Snate@binkert.org return issubclass(value, SimObject) 8856654Snate@binkert.org 8867528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 8877528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 8887528Ssteve.reinhardt@amd.com 8896654Snate@binkert.orgdef isSimObjectSequence(value): 8906654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 8916654Snate@binkert.org return False 8926654Snate@binkert.org 8936654Snate@binkert.org for val in value: 8946654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 8956654Snate@binkert.org return False 8966654Snate@binkert.org 8976654Snate@binkert.org return True 8986654Snate@binkert.org 8996654Snate@binkert.orgdef isSimObjectOrSequence(value): 9006654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 9016654Snate@binkert.org 9027526Ssteve.reinhardt@amd.comdef isRoot(obj): 9037526Ssteve.reinhardt@amd.com from m5.objects import Root 9047526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 9057526Ssteve.reinhardt@amd.com 9067528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 9077528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 9087528Ssteve.reinhardt@amd.com 9097528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 9107528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 9117528Ssteve.reinhardt@amd.com return value 9127528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 9137528Ssteve.reinhardt@amd.com return SimObjectVector(value) 9147528Ssteve.reinhardt@amd.com return None 9157528Ssteve.reinhardt@amd.com 9167528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 9177528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 9187528Ssteve.reinhardt@amd.com if value is None: 9197528Ssteve.reinhardt@amd.com raise TypeError, "SimObject or SimObjectVector expected" 9207528Ssteve.reinhardt@amd.com return value 9217528Ssteve.reinhardt@amd.com 9226654Snate@binkert.orgbaseClasses = allClasses.copy() 9236654Snate@binkert.orgbaseInstances = instanceDict.copy() 9246654Snate@binkert.org 9256654Snate@binkert.orgdef clear(): 9266654Snate@binkert.org global allClasses, instanceDict 9276654Snate@binkert.org 9286654Snate@binkert.org allClasses = baseClasses.copy() 9296654Snate@binkert.org instanceDict = baseInstances.copy() 9306654Snate@binkert.org 9311528SN/A# __all__ defines the list of symbols that get exported when 9321528SN/A# 'from config import *' is invoked. Try to keep this reasonably 9331528SN/A# short to avoid polluting other namespaces. 9344762Snate@binkert.org__all__ = [ 'SimObject' ] 935