SimObject.py revision 5610
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 303101Sstever@eecs.umich.eduimport sys, types 311438SN/A 324762Snate@binkert.orgimport proxy 334762Snate@binkert.orgimport m5 343102Sstever@eecs.umich.edufrom util import * 351438SN/A 363102Sstever@eecs.umich.edu# These utility functions have to come first because they're 373102Sstever@eecs.umich.edu# referenced in params.py... otherwise they won't be defined when we 383102Sstever@eecs.umich.edu# import params below, and the recursive import of this file from 393102Sstever@eecs.umich.edu# params.py will not find these names. 403102Sstever@eecs.umich.edudef isSimObject(value): 413102Sstever@eecs.umich.edu return isinstance(value, SimObject) 423102Sstever@eecs.umich.edu 433102Sstever@eecs.umich.edudef isSimObjectClass(value): 443102Sstever@eecs.umich.edu return issubclass(value, SimObject) 453102Sstever@eecs.umich.edu 463102Sstever@eecs.umich.edudef isSimObjectSequence(value): 473102Sstever@eecs.umich.edu if not isinstance(value, (list, tuple)) or len(value) == 0: 483102Sstever@eecs.umich.edu return False 493102Sstever@eecs.umich.edu 503102Sstever@eecs.umich.edu for val in value: 513102Sstever@eecs.umich.edu if not isNullPointer(val) and not isSimObject(val): 523102Sstever@eecs.umich.edu return False 533102Sstever@eecs.umich.edu 543102Sstever@eecs.umich.edu return True 553102Sstever@eecs.umich.edu 563102Sstever@eecs.umich.edudef isSimObjectOrSequence(value): 573102Sstever@eecs.umich.edu return isSimObject(value) or isSimObjectSequence(value) 583102Sstever@eecs.umich.edu 593102Sstever@eecs.umich.edu# Have to import params up top since Param is referenced on initial 603102Sstever@eecs.umich.edu# load (when SimObject class references Param to create a class 613102Sstever@eecs.umich.edu# variable, the 'name' param)... 623102Sstever@eecs.umich.edufrom params import * 633102Sstever@eecs.umich.edu# There are a few things we need that aren't in params.__all__ since 643102Sstever@eecs.umich.edu# normal users don't need them 654762Snate@binkert.orgfrom params import ParamDesc, VectorParamDesc, isNullPointer, SimObjVector 663102Sstever@eecs.umich.edu 671342SN/AnoDot = False 681342SN/Atry: 691378SN/A import pydot 701342SN/Aexcept: 711378SN/A noDot = True 72679SN/A 73679SN/A##################################################################### 74679SN/A# 75679SN/A# M5 Python Configuration Utility 76679SN/A# 77679SN/A# The basic idea is to write simple Python programs that build Python 781692SN/A# objects corresponding to M5 SimObjects for the desired simulation 79679SN/A# configuration. For now, the Python emits a .ini file that can be 80679SN/A# parsed by M5. In the future, some tighter integration between M5 81679SN/A# and the Python interpreter may allow bypassing the .ini file. 82679SN/A# 83679SN/A# Each SimObject class in M5 is represented by a Python class with the 84679SN/A# same name. The Python inheritance tree mirrors the M5 C++ tree 85679SN/A# (e.g., SimpleCPU derives from BaseCPU in both cases, and all 86679SN/A# SimObjects inherit from a single SimObject base class). To specify 87679SN/A# an instance of an M5 SimObject in a configuration, the user simply 88679SN/A# instantiates the corresponding Python object. The parameters for 89679SN/A# that SimObject are given by assigning to attributes of the Python 90679SN/A# object, either using keyword assignment in the constructor or in 91679SN/A# separate assignment statements. For example: 92679SN/A# 931692SN/A# cache = BaseCache(size='64KB') 94679SN/A# cache.hit_latency = 3 95679SN/A# cache.assoc = 8 96679SN/A# 97679SN/A# The magic lies in the mapping of the Python attributes for SimObject 98679SN/A# classes to the actual SimObject parameter specifications. This 99679SN/A# allows parameter validity checking in the Python code. Continuing 100679SN/A# the example above, the statements "cache.blurfl=3" or 101679SN/A# "cache.assoc='hello'" would both result in runtime errors in Python, 102679SN/A# since the BaseCache object has no 'blurfl' parameter and the 'assoc' 103679SN/A# parameter requires an integer, respectively. This magic is done 104679SN/A# primarily by overriding the special __setattr__ method that controls 105679SN/A# assignment to object attributes. 106679SN/A# 107679SN/A# Once a set of Python objects have been instantiated in a hierarchy, 108679SN/A# calling 'instantiate(obj)' (where obj is the root of the hierarchy) 1092740SN/A# will generate a .ini file. 110679SN/A# 111679SN/A##################################################################### 112679SN/A 1134762Snate@binkert.org# list of all SimObject classes 1144762Snate@binkert.orgallClasses = {} 1154762Snate@binkert.org 1162738SN/A# dict to look up SimObjects based on path 1172738SN/AinstanceDict = {} 1182738SN/A 1192740SN/A# The metaclass for SimObject. This class controls how new classes 1202740SN/A# that derive from SimObject are instantiated, and provides inherited 1212740SN/A# class behavior (just like a class controls how instances of that 1222740SN/A# class are instantiated, and provides inherited instance behavior). 1231692SN/Aclass MetaSimObject(type): 1241427SN/A # Attributes that can be set only at initialization time 1251692SN/A init_keywords = { 'abstract' : types.BooleanType, 1264762Snate@binkert.org 'cxx_class' : types.StringType, 1274762Snate@binkert.org 'cxx_type' : types.StringType, 1284762Snate@binkert.org 'cxx_predecls' : types.ListType, 1294859Snate@binkert.org 'swig_objdecls' : types.ListType, 1304762Snate@binkert.org 'swig_predecls' : types.ListType, 1311692SN/A 'type' : types.StringType } 1321427SN/A # Attributes that can be set any time 1334762Snate@binkert.org keywords = { 'check' : types.FunctionType } 134679SN/A 135679SN/A # __new__ is called before __init__, and is where the statements 136679SN/A # in the body of the class definition get loaded into the class's 1372740SN/A # __dict__. We intercept this to filter out parameter & port assignments 138679SN/A # and only allow "private" attributes to be passed to the base 139679SN/A # __new__ (starting with underscore). 1401310SN/A def __new__(mcls, name, bases, dict): 1414762Snate@binkert.org assert name not in allClasses 1424762Snate@binkert.org 1432740SN/A # Copy "private" attributes, functions, and classes to the 1442740SN/A # official dict. Everything else goes in _init_dict to be 1452740SN/A # filtered in __init__. 1462740SN/A cls_dict = {} 1472740SN/A value_dict = {} 1482740SN/A for key,val in dict.items(): 1492740SN/A if key.startswith('_') or isinstance(val, (types.FunctionType, 1502740SN/A types.TypeType)): 1512740SN/A cls_dict[key] = val 1522740SN/A else: 1532740SN/A # must be a param/port setting 1542740SN/A value_dict[key] = val 1554762Snate@binkert.org if 'abstract' not in value_dict: 1564762Snate@binkert.org value_dict['abstract'] = False 1572740SN/A cls_dict['_value_dict'] = value_dict 1584762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 1594762Snate@binkert.org if 'type' in value_dict: 1604762Snate@binkert.org allClasses[name] = cls 1614762Snate@binkert.org return cls 162679SN/A 1632711SN/A # subclass initialization 164679SN/A def __init__(cls, name, bases, dict): 1652711SN/A # calls type.__init__()... I think that's a no-op, but leave 1662711SN/A # it here just in case it's not. 1671692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 1681310SN/A 1691427SN/A # initialize required attributes 1702740SN/A 1712740SN/A # class-only attributes 1722740SN/A cls._params = multidict() # param descriptions 1732740SN/A cls._ports = multidict() # port descriptions 1742740SN/A 1752740SN/A # class or instance attributes 1762740SN/A cls._values = multidict() # param values 1773105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 1782740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 1791310SN/A 1801692SN/A # We don't support multiple inheritance. If you want to, you 1811585SN/A # must fix multidict to deal with it properly. 1821692SN/A if len(bases) > 1: 1831692SN/A raise TypeError, "SimObjects do not support multiple inheritance" 1841692SN/A 1851692SN/A base = bases[0] 1861692SN/A 1872740SN/A # Set up general inheritance via multidicts. A subclass will 1882740SN/A # inherit all its settings from the base class. The only time 1892740SN/A # the following is not true is when we define the SimObject 1902740SN/A # class itself (in which case the multidicts have no parent). 1911692SN/A if isinstance(base, MetaSimObject): 1925610Snate@binkert.org cls._base = base 1931692SN/A cls._params.parent = base._params 1942740SN/A cls._ports.parent = base._ports 1951692SN/A cls._values.parent = base._values 1963105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 1972740SN/A # mark base as having been subclassed 1982712SN/A base._instantiated = True 1995610Snate@binkert.org else: 2005610Snate@binkert.org cls._base = None 2011692SN/A 2024762Snate@binkert.org # default keyword values 2034762Snate@binkert.org if 'type' in cls._value_dict: 2044762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 2055610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 2064762Snate@binkert.org 2075610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 2085610Snate@binkert.org 2094762Snate@binkert.org if 'cxx_predecls' not in cls._value_dict: 2104762Snate@binkert.org # A forward class declaration is sufficient since we are 2114762Snate@binkert.org # just declaring a pointer. 2125610Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 2135610Snate@binkert.org class_path.reverse() 2145610Snate@binkert.org decl = 'class %s;' % class_path[0] 2155610Snate@binkert.org for ns in class_path[1:]: 2165610Snate@binkert.org decl = 'namespace %s { %s }' % (ns, decl) 2174762Snate@binkert.org cls._value_dict['cxx_predecls'] = [decl] 2184762Snate@binkert.org 2194762Snate@binkert.org if 'swig_predecls' not in cls._value_dict: 2204762Snate@binkert.org # A forward class declaration is sufficient since we are 2214762Snate@binkert.org # just declaring a pointer. 2224762Snate@binkert.org cls._value_dict['swig_predecls'] = \ 2234762Snate@binkert.org cls._value_dict['cxx_predecls'] 2244762Snate@binkert.org 2254859Snate@binkert.org if 'swig_objdecls' not in cls._value_dict: 2264859Snate@binkert.org cls._value_dict['swig_objdecls'] = [] 2274859Snate@binkert.org 2282740SN/A # Now process the _value_dict items. They could be defining 2292740SN/A # new (or overriding existing) parameters or ports, setting 2302740SN/A # class keywords (e.g., 'abstract'), or setting parameter 2312740SN/A # values or port bindings. The first 3 can only be set when 2322740SN/A # the class is defined, so we handle them here. The others 2332740SN/A # can be set later too, so just emulate that by calling 2342740SN/A # setattr(). 2352740SN/A for key,val in cls._value_dict.items(): 2361527SN/A # param descriptions 2372740SN/A if isinstance(val, ParamDesc): 2381585SN/A cls._new_param(key, val) 2391427SN/A 2402738SN/A # port objects 2412738SN/A elif isinstance(val, Port): 2423105Sstever@eecs.umich.edu cls._new_port(key, val) 2432738SN/A 2441427SN/A # init-time-only keywords 2451427SN/A elif cls.init_keywords.has_key(key): 2461427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 2471427SN/A 2481427SN/A # default: use normal path (ends up in __setattr__) 2491427SN/A else: 2501427SN/A setattr(cls, key, val) 2511427SN/A 2521427SN/A def _set_keyword(cls, keyword, val, kwtype): 2531427SN/A if not isinstance(val, kwtype): 2541427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 2551427SN/A (keyword, type(val), kwtype) 2561427SN/A if isinstance(val, types.FunctionType): 2571427SN/A val = classmethod(val) 2581427SN/A type.__setattr__(cls, keyword, val) 2591427SN/A 2603100SN/A def _new_param(cls, name, pdesc): 2613100SN/A # each param desc should be uniquely assigned to one variable 2623100SN/A assert(not hasattr(pdesc, 'name')) 2633100SN/A pdesc.name = name 2643100SN/A cls._params[name] = pdesc 2653100SN/A if hasattr(pdesc, 'default'): 2663105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 2673105Sstever@eecs.umich.edu 2683105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 2693105Sstever@eecs.umich.edu assert(param.name == name) 2703105Sstever@eecs.umich.edu try: 2713105Sstever@eecs.umich.edu cls._values[name] = param.convert(value) 2723105Sstever@eecs.umich.edu except Exception, e: 2733105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 2743105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 2753105Sstever@eecs.umich.edu e.args = (msg, ) 2763105Sstever@eecs.umich.edu raise 2773105Sstever@eecs.umich.edu 2783105Sstever@eecs.umich.edu def _new_port(cls, name, port): 2793105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 2803105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 2813105Sstever@eecs.umich.edu port.name = name 2823105Sstever@eecs.umich.edu cls._ports[name] = port 2833105Sstever@eecs.umich.edu if hasattr(port, 'default'): 2843105Sstever@eecs.umich.edu cls._cls_get_port_ref(name).connect(port.default) 2853105Sstever@eecs.umich.edu 2863105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 2873105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 2883105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 2893105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 2903105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 2913105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 2923105Sstever@eecs.umich.edu if not ref: 2933105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 2943105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 2953105Sstever@eecs.umich.edu return ref 2961585SN/A 2971310SN/A # Set attribute (called on foo.attr = value when foo is an 2981310SN/A # instance of class cls). 2991310SN/A def __setattr__(cls, attr, value): 3001310SN/A # normal processing for private attributes 3011310SN/A if attr.startswith('_'): 3021310SN/A type.__setattr__(cls, attr, value) 3031310SN/A return 3041310SN/A 3051310SN/A if cls.keywords.has_key(attr): 3061427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 3071310SN/A return 3081310SN/A 3092738SN/A if cls._ports.has_key(attr): 3103105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 3112738SN/A return 3122738SN/A 3132740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 3142740SN/A raise RuntimeError, \ 3152740SN/A "cannot set SimObject parameter '%s' after\n" \ 3162740SN/A " class %s has been instantiated or subclassed" \ 3172740SN/A % (attr, cls.__name__) 3182740SN/A 3192740SN/A # check for param 3203105Sstever@eecs.umich.edu param = cls._params.get(attr) 3211310SN/A if param: 3223105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 3233105Sstever@eecs.umich.edu return 3243105Sstever@eecs.umich.edu 3253105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 3263105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 3273105Sstever@eecs.umich.edu # Classes don't have children, so we just put this object 3283105Sstever@eecs.umich.edu # in _values; later, each instance will do a 'setattr(self, 3293105Sstever@eecs.umich.edu # attr, _values[attr])' in SimObject.__init__ which will 3303105Sstever@eecs.umich.edu # add this object as a child. 3312740SN/A cls._values[attr] = value 3323105Sstever@eecs.umich.edu return 3333105Sstever@eecs.umich.edu 3343105Sstever@eecs.umich.edu # no valid assignment... raise exception 3353105Sstever@eecs.umich.edu raise AttributeError, \ 3363105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 3371310SN/A 3381585SN/A def __getattr__(cls, attr): 3391692SN/A if cls._values.has_key(attr): 3401692SN/A return cls._values[attr] 3411585SN/A 3421585SN/A raise AttributeError, \ 3431585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 3441585SN/A 3453100SN/A def __str__(cls): 3463100SN/A return cls.__name__ 3473100SN/A 3483100SN/A def cxx_decl(cls): 3494762Snate@binkert.org code = "#ifndef __PARAMS__%s\n" % cls 3504762Snate@binkert.org code += "#define __PARAMS__%s\n\n" % cls 3514762Snate@binkert.org 3523100SN/A # The 'dict' attribute restricts us to the params declared in 3533100SN/A # the object itself, not including inherited params (which 3543100SN/A # will also be inherited from the base class's param struct 3553100SN/A # here). 3564762Snate@binkert.org params = cls._params.local.values() 3573100SN/A try: 3583100SN/A ptypes = [p.ptype for p in params] 3593100SN/A except: 3603100SN/A print cls, p, p.ptype_str 3613100SN/A print params 3623100SN/A raise 3633100SN/A 3643100SN/A # get a list of lists of predeclaration lines 3654762Snate@binkert.org predecls = [] 3664762Snate@binkert.org predecls.extend(cls.cxx_predecls) 3674762Snate@binkert.org for p in params: 3684762Snate@binkert.org predecls.extend(p.cxx_predecls()) 3694762Snate@binkert.org # remove redundant lines 3704762Snate@binkert.org predecls2 = [] 3714762Snate@binkert.org for pd in predecls: 3724762Snate@binkert.org if pd not in predecls2: 3734762Snate@binkert.org predecls2.append(pd) 3744762Snate@binkert.org predecls2.sort() 3754762Snate@binkert.org code += "\n".join(predecls2) 3764762Snate@binkert.org code += "\n\n"; 3774762Snate@binkert.org 3785610Snate@binkert.org if cls._base: 3795610Snate@binkert.org code += '#include "params/%s.hh"\n\n' % cls._base.type 3804762Snate@binkert.org 3814762Snate@binkert.org for ptype in ptypes: 3824762Snate@binkert.org if issubclass(ptype, Enum): 3834762Snate@binkert.org code += '#include "enums/%s.hh"\n' % ptype.__name__ 3844762Snate@binkert.org code += "\n\n" 3854762Snate@binkert.org 3865610Snate@binkert.org code += cls.cxx_struct(cls._base, params) 3875488Snate@binkert.org 3885488Snate@binkert.org # close #ifndef __PARAMS__* guard 3895488Snate@binkert.org code += "\n#endif\n" 3905488Snate@binkert.org return code 3915488Snate@binkert.org 3925488Snate@binkert.org def cxx_struct(cls, base, params): 3935488Snate@binkert.org if cls == SimObject: 3945488Snate@binkert.org return '#include "sim/sim_object_params.hh"\n' 3955488Snate@binkert.org 3964762Snate@binkert.org # now generate the actual param struct 3975488Snate@binkert.org code = "struct %sParams" % cls 3984762Snate@binkert.org if base: 3995610Snate@binkert.org code += " : public %sParams" % base.type 4004762Snate@binkert.org code += "\n{\n" 4014762Snate@binkert.org if not hasattr(cls, 'abstract') or not cls.abstract: 4024762Snate@binkert.org if 'type' in cls.__dict__: 4034762Snate@binkert.org code += " %s create();\n" % cls.cxx_type 4044762Snate@binkert.org decls = [p.cxx_decl() for p in params] 4054762Snate@binkert.org decls.sort() 4064762Snate@binkert.org code += "".join([" %s\n" % d for d in decls]) 4074762Snate@binkert.org code += "};\n" 4084762Snate@binkert.org 4094762Snate@binkert.org return code 4104762Snate@binkert.org 4114762Snate@binkert.org def swig_decl(cls): 4124762Snate@binkert.org code = '%%module %s\n' % cls 4134762Snate@binkert.org 4144762Snate@binkert.org code += '%{\n' 4154762Snate@binkert.org code += '#include "params/%s.hh"\n' % cls 4164762Snate@binkert.org code += '%}\n\n' 4174762Snate@binkert.org 4184762Snate@binkert.org # The 'dict' attribute restricts us to the params declared in 4194762Snate@binkert.org # the object itself, not including inherited params (which 4204762Snate@binkert.org # will also be inherited from the base class's param struct 4214762Snate@binkert.org # here). 4224762Snate@binkert.org params = cls._params.local.values() 4234762Snate@binkert.org ptypes = [p.ptype for p in params] 4244762Snate@binkert.org 4254762Snate@binkert.org # get a list of lists of predeclaration lines 4264762Snate@binkert.org predecls = [] 4274762Snate@binkert.org predecls.extend([ p.swig_predecls() for p in params ]) 4283100SN/A # flatten 4293100SN/A predecls = reduce(lambda x,y:x+y, predecls, []) 4303100SN/A # remove redundant lines 4313100SN/A predecls2 = [] 4323100SN/A for pd in predecls: 4333100SN/A if pd not in predecls2: 4343100SN/A predecls2.append(pd) 4353100SN/A predecls2.sort() 4363100SN/A code += "\n".join(predecls2) 4373100SN/A code += "\n\n"; 4383100SN/A 4395610Snate@binkert.org if cls._base: 4405610Snate@binkert.org code += '%%import "params/%s.i"\n\n' % cls._base.type 4413100SN/A 4424762Snate@binkert.org for ptype in ptypes: 4434762Snate@binkert.org if issubclass(ptype, Enum): 4444762Snate@binkert.org code += '%%import "enums/%s.hh"\n' % ptype.__name__ 4454762Snate@binkert.org code += "\n\n" 4463100SN/A 4474762Snate@binkert.org code += '%%import "params/%s_type.hh"\n\n' % cls 4483100SN/A code += '%%include "params/%s.hh"\n\n' % cls 4493100SN/A 4503100SN/A return code 4513100SN/A 4522740SN/A# The SimObject class is the root of the special hierarchy. Most of 453679SN/A# the code in this class deals with the configuration hierarchy itself 454679SN/A# (parent/child node relationships). 4551692SN/Aclass SimObject(object): 4561692SN/A # Specify metaclass. Any class inheriting from SimObject will 457679SN/A # get this metaclass. 4581692SN/A __metaclass__ = MetaSimObject 4593100SN/A type = 'SimObject' 4604762Snate@binkert.org abstract = True 4613100SN/A 4624859Snate@binkert.org swig_objdecls = [ '%include "python/swig/sim_object.i"' ] 463679SN/A 4642740SN/A # Initialize new instance. For objects with SimObject-valued 4652740SN/A # children, we need to recursively clone the classes represented 4662740SN/A # by those param values as well in a consistent "deep copy"-style 4672740SN/A # fashion. That is, we want to make sure that each instance is 4682740SN/A # cloned only once, and that if there are multiple references to 4692740SN/A # the same original object, we end up with the corresponding 4702740SN/A # cloned references all pointing to the same cloned instance. 4712740SN/A def __init__(self, **kwargs): 4722740SN/A ancestor = kwargs.get('_ancestor') 4732740SN/A memo_dict = kwargs.get('_memo') 4742740SN/A if memo_dict is None: 4752740SN/A # prepare to memoize any recursively instantiated objects 4762740SN/A memo_dict = {} 4772740SN/A elif ancestor: 4782740SN/A # memoize me now to avoid problems with recursive calls 4792740SN/A memo_dict[ancestor] = self 4802711SN/A 4812740SN/A if not ancestor: 4822740SN/A ancestor = self.__class__ 4832740SN/A ancestor._instantiated = True 4842711SN/A 4852740SN/A # initialize required attributes 4862740SN/A self._parent = None 4872740SN/A self._children = {} 4882740SN/A self._ccObject = None # pointer to C++ object 4894762Snate@binkert.org self._ccParams = None 4902740SN/A self._instantiated = False # really "cloned" 4912712SN/A 4922711SN/A # Inherit parameter values from class using multidict so 4932711SN/A # individual value settings can be overridden. 4942740SN/A self._values = multidict(ancestor._values) 4952740SN/A # clone SimObject-valued parameters 4962740SN/A for key,val in ancestor._values.iteritems(): 4972740SN/A if isSimObject(val): 4982740SN/A setattr(self, key, val(_memo=memo_dict)) 4992740SN/A elif isSimObjectSequence(val) and len(val): 5002740SN/A setattr(self, key, [ v(_memo=memo_dict) for v in val ]) 5012740SN/A # clone port references. no need to use a multidict here 5022740SN/A # since we will be creating new references for all ports. 5033105Sstever@eecs.umich.edu self._port_refs = {} 5043105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 5053105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 5061692SN/A # apply attribute assignments from keyword args, if any 5071692SN/A for key,val in kwargs.iteritems(): 5081692SN/A setattr(self, key, val) 509679SN/A 5102740SN/A # "Clone" the current instance by creating another instance of 5112740SN/A # this instance's class, but that inherits its parameter values 5122740SN/A # and port mappings from the current instance. If we're in a 5132740SN/A # "deep copy" recursive clone, check the _memo dict to see if 5142740SN/A # we've already cloned this instance. 5151692SN/A def __call__(self, **kwargs): 5162740SN/A memo_dict = kwargs.get('_memo') 5172740SN/A if memo_dict is None: 5182740SN/A # no memo_dict: must be top-level clone operation. 5192740SN/A # this is only allowed at the root of a hierarchy 5202740SN/A if self._parent: 5212740SN/A raise RuntimeError, "attempt to clone object %s " \ 5222740SN/A "not at the root of a tree (parent = %s)" \ 5232740SN/A % (self, self._parent) 5242740SN/A # create a new dict and use that. 5252740SN/A memo_dict = {} 5262740SN/A kwargs['_memo'] = memo_dict 5272740SN/A elif memo_dict.has_key(self): 5282740SN/A # clone already done & memoized 5292740SN/A return memo_dict[self] 5302740SN/A return self.__class__(_ancestor = self, **kwargs) 5311343SN/A 5323105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 5333105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 5343105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 5353105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 5363105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 5373105Sstever@eecs.umich.edu if not ref: 5383105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 5393105Sstever@eecs.umich.edu self._port_refs[attr] = ref 5403105Sstever@eecs.umich.edu return ref 5413105Sstever@eecs.umich.edu 5421692SN/A def __getattr__(self, attr): 5432738SN/A if self._ports.has_key(attr): 5443105Sstever@eecs.umich.edu return self._get_port_ref(attr) 5452738SN/A 5461692SN/A if self._values.has_key(attr): 5471692SN/A return self._values[attr] 5481427SN/A 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 5701692SN/A # must be SimObject param 5713105Sstever@eecs.umich.edu param = self._params.get(attr) 5721692SN/A if param: 5731310SN/A try: 5741692SN/A value = param.convert(value) 5751587SN/A except Exception, e: 5761692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 5771692SN/A (e, self.__class__.__name__, attr, value) 5781605SN/A e.args = (msg, ) 5791605SN/A raise 5803105Sstever@eecs.umich.edu self._set_child(attr, value) 5813105Sstever@eecs.umich.edu return 5821310SN/A 5833105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 5843105Sstever@eecs.umich.edu self._set_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 5991693SN/A # clear out children with given name, even if it's a vector 6001693SN/A def clear_child(self, name): 6011693SN/A if not self._children.has_key(name): 6021693SN/A return 6031693SN/A child = self._children[name] 6041693SN/A if isinstance(child, SimObjVector): 6051693SN/A for i in xrange(len(child)): 6061693SN/A del self._children["s%d" % (name, i)] 6071693SN/A del self._children[name] 6081693SN/A 6091692SN/A def add_child(self, name, value): 6101692SN/A self._children[name] = value 6111310SN/A 6123105Sstever@eecs.umich.edu def _maybe_set_parent(self, parent, name): 6132740SN/A if not self._parent: 6141692SN/A self._parent = parent 6151692SN/A self._name = name 6161692SN/A parent.add_child(name, self) 6171310SN/A 6183105Sstever@eecs.umich.edu def _set_child(self, attr, value): 6193105Sstever@eecs.umich.edu # if RHS is a SimObject, it's an implicit child assignment 6203105Sstever@eecs.umich.edu # clear out old child with this name, if any 6213105Sstever@eecs.umich.edu self.clear_child(attr) 6223105Sstever@eecs.umich.edu 6233105Sstever@eecs.umich.edu if isSimObject(value): 6243105Sstever@eecs.umich.edu value._maybe_set_parent(self, attr) 6253105Sstever@eecs.umich.edu elif isSimObjectSequence(value): 6263105Sstever@eecs.umich.edu value = SimObjVector(value) 6274762Snate@binkert.org if len(value) == 1: 6284762Snate@binkert.org value[0]._maybe_set_parent(self, attr) 6294762Snate@binkert.org else: 6304762Snate@binkert.org for i,v in enumerate(value): 6314762Snate@binkert.org v._maybe_set_parent(self, "%s%d" % (attr, i)) 6323105Sstever@eecs.umich.edu 6333105Sstever@eecs.umich.edu self._values[attr] = value 6343105Sstever@eecs.umich.edu 6351692SN/A def path(self): 6362740SN/A if not self._parent: 6371692SN/A return 'root' 6381692SN/A ppath = self._parent.path() 6391692SN/A if ppath == 'root': 6401692SN/A return self._name 6411692SN/A return ppath + "." + self._name 6421310SN/A 6431692SN/A def __str__(self): 6441692SN/A return self.path() 6451310SN/A 6461692SN/A def ini_str(self): 6471692SN/A return self.path() 6481310SN/A 6491692SN/A def find_any(self, ptype): 6501692SN/A if isinstance(self, ptype): 6511692SN/A return self, True 6521310SN/A 6531692SN/A found_obj = None 6541692SN/A for child in self._children.itervalues(): 6551692SN/A if isinstance(child, ptype): 6561692SN/A if found_obj != None and child != found_obj: 6571692SN/A raise AttributeError, \ 6581692SN/A 'parent.any matched more than one: %s %s' % \ 6591814SN/A (found_obj.path, child.path) 6601692SN/A found_obj = child 6611692SN/A # search param space 6621692SN/A for pname,pdesc in self._params.iteritems(): 6631692SN/A if issubclass(pdesc.ptype, ptype): 6641692SN/A match_obj = self._values[pname] 6651692SN/A if found_obj != None and found_obj != match_obj: 6661692SN/A raise AttributeError, \ 6671692SN/A 'parent.any matched more than one: %s' % obj.path 6681692SN/A found_obj = match_obj 6691692SN/A return found_obj, found_obj != None 6701692SN/A 6711815SN/A def unproxy(self, base): 6721815SN/A return self 6731815SN/A 6743105Sstever@eecs.umich.edu def unproxy_all(self): 6753105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 6763105Sstever@eecs.umich.edu value = self._values.get(param) 6773105Sstever@eecs.umich.edu if value != None and proxy.isproxy(value): 6783105Sstever@eecs.umich.edu try: 6793105Sstever@eecs.umich.edu value = value.unproxy(self) 6803105Sstever@eecs.umich.edu except: 6813105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 6823105Sstever@eecs.umich.edu (param, self.path()) 6833105Sstever@eecs.umich.edu raise 6843105Sstever@eecs.umich.edu setattr(self, param, value) 6853105Sstever@eecs.umich.edu 6863107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 6873107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 6883107Sstever@eecs.umich.edu port_names = self._ports.keys() 6893107Sstever@eecs.umich.edu port_names.sort() 6903107Sstever@eecs.umich.edu for port_name in port_names: 6913105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 6923105Sstever@eecs.umich.edu if port != None: 6933105Sstever@eecs.umich.edu port.unproxy(self) 6943105Sstever@eecs.umich.edu 6953107Sstever@eecs.umich.edu # Unproxy children in sorted order for determinism also. 6963107Sstever@eecs.umich.edu child_names = self._children.keys() 6973107Sstever@eecs.umich.edu child_names.sort() 6983107Sstever@eecs.umich.edu for child in child_names: 6993107Sstever@eecs.umich.edu self._children[child].unproxy_all() 7003105Sstever@eecs.umich.edu 7015037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 7025543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 7031692SN/A 7042738SN/A instanceDict[self.path()] = self 7052738SN/A 7064081Sbinkertn@umich.edu if hasattr(self, 'type'): 7075037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 7081692SN/A 7091692SN/A child_names = self._children.keys() 7101692SN/A child_names.sort() 7114081Sbinkertn@umich.edu if len(child_names): 7125037Smilesck@eecs.umich.edu print >>ini_file, 'children=%s' % ' '.join(child_names) 7131692SN/A 7141692SN/A param_names = self._params.keys() 7151692SN/A param_names.sort() 7161692SN/A for param in param_names: 7173105Sstever@eecs.umich.edu value = self._values.get(param) 7181692SN/A if value != None: 7195037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 7205037Smilesck@eecs.umich.edu self._values[param].ini_str()) 7211692SN/A 7223103Sstever@eecs.umich.edu port_names = self._ports.keys() 7233103Sstever@eecs.umich.edu port_names.sort() 7243103Sstever@eecs.umich.edu for port_name in port_names: 7253105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 7263105Sstever@eecs.umich.edu if port != None: 7275037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 7283103Sstever@eecs.umich.edu 7295543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 7301692SN/A 7311692SN/A for child in child_names: 7325037Smilesck@eecs.umich.edu self._children[child].print_ini(ini_file) 7331692SN/A 7344762Snate@binkert.org def getCCParams(self): 7354762Snate@binkert.org if self._ccParams: 7364762Snate@binkert.org return self._ccParams 7374762Snate@binkert.org 7385033Smilesck@eecs.umich.edu cc_params_struct = getattr(m5.objects.params, '%sParams' % self.type) 7394762Snate@binkert.org cc_params = cc_params_struct() 7405488Snate@binkert.org cc_params.pyobj = self 7414762Snate@binkert.org cc_params.name = str(self) 7424762Snate@binkert.org 7434762Snate@binkert.org param_names = self._params.keys() 7444762Snate@binkert.org param_names.sort() 7454762Snate@binkert.org for param in param_names: 7464762Snate@binkert.org value = self._values.get(param) 7474762Snate@binkert.org if value is None: 7484762Snate@binkert.org continue 7494762Snate@binkert.org 7504762Snate@binkert.org value = value.getValue() 7514762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 7524762Snate@binkert.org assert isinstance(value, list) 7534762Snate@binkert.org vec = getattr(cc_params, param) 7544762Snate@binkert.org assert not len(vec) 7554762Snate@binkert.org for v in value: 7564762Snate@binkert.org vec.append(v) 7574762Snate@binkert.org else: 7584762Snate@binkert.org setattr(cc_params, param, value) 7594762Snate@binkert.org 7604762Snate@binkert.org port_names = self._ports.keys() 7614762Snate@binkert.org port_names.sort() 7624762Snate@binkert.org for port_name in port_names: 7634762Snate@binkert.org port = self._port_refs.get(port_name, None) 7644762Snate@binkert.org if port != None: 7654762Snate@binkert.org setattr(cc_params, port_name, port) 7664762Snate@binkert.org self._ccParams = cc_params 7674762Snate@binkert.org return self._ccParams 7682738SN/A 7692740SN/A # Get C++ object corresponding to this object, calling C++ if 7702740SN/A # necessary to construct it. Does *not* recursively create 7712740SN/A # children. 7722740SN/A def getCCObject(self): 7732740SN/A if not self._ccObject: 7745244Sgblack@eecs.umich.edu # Cycles in the configuration heirarchy are not supported. This 7755244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 7765244Sgblack@eecs.umich.edu self._ccObject = -1 7775244Sgblack@eecs.umich.edu params = self.getCCParams() 7784762Snate@binkert.org self._ccObject = params.create() 7792740SN/A elif self._ccObject == -1: 7805244Sgblack@eecs.umich.edu raise RuntimeError, "%s: Cycle found in configuration heirarchy." \ 7812740SN/A % self.path() 7822740SN/A return self._ccObject 7832740SN/A 7844762Snate@binkert.org # Call C++ to create C++ object corresponding to this object and 7854762Snate@binkert.org # (recursively) all its children 7864762Snate@binkert.org def createCCObject(self): 7874762Snate@binkert.org self.getCCParams() 7884762Snate@binkert.org self.getCCObject() # force creation 7894762Snate@binkert.org for child in self._children.itervalues(): 7904762Snate@binkert.org child.createCCObject() 7914762Snate@binkert.org 7924762Snate@binkert.org def getValue(self): 7934762Snate@binkert.org return self.getCCObject() 7944762Snate@binkert.org 7952738SN/A # Create C++ port connections corresponding to the connections in 7963105Sstever@eecs.umich.edu # _port_refs (& recursively for all children) 7972738SN/A def connectPorts(self): 7983105Sstever@eecs.umich.edu for portRef in self._port_refs.itervalues(): 7993105Sstever@eecs.umich.edu portRef.ccConnect() 8002738SN/A for child in self._children.itervalues(): 8012738SN/A child.connectPorts() 8022738SN/A 8032839SN/A def startDrain(self, drain_event, recursive): 8042797SN/A count = 0 8054081Sbinkertn@umich.edu if isinstance(self, SimObject): 8062901SN/A count += self._ccObject.drain(drain_event) 8072797SN/A if recursive: 8082797SN/A for child in self._children.itervalues(): 8092839SN/A count += child.startDrain(drain_event, True) 8102797SN/A return count 8112797SN/A 8122797SN/A def resume(self): 8134081Sbinkertn@umich.edu if isinstance(self, SimObject): 8142797SN/A self._ccObject.resume() 8152797SN/A for child in self._children.itervalues(): 8162797SN/A child.resume() 8172797SN/A 8184553Sbinkertn@umich.edu def getMemoryMode(self): 8194553Sbinkertn@umich.edu if not isinstance(self, m5.objects.System): 8204553Sbinkertn@umich.edu return None 8214553Sbinkertn@umich.edu 8224859Snate@binkert.org return self._ccObject.getMemoryMode() 8234553Sbinkertn@umich.edu 8242797SN/A def changeTiming(self, mode): 8253202Shsul@eecs.umich.edu if isinstance(self, m5.objects.System): 8263202Shsul@eecs.umich.edu # i don't know if there's a better way to do this - calling 8273202Shsul@eecs.umich.edu # setMemoryMode directly from self._ccObject results in calling 8283202Shsul@eecs.umich.edu # SimObject::setMemoryMode, not the System::setMemoryMode 8294859Snate@binkert.org self._ccObject.setMemoryMode(mode) 8302797SN/A for child in self._children.itervalues(): 8312797SN/A child.changeTiming(mode) 8322797SN/A 8332797SN/A def takeOverFrom(self, old_cpu): 8344859Snate@binkert.org self._ccObject.takeOverFrom(old_cpu._ccObject) 8352797SN/A 8361692SN/A # generate output file for 'dot' to display as a pretty graph. 8371692SN/A # this code is currently broken. 8381342SN/A def outputDot(self, dot): 8391342SN/A label = "{%s|" % self.path 8401342SN/A if isSimObject(self.realtype): 8411342SN/A label += '%s|' % self.type 8421342SN/A 8431342SN/A if self.children: 8441342SN/A # instantiate children in same order they were added for 8451342SN/A # backward compatibility (else we can end up with cpu1 8461342SN/A # before cpu0). 8471342SN/A for c in self.children: 8481342SN/A dot.add_edge(pydot.Edge(self.path,c.path, style="bold")) 8491342SN/A 8501342SN/A simobjs = [] 8511342SN/A for param in self.params: 8521342SN/A try: 8531342SN/A if param.value is None: 8541342SN/A raise AttributeError, 'Parameter with no value' 8551342SN/A 8561692SN/A value = param.value 8571342SN/A string = param.string(value) 8581587SN/A except Exception, e: 8591605SN/A msg = 'exception in %s:%s\n%s' % (self.name, param.name, e) 8601605SN/A e.args = (msg, ) 8611342SN/A raise 8621605SN/A 8631692SN/A if isSimObject(param.ptype) and string != "Null": 8641342SN/A simobjs.append(string) 8651342SN/A else: 8661342SN/A label += '%s = %s\\n' % (param.name, string) 8671342SN/A 8681342SN/A for so in simobjs: 8691342SN/A label += "|<%s> %s" % (so, so) 8701587SN/A dot.add_edge(pydot.Edge("%s:%s" % (self.path, so), so, 8711587SN/A tailport="w")) 8721342SN/A label += '}' 8731342SN/A dot.add_node(pydot.Node(self.path,shape="Mrecord",label=label)) 8741342SN/A 8751342SN/A # recursively dump out children 8761342SN/A for c in self.children: 8771342SN/A c.outputDot(dot) 8781342SN/A 8793101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 8803101Sstever@eecs.umich.edudef resolveSimObject(name): 8813101Sstever@eecs.umich.edu obj = instanceDict[name] 8823101Sstever@eecs.umich.edu return obj.getCCObject() 883679SN/A 8841528SN/A# __all__ defines the list of symbols that get exported when 8851528SN/A# 'from config import *' is invoked. Try to keep this reasonably 8861528SN/A# short to avoid polluting other namespaces. 8874762Snate@binkert.org__all__ = [ 'SimObject' ] 888