SimObject.py revision 8737
12740SN/A# Copyright (c) 2004-2006 The Regents of The University of Michigan 27534Ssteve.reinhardt@amd.com# Copyright (c) 2010 Advanced Micro Devices, Inc. 31046SN/A# All rights reserved. 41046SN/A# 51046SN/A# Redistribution and use in source and binary forms, with or without 61046SN/A# modification, are permitted provided that the following conditions are 71046SN/A# met: redistributions of source code must retain the above copyright 81046SN/A# notice, this list of conditions and the following disclaimer; 91046SN/A# redistributions in binary form must reproduce the above copyright 101046SN/A# notice, this list of conditions and the following disclaimer in the 111046SN/A# documentation and/or other materials provided with the distribution; 121046SN/A# neither the name of the copyright holders nor the names of its 131046SN/A# contributors may be used to endorse or promote products derived from 141046SN/A# this software without specific prior written permission. 151046SN/A# 161046SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 171046SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 181046SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 191046SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 201046SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 211046SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 221046SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 231046SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 241046SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 251046SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 261046SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665SN/A# 282665SN/A# Authors: Steve Reinhardt 292665SN/A# Nathan Binkert 301046SN/A 315766Snate@binkert.orgimport sys 328331Ssteve.reinhardt@amd.comfrom types import FunctionType, MethodType, ModuleType 331438SN/A 346654Snate@binkert.orgtry: 356654Snate@binkert.org import pydot 366654Snate@binkert.orgexcept: 376654Snate@binkert.org pydot = False 386654Snate@binkert.org 394762Snate@binkert.orgimport m5 406654Snate@binkert.orgfrom m5.util import * 413102Sstever@eecs.umich.edu 423102Sstever@eecs.umich.edu# Have to import params up top since Param is referenced on initial 433102Sstever@eecs.umich.edu# load (when SimObject class references Param to create a class 443102Sstever@eecs.umich.edu# variable, the 'name' param)... 456654Snate@binkert.orgfrom m5.params import * 463102Sstever@eecs.umich.edu# There are a few things we need that aren't in params.__all__ since 473102Sstever@eecs.umich.edu# normal users don't need them 487528Ssteve.reinhardt@amd.comfrom m5.params import ParamDesc, VectorParamDesc, \ 497528Ssteve.reinhardt@amd.com isNullPointer, SimObjectVector 503102Sstever@eecs.umich.edu 516654Snate@binkert.orgfrom m5.proxy import * 526654Snate@binkert.orgfrom m5.proxy import isproxy 53679SN/A 54679SN/A##################################################################### 55679SN/A# 56679SN/A# M5 Python Configuration Utility 57679SN/A# 58679SN/A# The basic idea is to write simple Python programs that build Python 591692SN/A# objects corresponding to M5 SimObjects for the desired simulation 60679SN/A# configuration. For now, the Python emits a .ini file that can be 61679SN/A# parsed by M5. In the future, some tighter integration between M5 62679SN/A# and the Python interpreter may allow bypassing the .ini file. 63679SN/A# 64679SN/A# Each SimObject class in M5 is represented by a Python class with the 65679SN/A# same name. The Python inheritance tree mirrors the M5 C++ tree 66679SN/A# (e.g., SimpleCPU derives from BaseCPU in both cases, and all 67679SN/A# SimObjects inherit from a single SimObject base class). To specify 68679SN/A# an instance of an M5 SimObject in a configuration, the user simply 69679SN/A# instantiates the corresponding Python object. The parameters for 70679SN/A# that SimObject are given by assigning to attributes of the Python 71679SN/A# object, either using keyword assignment in the constructor or in 72679SN/A# separate assignment statements. For example: 73679SN/A# 741692SN/A# cache = BaseCache(size='64KB') 75679SN/A# cache.hit_latency = 3 76679SN/A# cache.assoc = 8 77679SN/A# 78679SN/A# The magic lies in the mapping of the Python attributes for SimObject 79679SN/A# classes to the actual SimObject parameter specifications. This 80679SN/A# allows parameter validity checking in the Python code. Continuing 81679SN/A# the example above, the statements "cache.blurfl=3" or 82679SN/A# "cache.assoc='hello'" would both result in runtime errors in Python, 83679SN/A# since the BaseCache object has no 'blurfl' parameter and the 'assoc' 84679SN/A# parameter requires an integer, respectively. This magic is done 85679SN/A# primarily by overriding the special __setattr__ method that controls 86679SN/A# assignment to object attributes. 87679SN/A# 88679SN/A# Once a set of Python objects have been instantiated in a hierarchy, 89679SN/A# calling 'instantiate(obj)' (where obj is the root of the hierarchy) 902740SN/A# will generate a .ini file. 91679SN/A# 92679SN/A##################################################################### 93679SN/A 944762Snate@binkert.org# list of all SimObject classes 954762Snate@binkert.orgallClasses = {} 964762Snate@binkert.org 972738SN/A# dict to look up SimObjects based on path 982738SN/AinstanceDict = {} 992738SN/A 1007673Snate@binkert.orgdef public_value(key, value): 1017673Snate@binkert.org return key.startswith('_') or \ 1028331Ssteve.reinhardt@amd.com isinstance(value, (FunctionType, MethodType, ModuleType, 1038331Ssteve.reinhardt@amd.com classmethod, type)) 1047673Snate@binkert.org 1052740SN/A# The metaclass for SimObject. This class controls how new classes 1062740SN/A# that derive from SimObject are instantiated, and provides inherited 1072740SN/A# class behavior (just like a class controls how instances of that 1082740SN/A# class are instantiated, and provides inherited instance behavior). 1091692SN/Aclass MetaSimObject(type): 1101427SN/A # Attributes that can be set only at initialization time 1117493Ssteve.reinhardt@amd.com init_keywords = { 'abstract' : bool, 1127493Ssteve.reinhardt@amd.com 'cxx_class' : str, 1137493Ssteve.reinhardt@amd.com 'cxx_type' : str, 1147493Ssteve.reinhardt@amd.com 'type' : str } 1151427SN/A # Attributes that can be set any time 1167493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 117679SN/A 118679SN/A # __new__ is called before __init__, and is where the statements 119679SN/A # in the body of the class definition get loaded into the class's 1202740SN/A # __dict__. We intercept this to filter out parameter & port assignments 121679SN/A # and only allow "private" attributes to be passed to the base 122679SN/A # __new__ (starting with underscore). 1231310SN/A def __new__(mcls, name, bases, dict): 1246654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 1254762Snate@binkert.org 1262740SN/A # Copy "private" attributes, functions, and classes to the 1272740SN/A # official dict. Everything else goes in _init_dict to be 1282740SN/A # filtered in __init__. 1292740SN/A cls_dict = {} 1302740SN/A value_dict = {} 1312740SN/A for key,val in dict.items(): 1327673Snate@binkert.org if public_value(key, val): 1332740SN/A cls_dict[key] = val 1342740SN/A else: 1352740SN/A # must be a param/port setting 1362740SN/A value_dict[key] = val 1374762Snate@binkert.org if 'abstract' not in value_dict: 1384762Snate@binkert.org value_dict['abstract'] = False 1392740SN/A cls_dict['_value_dict'] = value_dict 1404762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 1414762Snate@binkert.org if 'type' in value_dict: 1424762Snate@binkert.org allClasses[name] = cls 1434762Snate@binkert.org return cls 144679SN/A 1452711SN/A # subclass initialization 146679SN/A def __init__(cls, name, bases, dict): 1472711SN/A # calls type.__init__()... I think that's a no-op, but leave 1482711SN/A # it here just in case it's not. 1491692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 1501310SN/A 1511427SN/A # initialize required attributes 1522740SN/A 1532740SN/A # class-only attributes 1542740SN/A cls._params = multidict() # param descriptions 1552740SN/A cls._ports = multidict() # port descriptions 1562740SN/A 1572740SN/A # class or instance attributes 1582740SN/A cls._values = multidict() # param values 1597528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 1603105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 1612740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 1621310SN/A 1631692SN/A # We don't support multiple inheritance. If you want to, you 1641585SN/A # must fix multidict to deal with it properly. 1651692SN/A if len(bases) > 1: 1661692SN/A raise TypeError, "SimObjects do not support multiple inheritance" 1671692SN/A 1681692SN/A base = bases[0] 1691692SN/A 1702740SN/A # Set up general inheritance via multidicts. A subclass will 1712740SN/A # inherit all its settings from the base class. The only time 1722740SN/A # the following is not true is when we define the SimObject 1732740SN/A # class itself (in which case the multidicts have no parent). 1741692SN/A if isinstance(base, MetaSimObject): 1755610Snate@binkert.org cls._base = base 1761692SN/A cls._params.parent = base._params 1772740SN/A cls._ports.parent = base._ports 1781692SN/A cls._values.parent = base._values 1797528Ssteve.reinhardt@amd.com cls._children.parent = base._children 1803105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 1812740SN/A # mark base as having been subclassed 1822712SN/A base._instantiated = True 1835610Snate@binkert.org else: 1845610Snate@binkert.org cls._base = None 1851692SN/A 1864762Snate@binkert.org # default keyword values 1874762Snate@binkert.org if 'type' in cls._value_dict: 1884762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 1895610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 1904762Snate@binkert.org 1915610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 1924859Snate@binkert.org 1938597Ssteve.reinhardt@amd.com # Export methods are automatically inherited via C++, so we 1948597Ssteve.reinhardt@amd.com # don't want the method declarations to get inherited on the 1958597Ssteve.reinhardt@amd.com # python side (and thus end up getting repeated in the wrapped 1968597Ssteve.reinhardt@amd.com # versions of derived classes). The code below basicallly 1978597Ssteve.reinhardt@amd.com # suppresses inheritance by substituting in the base (null) 1988597Ssteve.reinhardt@amd.com # versions of these methods unless a different version is 1998597Ssteve.reinhardt@amd.com # explicitly supplied. 2008597Ssteve.reinhardt@amd.com for method_name in ('export_methods', 'export_method_cxx_predecls', 2018597Ssteve.reinhardt@amd.com 'export_method_swig_predecls'): 2028597Ssteve.reinhardt@amd.com if method_name not in cls.__dict__: 2038597Ssteve.reinhardt@amd.com base_method = getattr(MetaSimObject, method_name) 2048597Ssteve.reinhardt@amd.com m = MethodType(base_method, cls, MetaSimObject) 2058597Ssteve.reinhardt@amd.com setattr(cls, method_name, m) 2068597Ssteve.reinhardt@amd.com 2072740SN/A # Now process the _value_dict items. They could be defining 2082740SN/A # new (or overriding existing) parameters or ports, setting 2092740SN/A # class keywords (e.g., 'abstract'), or setting parameter 2102740SN/A # values or port bindings. The first 3 can only be set when 2112740SN/A # the class is defined, so we handle them here. The others 2122740SN/A # can be set later too, so just emulate that by calling 2132740SN/A # setattr(). 2142740SN/A for key,val in cls._value_dict.items(): 2151527SN/A # param descriptions 2162740SN/A if isinstance(val, ParamDesc): 2171585SN/A cls._new_param(key, val) 2181427SN/A 2192738SN/A # port objects 2202738SN/A elif isinstance(val, Port): 2213105Sstever@eecs.umich.edu cls._new_port(key, val) 2222738SN/A 2231427SN/A # init-time-only keywords 2241427SN/A elif cls.init_keywords.has_key(key): 2251427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 2261427SN/A 2271427SN/A # default: use normal path (ends up in __setattr__) 2281427SN/A else: 2291427SN/A setattr(cls, key, val) 2301427SN/A 2311427SN/A def _set_keyword(cls, keyword, val, kwtype): 2321427SN/A if not isinstance(val, kwtype): 2331427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 2341427SN/A (keyword, type(val), kwtype) 2357493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 2361427SN/A val = classmethod(val) 2371427SN/A type.__setattr__(cls, keyword, val) 2381427SN/A 2393100SN/A def _new_param(cls, name, pdesc): 2403100SN/A # each param desc should be uniquely assigned to one variable 2413100SN/A assert(not hasattr(pdesc, 'name')) 2423100SN/A pdesc.name = name 2433100SN/A cls._params[name] = pdesc 2443100SN/A if hasattr(pdesc, 'default'): 2453105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 2463105Sstever@eecs.umich.edu 2473105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 2483105Sstever@eecs.umich.edu assert(param.name == name) 2493105Sstever@eecs.umich.edu try: 2508321Ssteve.reinhardt@amd.com value = param.convert(value) 2513105Sstever@eecs.umich.edu except Exception, e: 2523105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 2533105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 2543105Sstever@eecs.umich.edu e.args = (msg, ) 2553105Sstever@eecs.umich.edu raise 2568321Ssteve.reinhardt@amd.com cls._values[name] = value 2578321Ssteve.reinhardt@amd.com # if param value is a SimObject, make it a child too, so that 2588321Ssteve.reinhardt@amd.com # it gets cloned properly when the class is instantiated 2598321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 2608321Ssteve.reinhardt@amd.com cls._add_cls_child(name, value) 2618321Ssteve.reinhardt@amd.com 2628321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 2638321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 2648321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 2658321Ssteve.reinhardt@amd.com # clears the parent pointer), and this makes it clear that the 2668321Ssteve.reinhardt@amd.com # object is not an orphan and can provide better error 2678321Ssteve.reinhardt@amd.com # messages. 2688321Ssteve.reinhardt@amd.com child.set_parent(cls, name) 2698321Ssteve.reinhardt@amd.com cls._children[name] = child 2703105Sstever@eecs.umich.edu 2713105Sstever@eecs.umich.edu def _new_port(cls, name, port): 2723105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 2733105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 2743105Sstever@eecs.umich.edu port.name = name 2753105Sstever@eecs.umich.edu cls._ports[name] = port 2763105Sstever@eecs.umich.edu 2773105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 2783105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 2793105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 2803105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 2813105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 2823105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 2833105Sstever@eecs.umich.edu if not ref: 2843105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 2853105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 2863105Sstever@eecs.umich.edu return ref 2871585SN/A 2881310SN/A # Set attribute (called on foo.attr = value when foo is an 2891310SN/A # instance of class cls). 2901310SN/A def __setattr__(cls, attr, value): 2911310SN/A # normal processing for private attributes 2927673Snate@binkert.org if public_value(attr, value): 2931310SN/A type.__setattr__(cls, attr, value) 2941310SN/A return 2951310SN/A 2961310SN/A if cls.keywords.has_key(attr): 2971427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 2981310SN/A return 2991310SN/A 3002738SN/A if cls._ports.has_key(attr): 3013105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 3022738SN/A return 3032738SN/A 3042740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 3052740SN/A raise RuntimeError, \ 3062740SN/A "cannot set SimObject parameter '%s' after\n" \ 3072740SN/A " class %s has been instantiated or subclassed" \ 3082740SN/A % (attr, cls.__name__) 3092740SN/A 3102740SN/A # check for param 3113105Sstever@eecs.umich.edu param = cls._params.get(attr) 3121310SN/A if param: 3133105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 3143105Sstever@eecs.umich.edu return 3153105Sstever@eecs.umich.edu 3163105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 3173105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 3188321Ssteve.reinhardt@amd.com cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 3193105Sstever@eecs.umich.edu return 3203105Sstever@eecs.umich.edu 3213105Sstever@eecs.umich.edu # no valid assignment... raise exception 3223105Sstever@eecs.umich.edu raise AttributeError, \ 3233105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 3241310SN/A 3251585SN/A def __getattr__(cls, attr): 3267675Snate@binkert.org if attr == 'cxx_class_path': 3277675Snate@binkert.org return cls.cxx_class.split('::') 3287675Snate@binkert.org 3297675Snate@binkert.org if attr == 'cxx_class_name': 3307675Snate@binkert.org return cls.cxx_class_path[-1] 3317675Snate@binkert.org 3327675Snate@binkert.org if attr == 'cxx_namespaces': 3337675Snate@binkert.org return cls.cxx_class_path[:-1] 3347675Snate@binkert.org 3351692SN/A if cls._values.has_key(attr): 3361692SN/A return cls._values[attr] 3371585SN/A 3387528Ssteve.reinhardt@amd.com if cls._children.has_key(attr): 3397528Ssteve.reinhardt@amd.com return cls._children[attr] 3407528Ssteve.reinhardt@amd.com 3411585SN/A raise AttributeError, \ 3421585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 3431585SN/A 3443100SN/A def __str__(cls): 3453100SN/A return cls.__name__ 3463100SN/A 3478596Ssteve.reinhardt@amd.com # See ParamValue.cxx_predecls for description. 3488596Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 3498596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 3508596Ssteve.reinhardt@amd.com 3518596Ssteve.reinhardt@amd.com # See ParamValue.swig_predecls for description. 3528596Ssteve.reinhardt@amd.com def swig_predecls(cls, code): 3538596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_$cls.i"') 3548596Ssteve.reinhardt@amd.com 3558597Ssteve.reinhardt@amd.com # Hook for exporting additional C++ methods to Python via SWIG. 3568597Ssteve.reinhardt@amd.com # Default is none, override using @classmethod in class definition. 3578597Ssteve.reinhardt@amd.com def export_methods(cls, code): 3588597Ssteve.reinhardt@amd.com pass 3598597Ssteve.reinhardt@amd.com 3608597Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 3618597Ssteve.reinhardt@amd.com # exported via export_methods() to be compiled in the _wrap.cc 3628597Ssteve.reinhardt@amd.com # file. Typically generates one or more #include statements. If 3638597Ssteve.reinhardt@amd.com # any methods are exported, typically at least the C++ header 3648597Ssteve.reinhardt@amd.com # declaring the relevant SimObject class must be included. 3658597Ssteve.reinhardt@amd.com def export_method_cxx_predecls(cls, code): 3668597Ssteve.reinhardt@amd.com pass 3678597Ssteve.reinhardt@amd.com 3688597Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 3698597Ssteve.reinhardt@amd.com # exported via export_methods() to be processed by SWIG. 3708597Ssteve.reinhardt@amd.com # Typically generates one or more %include or %import statements. 3718597Ssteve.reinhardt@amd.com # If any methods are exported, typically at least the C++ header 3728597Ssteve.reinhardt@amd.com # declaring the relevant SimObject class must be included. 3738597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 3748597Ssteve.reinhardt@amd.com pass 3758597Ssteve.reinhardt@amd.com 3768596Ssteve.reinhardt@amd.com # Generate the declaration for this object for wrapping with SWIG. 3778596Ssteve.reinhardt@amd.com # Generates code that goes into a SWIG .i file. Called from 3788596Ssteve.reinhardt@amd.com # src/SConscript. 3798596Ssteve.reinhardt@amd.com def swig_decl(cls, code): 3808596Ssteve.reinhardt@amd.com class_path = cls.cxx_class.split('::') 3818596Ssteve.reinhardt@amd.com classname = class_path[-1] 3828596Ssteve.reinhardt@amd.com namespaces = class_path[:-1] 3838596Ssteve.reinhardt@amd.com 3848596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 3858596Ssteve.reinhardt@amd.com # the object itself, not including inherited params (which 3868596Ssteve.reinhardt@amd.com # will also be inherited from the base class's param struct 3878596Ssteve.reinhardt@amd.com # here). 3888596Ssteve.reinhardt@amd.com params = cls._params.local.values() 3898596Ssteve.reinhardt@amd.com 3908596Ssteve.reinhardt@amd.com code('%module(package="m5.internal") param_$cls') 3918596Ssteve.reinhardt@amd.com code() 3928596Ssteve.reinhardt@amd.com code('%{') 3938596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 3948596Ssteve.reinhardt@amd.com for param in params: 3958596Ssteve.reinhardt@amd.com param.cxx_predecls(code) 3968597Ssteve.reinhardt@amd.com cls.export_method_cxx_predecls(code) 3978596Ssteve.reinhardt@amd.com code('%}') 3988596Ssteve.reinhardt@amd.com code() 3998596Ssteve.reinhardt@amd.com 4008596Ssteve.reinhardt@amd.com for param in params: 4018596Ssteve.reinhardt@amd.com param.swig_predecls(code) 4028597Ssteve.reinhardt@amd.com cls.export_method_swig_predecls(code) 4038596Ssteve.reinhardt@amd.com 4048596Ssteve.reinhardt@amd.com code() 4058596Ssteve.reinhardt@amd.com if cls._base: 4068596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_${{cls._base}}.i"') 4078596Ssteve.reinhardt@amd.com code() 4088596Ssteve.reinhardt@amd.com 4098596Ssteve.reinhardt@amd.com for ns in namespaces: 4108596Ssteve.reinhardt@amd.com code('namespace $ns {') 4118596Ssteve.reinhardt@amd.com 4128596Ssteve.reinhardt@amd.com if namespaces: 4138596Ssteve.reinhardt@amd.com code('// avoid name conflicts') 4148596Ssteve.reinhardt@amd.com sep_string = '_COLONS_' 4158596Ssteve.reinhardt@amd.com flat_name = sep_string.join(class_path) 4168596Ssteve.reinhardt@amd.com code('%rename($flat_name) $classname;') 4178596Ssteve.reinhardt@amd.com 4188597Ssteve.reinhardt@amd.com code() 4198597Ssteve.reinhardt@amd.com code('// stop swig from creating/wrapping default ctor/dtor') 4208597Ssteve.reinhardt@amd.com code('%nodefault $classname;') 4218597Ssteve.reinhardt@amd.com code('class $classname') 4228597Ssteve.reinhardt@amd.com if cls._base: 4238597Ssteve.reinhardt@amd.com code(' : public ${{cls._base.cxx_class}}') 4248597Ssteve.reinhardt@amd.com code('{') 4258597Ssteve.reinhardt@amd.com code(' public:') 4268597Ssteve.reinhardt@amd.com cls.export_methods(code) 4278597Ssteve.reinhardt@amd.com code('};') 4288596Ssteve.reinhardt@amd.com 4298596Ssteve.reinhardt@amd.com for ns in reversed(namespaces): 4308596Ssteve.reinhardt@amd.com code('} // namespace $ns') 4318596Ssteve.reinhardt@amd.com 4328596Ssteve.reinhardt@amd.com code() 4338596Ssteve.reinhardt@amd.com code('%include "params/$cls.hh"') 4348596Ssteve.reinhardt@amd.com 4358596Ssteve.reinhardt@amd.com 4368596Ssteve.reinhardt@amd.com # Generate the C++ declaration (.hh file) for this SimObject's 4378596Ssteve.reinhardt@amd.com # param struct. Called from src/SConscript. 4388596Ssteve.reinhardt@amd.com def cxx_param_decl(cls, code): 4398596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 4403100SN/A # the object itself, not including inherited params (which 4413100SN/A # will also be inherited from the base class's param struct 4423100SN/A # here). 4434762Snate@binkert.org params = cls._params.local.values() 4443100SN/A try: 4453100SN/A ptypes = [p.ptype for p in params] 4463100SN/A except: 4473100SN/A print cls, p, p.ptype_str 4483100SN/A print params 4493100SN/A raise 4503100SN/A 4517675Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 4527675Snate@binkert.org 4537675Snate@binkert.org code('''\ 4547675Snate@binkert.org#ifndef __PARAMS__${cls}__ 4557675Snate@binkert.org#define __PARAMS__${cls}__ 4567675Snate@binkert.org 4577675Snate@binkert.org''') 4587675Snate@binkert.org 4597675Snate@binkert.org # A forward class declaration is sufficient since we are just 4607675Snate@binkert.org # declaring a pointer. 4617675Snate@binkert.org for ns in class_path[:-1]: 4627675Snate@binkert.org code('namespace $ns {') 4637675Snate@binkert.org code('class $0;', class_path[-1]) 4647675Snate@binkert.org for ns in reversed(class_path[:-1]): 4657811Ssteve.reinhardt@amd.com code('} // namespace $ns') 4667675Snate@binkert.org code() 4677675Snate@binkert.org 4688597Ssteve.reinhardt@amd.com # The base SimObject has a couple of params that get 4698597Ssteve.reinhardt@amd.com # automatically set from Python without being declared through 4708597Ssteve.reinhardt@amd.com # the normal Param mechanism; we slip them in here (needed 4718597Ssteve.reinhardt@amd.com # predecls now, actual declarations below) 4728597Ssteve.reinhardt@amd.com if cls == SimObject: 4738597Ssteve.reinhardt@amd.com code(''' 4748597Ssteve.reinhardt@amd.com#ifndef PY_VERSION 4758597Ssteve.reinhardt@amd.comstruct PyObject; 4768597Ssteve.reinhardt@amd.com#endif 4778597Ssteve.reinhardt@amd.com 4788597Ssteve.reinhardt@amd.com#include <string> 4798597Ssteve.reinhardt@amd.com 4808737Skoansin.tan@gmail.comclass EventQueue; 4818597Ssteve.reinhardt@amd.com''') 4827673Snate@binkert.org for param in params: 4837673Snate@binkert.org param.cxx_predecls(code) 4847673Snate@binkert.org code() 4854762Snate@binkert.org 4865610Snate@binkert.org if cls._base: 4877673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 4887673Snate@binkert.org code() 4894762Snate@binkert.org 4904762Snate@binkert.org for ptype in ptypes: 4914762Snate@binkert.org if issubclass(ptype, Enum): 4927673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 4937673Snate@binkert.org code() 4944762Snate@binkert.org 4958596Ssteve.reinhardt@amd.com # now generate the actual param struct 4968597Ssteve.reinhardt@amd.com code("struct ${cls}Params") 4978597Ssteve.reinhardt@amd.com if cls._base: 4988597Ssteve.reinhardt@amd.com code(" : public ${{cls._base.type}}Params") 4998597Ssteve.reinhardt@amd.com code("{") 5008597Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 5018597Ssteve.reinhardt@amd.com if 'type' in cls.__dict__: 5028597Ssteve.reinhardt@amd.com code(" ${{cls.cxx_type}} create();") 5038597Ssteve.reinhardt@amd.com 5048597Ssteve.reinhardt@amd.com code.indent() 5058596Ssteve.reinhardt@amd.com if cls == SimObject: 5068597Ssteve.reinhardt@amd.com code(''' 5078597Ssteve.reinhardt@amd.com SimObjectParams() 5088597Ssteve.reinhardt@amd.com { 5098597Ssteve.reinhardt@amd.com extern EventQueue mainEventQueue; 5108597Ssteve.reinhardt@amd.com eventq = &mainEventQueue; 5118597Ssteve.reinhardt@amd.com } 5128597Ssteve.reinhardt@amd.com virtual ~SimObjectParams() {} 5138596Ssteve.reinhardt@amd.com 5148597Ssteve.reinhardt@amd.com std::string name; 5158597Ssteve.reinhardt@amd.com PyObject *pyobj; 5168597Ssteve.reinhardt@amd.com EventQueue *eventq; 5178597Ssteve.reinhardt@amd.com ''') 5188597Ssteve.reinhardt@amd.com for param in params: 5198597Ssteve.reinhardt@amd.com param.cxx_decl(code) 5208597Ssteve.reinhardt@amd.com code.dedent() 5218597Ssteve.reinhardt@amd.com code('};') 5225488Snate@binkert.org 5237673Snate@binkert.org code() 5247673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 5255488Snate@binkert.org return code 5265488Snate@binkert.org 5275488Snate@binkert.org 5283100SN/A 5292740SN/A# The SimObject class is the root of the special hierarchy. Most of 530679SN/A# the code in this class deals with the configuration hierarchy itself 531679SN/A# (parent/child node relationships). 5321692SN/Aclass SimObject(object): 5331692SN/A # Specify metaclass. Any class inheriting from SimObject will 534679SN/A # get this metaclass. 5351692SN/A __metaclass__ = MetaSimObject 5363100SN/A type = 'SimObject' 5374762Snate@binkert.org abstract = True 5383100SN/A 5398597Ssteve.reinhardt@amd.com @classmethod 5408597Ssteve.reinhardt@amd.com def export_method_cxx_predecls(cls, code): 5418597Ssteve.reinhardt@amd.com code(''' 5428597Ssteve.reinhardt@amd.com#include <Python.h> 5438597Ssteve.reinhardt@amd.com 5448597Ssteve.reinhardt@amd.com#include "sim/serialize.hh" 5458597Ssteve.reinhardt@amd.com#include "sim/sim_object.hh" 5468597Ssteve.reinhardt@amd.com''') 5478597Ssteve.reinhardt@amd.com 5488597Ssteve.reinhardt@amd.com @classmethod 5498597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 5508597Ssteve.reinhardt@amd.com code(''' 5518597Ssteve.reinhardt@amd.com%include <std_string.i> 5528597Ssteve.reinhardt@amd.com''') 5538597Ssteve.reinhardt@amd.com 5548597Ssteve.reinhardt@amd.com @classmethod 5558597Ssteve.reinhardt@amd.com def export_methods(cls, code): 5568597Ssteve.reinhardt@amd.com code(''' 5578597Ssteve.reinhardt@amd.com enum State { 5588597Ssteve.reinhardt@amd.com Running, 5598597Ssteve.reinhardt@amd.com Draining, 5608597Ssteve.reinhardt@amd.com Drained 5618597Ssteve.reinhardt@amd.com }; 5628597Ssteve.reinhardt@amd.com 5638597Ssteve.reinhardt@amd.com void init(); 5648597Ssteve.reinhardt@amd.com void loadState(Checkpoint *cp); 5658597Ssteve.reinhardt@amd.com void initState(); 5668597Ssteve.reinhardt@amd.com void regStats(); 5678597Ssteve.reinhardt@amd.com void regFormulas(); 5688597Ssteve.reinhardt@amd.com void resetStats(); 5698597Ssteve.reinhardt@amd.com void startup(); 5708597Ssteve.reinhardt@amd.com 5718597Ssteve.reinhardt@amd.com unsigned int drain(Event *drain_event); 5728597Ssteve.reinhardt@amd.com void resume(); 5738597Ssteve.reinhardt@amd.com void switchOut(); 5748597Ssteve.reinhardt@amd.com void takeOverFrom(BaseCPU *cpu); 5758597Ssteve.reinhardt@amd.com''') 5768597Ssteve.reinhardt@amd.com 5772740SN/A # Initialize new instance. For objects with SimObject-valued 5782740SN/A # children, we need to recursively clone the classes represented 5792740SN/A # by those param values as well in a consistent "deep copy"-style 5802740SN/A # fashion. That is, we want to make sure that each instance is 5812740SN/A # cloned only once, and that if there are multiple references to 5822740SN/A # the same original object, we end up with the corresponding 5832740SN/A # cloned references all pointing to the same cloned instance. 5842740SN/A def __init__(self, **kwargs): 5852740SN/A ancestor = kwargs.get('_ancestor') 5862740SN/A memo_dict = kwargs.get('_memo') 5872740SN/A if memo_dict is None: 5882740SN/A # prepare to memoize any recursively instantiated objects 5892740SN/A memo_dict = {} 5902740SN/A elif ancestor: 5912740SN/A # memoize me now to avoid problems with recursive calls 5922740SN/A memo_dict[ancestor] = self 5932711SN/A 5942740SN/A if not ancestor: 5952740SN/A ancestor = self.__class__ 5962740SN/A ancestor._instantiated = True 5972711SN/A 5982740SN/A # initialize required attributes 5992740SN/A self._parent = None 6007528Ssteve.reinhardt@amd.com self._name = None 6012740SN/A self._ccObject = None # pointer to C++ object 6024762Snate@binkert.org self._ccParams = None 6032740SN/A self._instantiated = False # really "cloned" 6042712SN/A 6058321Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 6068321Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 6078321Ssteve.reinhardt@amd.com # Do children before parameter values so that children that 6088321Ssteve.reinhardt@amd.com # are also param values get cloned properly. 6098321Ssteve.reinhardt@amd.com self._children = {} 6108321Ssteve.reinhardt@amd.com for key,val in ancestor._children.iteritems(): 6118321Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 6128321Ssteve.reinhardt@amd.com 6132711SN/A # Inherit parameter values from class using multidict so 6147528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 6157528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 6162740SN/A self._values = multidict(ancestor._values) 6172740SN/A # clone SimObject-valued parameters 6182740SN/A for key,val in ancestor._values.iteritems(): 6197528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 6207528Ssteve.reinhardt@amd.com if val is not None: 6217528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 6227528Ssteve.reinhardt@amd.com 6232740SN/A # clone port references. no need to use a multidict here 6242740SN/A # since we will be creating new references for all ports. 6253105Sstever@eecs.umich.edu self._port_refs = {} 6263105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 6273105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 6281692SN/A # apply attribute assignments from keyword args, if any 6291692SN/A for key,val in kwargs.iteritems(): 6301692SN/A setattr(self, key, val) 631679SN/A 6322740SN/A # "Clone" the current instance by creating another instance of 6332740SN/A # this instance's class, but that inherits its parameter values 6342740SN/A # and port mappings from the current instance. If we're in a 6352740SN/A # "deep copy" recursive clone, check the _memo dict to see if 6362740SN/A # we've already cloned this instance. 6371692SN/A def __call__(self, **kwargs): 6382740SN/A memo_dict = kwargs.get('_memo') 6392740SN/A if memo_dict is None: 6402740SN/A # no memo_dict: must be top-level clone operation. 6412740SN/A # this is only allowed at the root of a hierarchy 6422740SN/A if self._parent: 6432740SN/A raise RuntimeError, "attempt to clone object %s " \ 6442740SN/A "not at the root of a tree (parent = %s)" \ 6452740SN/A % (self, self._parent) 6462740SN/A # create a new dict and use that. 6472740SN/A memo_dict = {} 6482740SN/A kwargs['_memo'] = memo_dict 6492740SN/A elif memo_dict.has_key(self): 6502740SN/A # clone already done & memoized 6512740SN/A return memo_dict[self] 6522740SN/A return self.__class__(_ancestor = self, **kwargs) 6531343SN/A 6543105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 6553105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 6563105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 6573105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 6583105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 6593105Sstever@eecs.umich.edu if not ref: 6603105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 6613105Sstever@eecs.umich.edu self._port_refs[attr] = ref 6623105Sstever@eecs.umich.edu return ref 6633105Sstever@eecs.umich.edu 6641692SN/A def __getattr__(self, attr): 6652738SN/A if self._ports.has_key(attr): 6663105Sstever@eecs.umich.edu return self._get_port_ref(attr) 6672738SN/A 6681692SN/A if self._values.has_key(attr): 6691692SN/A return self._values[attr] 6701427SN/A 6717528Ssteve.reinhardt@amd.com if self._children.has_key(attr): 6727528Ssteve.reinhardt@amd.com return self._children[attr] 6737528Ssteve.reinhardt@amd.com 6747500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 6757500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 6767500Ssteve.reinhardt@amd.com # SWIG-wrapped methods such as init(), regStats(), 6777527Ssteve.reinhardt@amd.com # regFormulas(), resetStats(), startup(), drain(), and 6787527Ssteve.reinhardt@amd.com # resume(). 6797500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 6807500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 6817500Ssteve.reinhardt@amd.com 6821692SN/A raise AttributeError, "object '%s' has no attribute '%s'" \ 6831692SN/A % (self.__class__.__name__, attr) 6841427SN/A 6851692SN/A # Set attribute (called on foo.attr = value when foo is an 6861692SN/A # instance of class cls). 6871692SN/A def __setattr__(self, attr, value): 6881692SN/A # normal processing for private attributes 6891692SN/A if attr.startswith('_'): 6901692SN/A object.__setattr__(self, attr, value) 6911692SN/A return 6921427SN/A 6932738SN/A if self._ports.has_key(attr): 6942738SN/A # set up port connection 6953105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 6962738SN/A return 6972738SN/A 6982740SN/A if isSimObjectOrSequence(value) and self._instantiated: 6992740SN/A raise RuntimeError, \ 7002740SN/A "cannot set SimObject parameter '%s' after\n" \ 7012740SN/A " instance been cloned %s" % (attr, `self`) 7022740SN/A 7033105Sstever@eecs.umich.edu param = self._params.get(attr) 7041692SN/A if param: 7051310SN/A try: 7061692SN/A value = param.convert(value) 7071587SN/A except Exception, e: 7081692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 7091692SN/A (e, self.__class__.__name__, attr, value) 7101605SN/A e.args = (msg, ) 7111605SN/A raise 7127528Ssteve.reinhardt@amd.com self._values[attr] = value 7138321Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 7148321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 7158321Ssteve.reinhardt@amd.com self.add_child(attr, value) 7163105Sstever@eecs.umich.edu return 7171310SN/A 7187528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 7193105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 7207528Ssteve.reinhardt@amd.com self.add_child(attr, value) 7213105Sstever@eecs.umich.edu return 7221693SN/A 7233105Sstever@eecs.umich.edu # no valid assignment... raise exception 7243105Sstever@eecs.umich.edu raise AttributeError, "Class %s has no parameter %s" \ 7253105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 7261310SN/A 7271310SN/A 7281692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 7291692SN/A # not be vectors, and always getting the first element (e.g. cpus) 7301692SN/A def __getitem__(self, key): 7311692SN/A if key == 0: 7321692SN/A return self 7331692SN/A raise TypeError, "Non-zero index '%s' to SimObject" % key 7341310SN/A 7357528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7367528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 7377528Ssteve.reinhardt@amd.com assert self._parent is old_parent 7387528Ssteve.reinhardt@amd.com self._parent = None 7397528Ssteve.reinhardt@amd.com 7407528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7417528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 7427528Ssteve.reinhardt@amd.com self._parent = parent 7437528Ssteve.reinhardt@amd.com self._name = name 7447528Ssteve.reinhardt@amd.com 7457528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7467528Ssteve.reinhardt@amd.com def get_name(self): 7477528Ssteve.reinhardt@amd.com return self._name 7487528Ssteve.reinhardt@amd.com 7498321Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7508321Ssteve.reinhardt@amd.com def has_parent(self): 7518321Ssteve.reinhardt@amd.com return self._parent is not None 7527528Ssteve.reinhardt@amd.com 7537742Sgblack@eecs.umich.edu # clear out child with given name. This code is not likely to be exercised. 7547742Sgblack@eecs.umich.edu # See comment in add_child. 7551693SN/A def clear_child(self, name): 7561693SN/A child = self._children[name] 7577528Ssteve.reinhardt@amd.com child.clear_parent(self) 7581693SN/A del self._children[name] 7591693SN/A 7607528Ssteve.reinhardt@amd.com # Add a new child to this object. 7617528Ssteve.reinhardt@amd.com def add_child(self, name, child): 7627528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 7638321Ssteve.reinhardt@amd.com if child.has_parent(): 7648321Ssteve.reinhardt@amd.com print "warning: add_child('%s'): child '%s' already has parent" % \ 7658321Ssteve.reinhardt@amd.com (name, child.get_name()) 7667528Ssteve.reinhardt@amd.com if self._children.has_key(name): 7677742Sgblack@eecs.umich.edu # This code path had an undiscovered bug that would make it fail 7687742Sgblack@eecs.umich.edu # at runtime. It had been here for a long time and was only 7697742Sgblack@eecs.umich.edu # exposed by a buggy script. Changes here will probably not be 7707742Sgblack@eecs.umich.edu # exercised without specialized testing. 7717738Sgblack@eecs.umich.edu self.clear_child(name) 7727528Ssteve.reinhardt@amd.com child.set_parent(self, name) 7737528Ssteve.reinhardt@amd.com self._children[name] = child 7741310SN/A 7757528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 7767528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 7777528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 7787528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 7797528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 7807528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 7817528Ssteve.reinhardt@amd.com for key,val in self._values.iteritems(): 7827528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 7837528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 7848321Ssteve.reinhardt@amd.com # SimObjectVector class so we can call has_parent() 7857528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 7867528Ssteve.reinhardt@amd.com self._values[key] = val 7878321Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 7888321Ssteve.reinhardt@amd.com print "warning: %s adopting orphan SimObject param '%s'" \ 7898321Ssteve.reinhardt@amd.com % (self, key) 7907528Ssteve.reinhardt@amd.com self.add_child(key, val) 7913105Sstever@eecs.umich.edu 7921692SN/A def path(self): 7932740SN/A if not self._parent: 7948321Ssteve.reinhardt@amd.com return '<orphan %s>' % self.__class__ 7951692SN/A ppath = self._parent.path() 7961692SN/A if ppath == 'root': 7971692SN/A return self._name 7981692SN/A return ppath + "." + self._name 7991310SN/A 8001692SN/A def __str__(self): 8011692SN/A return self.path() 8021310SN/A 8031692SN/A def ini_str(self): 8041692SN/A return self.path() 8051310SN/A 8061692SN/A def find_any(self, ptype): 8071692SN/A if isinstance(self, ptype): 8081692SN/A return self, True 8091310SN/A 8101692SN/A found_obj = None 8111692SN/A for child in self._children.itervalues(): 8121692SN/A if isinstance(child, ptype): 8131692SN/A if found_obj != None and child != found_obj: 8141692SN/A raise AttributeError, \ 8151692SN/A 'parent.any matched more than one: %s %s' % \ 8161814SN/A (found_obj.path, child.path) 8171692SN/A found_obj = child 8181692SN/A # search param space 8191692SN/A for pname,pdesc in self._params.iteritems(): 8201692SN/A if issubclass(pdesc.ptype, ptype): 8211692SN/A match_obj = self._values[pname] 8221692SN/A if found_obj != None and found_obj != match_obj: 8231692SN/A raise AttributeError, \ 8245952Ssaidi@eecs.umich.edu 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 8251692SN/A found_obj = match_obj 8261692SN/A return found_obj, found_obj != None 8271692SN/A 8288459SAli.Saidi@ARM.com def find_all(self, ptype): 8298459SAli.Saidi@ARM.com all = {} 8308459SAli.Saidi@ARM.com # search children 8318459SAli.Saidi@ARM.com for child in self._children.itervalues(): 8328459SAli.Saidi@ARM.com if isinstance(child, ptype) and not isproxy(child) and \ 8338459SAli.Saidi@ARM.com not isNullPointer(child): 8348459SAli.Saidi@ARM.com all[child] = True 8358459SAli.Saidi@ARM.com # search param space 8368459SAli.Saidi@ARM.com for pname,pdesc in self._params.iteritems(): 8378459SAli.Saidi@ARM.com if issubclass(pdesc.ptype, ptype): 8388459SAli.Saidi@ARM.com match_obj = self._values[pname] 8398459SAli.Saidi@ARM.com if not isproxy(match_obj) and not isNullPointer(match_obj): 8408459SAli.Saidi@ARM.com all[match_obj] = True 8418459SAli.Saidi@ARM.com return all.keys(), True 8428459SAli.Saidi@ARM.com 8431815SN/A def unproxy(self, base): 8441815SN/A return self 8451815SN/A 8467527Ssteve.reinhardt@amd.com def unproxyParams(self): 8473105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 8483105Sstever@eecs.umich.edu value = self._values.get(param) 8496654Snate@binkert.org if value != None and isproxy(value): 8503105Sstever@eecs.umich.edu try: 8513105Sstever@eecs.umich.edu value = value.unproxy(self) 8523105Sstever@eecs.umich.edu except: 8533105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 8543105Sstever@eecs.umich.edu (param, self.path()) 8553105Sstever@eecs.umich.edu raise 8563105Sstever@eecs.umich.edu setattr(self, param, value) 8573105Sstever@eecs.umich.edu 8583107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 8593107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 8603107Sstever@eecs.umich.edu port_names = self._ports.keys() 8613107Sstever@eecs.umich.edu port_names.sort() 8623107Sstever@eecs.umich.edu for port_name in port_names: 8633105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 8643105Sstever@eecs.umich.edu if port != None: 8653105Sstever@eecs.umich.edu port.unproxy(self) 8663105Sstever@eecs.umich.edu 8675037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 8685543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 8691692SN/A 8702738SN/A instanceDict[self.path()] = self 8712738SN/A 8724081Sbinkertn@umich.edu if hasattr(self, 'type'): 8735037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 8741692SN/A 8758664SAli.Saidi@ARM.com if len(self._children.keys()): 8767528Ssteve.reinhardt@amd.com print >>ini_file, 'children=%s' % \ 8778664SAli.Saidi@ARM.com ' '.join(self._children[n].get_name() \ 8788664SAli.Saidi@ARM.com for n in sorted(self._children.keys())) 8791692SN/A 8808664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 8813105Sstever@eecs.umich.edu value = self._values.get(param) 8821692SN/A if value != None: 8835037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 8845037Smilesck@eecs.umich.edu self._values[param].ini_str()) 8851692SN/A 8868664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 8873105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 8883105Sstever@eecs.umich.edu if port != None: 8895037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 8903103Sstever@eecs.umich.edu 8915543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 8921692SN/A 8938664SAli.Saidi@ARM.com # generate a tree of dictionaries expressing all the parameters in the 8948664SAli.Saidi@ARM.com # instantiated system for use by scripts that want to do power, thermal 8958664SAli.Saidi@ARM.com # visualization, and other similar tasks 8968664SAli.Saidi@ARM.com def get_config_as_dict(self): 8978664SAli.Saidi@ARM.com d = attrdict() 8988664SAli.Saidi@ARM.com if hasattr(self, 'type'): 8998664SAli.Saidi@ARM.com d.type = self.type 9008664SAli.Saidi@ARM.com if hasattr(self, 'cxx_class'): 9018664SAli.Saidi@ARM.com d.cxx_class = self.cxx_class 9028664SAli.Saidi@ARM.com 9038664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 9048664SAli.Saidi@ARM.com value = self._values.get(param) 9058664SAli.Saidi@ARM.com try: 9068669Ssaidi@eecs.umich.edu # Use native type for those supported by JSON and 9078669Ssaidi@eecs.umich.edu # strings for everything else. skipkeys=True seems 9088669Ssaidi@eecs.umich.edu # to not work as well as one would hope 9098669Ssaidi@eecs.umich.edu if type(self._values[param].value) in \ 9108669Ssaidi@eecs.umich.edu [str, unicode, int, long, float, bool, None]: 9118669Ssaidi@eecs.umich.edu d[param] = self._values[param].value 9128669Ssaidi@eecs.umich.edu else: 9138669Ssaidi@eecs.umich.edu d[param] = str(self._values[param]) 9148669Ssaidi@eecs.umich.edu 9158664SAli.Saidi@ARM.com except AttributeError: 9168664SAli.Saidi@ARM.com pass 9178664SAli.Saidi@ARM.com 9188664SAli.Saidi@ARM.com for n in sorted(self._children.keys()): 9198664SAli.Saidi@ARM.com d[self._children[n].get_name()] = self._children[n].get_config_as_dict() 9208664SAli.Saidi@ARM.com 9218664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 9228664SAli.Saidi@ARM.com port = self._port_refs.get(port_name, None) 9238664SAli.Saidi@ARM.com if port != None: 9248664SAli.Saidi@ARM.com # Might want to actually make this reference the object 9258664SAli.Saidi@ARM.com # in the future, although execing the string problem would 9268664SAli.Saidi@ARM.com # get some of the way there 9278664SAli.Saidi@ARM.com d[port_name] = port.ini_str() 9288664SAli.Saidi@ARM.com 9298664SAli.Saidi@ARM.com return d 9308664SAli.Saidi@ARM.com 9314762Snate@binkert.org def getCCParams(self): 9324762Snate@binkert.org if self._ccParams: 9334762Snate@binkert.org return self._ccParams 9344762Snate@binkert.org 9357677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 9364762Snate@binkert.org cc_params = cc_params_struct() 9375488Snate@binkert.org cc_params.pyobj = self 9384762Snate@binkert.org cc_params.name = str(self) 9394762Snate@binkert.org 9404762Snate@binkert.org param_names = self._params.keys() 9414762Snate@binkert.org param_names.sort() 9424762Snate@binkert.org for param in param_names: 9434762Snate@binkert.org value = self._values.get(param) 9444762Snate@binkert.org if value is None: 9456654Snate@binkert.org fatal("%s.%s without default or user set value", 9466654Snate@binkert.org self.path(), param) 9474762Snate@binkert.org 9484762Snate@binkert.org value = value.getValue() 9494762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 9504762Snate@binkert.org assert isinstance(value, list) 9514762Snate@binkert.org vec = getattr(cc_params, param) 9524762Snate@binkert.org assert not len(vec) 9534762Snate@binkert.org for v in value: 9544762Snate@binkert.org vec.append(v) 9554762Snate@binkert.org else: 9564762Snate@binkert.org setattr(cc_params, param, value) 9574762Snate@binkert.org 9584762Snate@binkert.org port_names = self._ports.keys() 9594762Snate@binkert.org port_names.sort() 9604762Snate@binkert.org for port_name in port_names: 9614762Snate@binkert.org port = self._port_refs.get(port_name, None) 9624762Snate@binkert.org if port != None: 9634762Snate@binkert.org setattr(cc_params, port_name, port) 9644762Snate@binkert.org self._ccParams = cc_params 9654762Snate@binkert.org return self._ccParams 9662738SN/A 9672740SN/A # Get C++ object corresponding to this object, calling C++ if 9682740SN/A # necessary to construct it. Does *not* recursively create 9692740SN/A # children. 9702740SN/A def getCCObject(self): 9712740SN/A if not self._ccObject: 9727526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 9737526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 9747526Ssteve.reinhardt@amd.com raise RuntimeError, "Attempt to instantiate orphan node" 9757526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 9765244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 9775244Sgblack@eecs.umich.edu self._ccObject = -1 9785244Sgblack@eecs.umich.edu params = self.getCCParams() 9794762Snate@binkert.org self._ccObject = params.create() 9802740SN/A elif self._ccObject == -1: 9817526Ssteve.reinhardt@amd.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 9822740SN/A % self.path() 9832740SN/A return self._ccObject 9842740SN/A 9857527Ssteve.reinhardt@amd.com def descendants(self): 9867527Ssteve.reinhardt@amd.com yield self 9877527Ssteve.reinhardt@amd.com for child in self._children.itervalues(): 9887527Ssteve.reinhardt@amd.com for obj in child.descendants(): 9897527Ssteve.reinhardt@amd.com yield obj 9907527Ssteve.reinhardt@amd.com 9917527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 9924762Snate@binkert.org def createCCObject(self): 9934762Snate@binkert.org self.getCCParams() 9944762Snate@binkert.org self.getCCObject() # force creation 9954762Snate@binkert.org 9964762Snate@binkert.org def getValue(self): 9974762Snate@binkert.org return self.getCCObject() 9984762Snate@binkert.org 9992738SN/A # Create C++ port connections corresponding to the connections in 10007527Ssteve.reinhardt@amd.com # _port_refs 10012738SN/A def connectPorts(self): 10023105Sstever@eecs.umich.edu for portRef in self._port_refs.itervalues(): 10033105Sstever@eecs.umich.edu portRef.ccConnect() 10042797SN/A 10054553Sbinkertn@umich.edu def getMemoryMode(self): 10064553Sbinkertn@umich.edu if not isinstance(self, m5.objects.System): 10074553Sbinkertn@umich.edu return None 10084553Sbinkertn@umich.edu 10094859Snate@binkert.org return self._ccObject.getMemoryMode() 10104553Sbinkertn@umich.edu 10112797SN/A def changeTiming(self, mode): 10123202Shsul@eecs.umich.edu if isinstance(self, m5.objects.System): 10133202Shsul@eecs.umich.edu # i don't know if there's a better way to do this - calling 10143202Shsul@eecs.umich.edu # setMemoryMode directly from self._ccObject results in calling 10153202Shsul@eecs.umich.edu # SimObject::setMemoryMode, not the System::setMemoryMode 10164859Snate@binkert.org self._ccObject.setMemoryMode(mode) 10172797SN/A 10182797SN/A def takeOverFrom(self, old_cpu): 10194859Snate@binkert.org self._ccObject.takeOverFrom(old_cpu._ccObject) 10202797SN/A 10211692SN/A # generate output file for 'dot' to display as a pretty graph. 10221692SN/A # this code is currently broken. 10231342SN/A def outputDot(self, dot): 10241342SN/A label = "{%s|" % self.path 10251342SN/A if isSimObject(self.realtype): 10261342SN/A label += '%s|' % self.type 10271342SN/A 10281342SN/A if self.children: 10291342SN/A # instantiate children in same order they were added for 10301342SN/A # backward compatibility (else we can end up with cpu1 10311342SN/A # before cpu0). 10321342SN/A for c in self.children: 10331342SN/A dot.add_edge(pydot.Edge(self.path,c.path, style="bold")) 10341342SN/A 10351342SN/A simobjs = [] 10361342SN/A for param in self.params: 10371342SN/A try: 10381342SN/A if param.value is None: 10391342SN/A raise AttributeError, 'Parameter with no value' 10401342SN/A 10411692SN/A value = param.value 10421342SN/A string = param.string(value) 10431587SN/A except Exception, e: 10441605SN/A msg = 'exception in %s:%s\n%s' % (self.name, param.name, e) 10451605SN/A e.args = (msg, ) 10461342SN/A raise 10471605SN/A 10481692SN/A if isSimObject(param.ptype) and string != "Null": 10491342SN/A simobjs.append(string) 10501342SN/A else: 10511342SN/A label += '%s = %s\\n' % (param.name, string) 10521342SN/A 10531342SN/A for so in simobjs: 10541342SN/A label += "|<%s> %s" % (so, so) 10551587SN/A dot.add_edge(pydot.Edge("%s:%s" % (self.path, so), so, 10561587SN/A tailport="w")) 10571342SN/A label += '}' 10581342SN/A dot.add_node(pydot.Node(self.path,shape="Mrecord",label=label)) 10591342SN/A 10601342SN/A # recursively dump out children 10611342SN/A for c in self.children: 10621342SN/A c.outputDot(dot) 10631342SN/A 10643101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 10653101Sstever@eecs.umich.edudef resolveSimObject(name): 10663101Sstever@eecs.umich.edu obj = instanceDict[name] 10673101Sstever@eecs.umich.edu return obj.getCCObject() 1068679SN/A 10696654Snate@binkert.orgdef isSimObject(value): 10706654Snate@binkert.org return isinstance(value, SimObject) 10716654Snate@binkert.org 10726654Snate@binkert.orgdef isSimObjectClass(value): 10736654Snate@binkert.org return issubclass(value, SimObject) 10746654Snate@binkert.org 10757528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 10767528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 10777528Ssteve.reinhardt@amd.com 10786654Snate@binkert.orgdef isSimObjectSequence(value): 10796654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 10806654Snate@binkert.org return False 10816654Snate@binkert.org 10826654Snate@binkert.org for val in value: 10836654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 10846654Snate@binkert.org return False 10856654Snate@binkert.org 10866654Snate@binkert.org return True 10876654Snate@binkert.org 10886654Snate@binkert.orgdef isSimObjectOrSequence(value): 10896654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 10906654Snate@binkert.org 10917526Ssteve.reinhardt@amd.comdef isRoot(obj): 10927526Ssteve.reinhardt@amd.com from m5.objects import Root 10937526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 10947526Ssteve.reinhardt@amd.com 10957528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 10967528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 10977528Ssteve.reinhardt@amd.com 10987528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 10997528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 11007528Ssteve.reinhardt@amd.com return value 11017528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 11027528Ssteve.reinhardt@amd.com return SimObjectVector(value) 11037528Ssteve.reinhardt@amd.com return None 11047528Ssteve.reinhardt@amd.com 11057528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 11067528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 11077528Ssteve.reinhardt@amd.com if value is None: 11087528Ssteve.reinhardt@amd.com raise TypeError, "SimObject or SimObjectVector expected" 11097528Ssteve.reinhardt@amd.com return value 11107528Ssteve.reinhardt@amd.com 11116654Snate@binkert.orgbaseClasses = allClasses.copy() 11126654Snate@binkert.orgbaseInstances = instanceDict.copy() 11136654Snate@binkert.org 11146654Snate@binkert.orgdef clear(): 11156654Snate@binkert.org global allClasses, instanceDict 11166654Snate@binkert.org 11176654Snate@binkert.org allClasses = baseClasses.copy() 11186654Snate@binkert.org instanceDict = baseInstances.copy() 11196654Snate@binkert.org 11201528SN/A# __all__ defines the list of symbols that get exported when 11211528SN/A# 'from config import *' is invoked. Try to keep this reasonably 11221528SN/A# short to avoid polluting other namespaces. 11234762Snate@binkert.org__all__ = [ 'SimObject' ] 1124