SimObject.py revision 8596
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 1932740SN/A # Now process the _value_dict items. They could be defining 1942740SN/A # new (or overriding existing) parameters or ports, setting 1952740SN/A # class keywords (e.g., 'abstract'), or setting parameter 1962740SN/A # values or port bindings. The first 3 can only be set when 1972740SN/A # the class is defined, so we handle them here. The others 1982740SN/A # can be set later too, so just emulate that by calling 1992740SN/A # setattr(). 2002740SN/A for key,val in cls._value_dict.items(): 2011527SN/A # param descriptions 2022740SN/A if isinstance(val, ParamDesc): 2031585SN/A cls._new_param(key, val) 2041427SN/A 2052738SN/A # port objects 2062738SN/A elif isinstance(val, Port): 2073105Sstever@eecs.umich.edu cls._new_port(key, val) 2082738SN/A 2091427SN/A # init-time-only keywords 2101427SN/A elif cls.init_keywords.has_key(key): 2111427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 2121427SN/A 2131427SN/A # default: use normal path (ends up in __setattr__) 2141427SN/A else: 2151427SN/A setattr(cls, key, val) 2161427SN/A 2171427SN/A def _set_keyword(cls, keyword, val, kwtype): 2181427SN/A if not isinstance(val, kwtype): 2191427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 2201427SN/A (keyword, type(val), kwtype) 2217493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 2221427SN/A val = classmethod(val) 2231427SN/A type.__setattr__(cls, keyword, val) 2241427SN/A 2253100SN/A def _new_param(cls, name, pdesc): 2263100SN/A # each param desc should be uniquely assigned to one variable 2273100SN/A assert(not hasattr(pdesc, 'name')) 2283100SN/A pdesc.name = name 2293100SN/A cls._params[name] = pdesc 2303100SN/A if hasattr(pdesc, 'default'): 2313105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 2323105Sstever@eecs.umich.edu 2333105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 2343105Sstever@eecs.umich.edu assert(param.name == name) 2353105Sstever@eecs.umich.edu try: 2368321Ssteve.reinhardt@amd.com value = param.convert(value) 2373105Sstever@eecs.umich.edu except Exception, e: 2383105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 2393105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 2403105Sstever@eecs.umich.edu e.args = (msg, ) 2413105Sstever@eecs.umich.edu raise 2428321Ssteve.reinhardt@amd.com cls._values[name] = value 2438321Ssteve.reinhardt@amd.com # if param value is a SimObject, make it a child too, so that 2448321Ssteve.reinhardt@amd.com # it gets cloned properly when the class is instantiated 2458321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 2468321Ssteve.reinhardt@amd.com cls._add_cls_child(name, value) 2478321Ssteve.reinhardt@amd.com 2488321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 2498321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 2508321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 2518321Ssteve.reinhardt@amd.com # clears the parent pointer), and this makes it clear that the 2528321Ssteve.reinhardt@amd.com # object is not an orphan and can provide better error 2538321Ssteve.reinhardt@amd.com # messages. 2548321Ssteve.reinhardt@amd.com child.set_parent(cls, name) 2558321Ssteve.reinhardt@amd.com cls._children[name] = child 2563105Sstever@eecs.umich.edu 2573105Sstever@eecs.umich.edu def _new_port(cls, name, port): 2583105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 2593105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 2603105Sstever@eecs.umich.edu port.name = name 2613105Sstever@eecs.umich.edu cls._ports[name] = port 2623105Sstever@eecs.umich.edu if hasattr(port, 'default'): 2633105Sstever@eecs.umich.edu cls._cls_get_port_ref(name).connect(port.default) 2643105Sstever@eecs.umich.edu 2653105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 2663105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 2673105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 2683105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 2693105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 2703105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 2713105Sstever@eecs.umich.edu if not ref: 2723105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 2733105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 2743105Sstever@eecs.umich.edu return ref 2751585SN/A 2761310SN/A # Set attribute (called on foo.attr = value when foo is an 2771310SN/A # instance of class cls). 2781310SN/A def __setattr__(cls, attr, value): 2791310SN/A # normal processing for private attributes 2807673Snate@binkert.org if public_value(attr, value): 2811310SN/A type.__setattr__(cls, attr, value) 2821310SN/A return 2831310SN/A 2841310SN/A if cls.keywords.has_key(attr): 2851427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 2861310SN/A return 2871310SN/A 2882738SN/A if cls._ports.has_key(attr): 2893105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 2902738SN/A return 2912738SN/A 2922740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 2932740SN/A raise RuntimeError, \ 2942740SN/A "cannot set SimObject parameter '%s' after\n" \ 2952740SN/A " class %s has been instantiated or subclassed" \ 2962740SN/A % (attr, cls.__name__) 2972740SN/A 2982740SN/A # check for param 2993105Sstever@eecs.umich.edu param = cls._params.get(attr) 3001310SN/A if param: 3013105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 3023105Sstever@eecs.umich.edu return 3033105Sstever@eecs.umich.edu 3043105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 3053105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 3068321Ssteve.reinhardt@amd.com cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 3073105Sstever@eecs.umich.edu return 3083105Sstever@eecs.umich.edu 3093105Sstever@eecs.umich.edu # no valid assignment... raise exception 3103105Sstever@eecs.umich.edu raise AttributeError, \ 3113105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 3121310SN/A 3131585SN/A def __getattr__(cls, attr): 3147675Snate@binkert.org if attr == 'cxx_class_path': 3157675Snate@binkert.org return cls.cxx_class.split('::') 3167675Snate@binkert.org 3177675Snate@binkert.org if attr == 'cxx_class_name': 3187675Snate@binkert.org return cls.cxx_class_path[-1] 3197675Snate@binkert.org 3207675Snate@binkert.org if attr == 'cxx_namespaces': 3217675Snate@binkert.org return cls.cxx_class_path[:-1] 3227675Snate@binkert.org 3231692SN/A if cls._values.has_key(attr): 3241692SN/A return cls._values[attr] 3251585SN/A 3267528Ssteve.reinhardt@amd.com if cls._children.has_key(attr): 3277528Ssteve.reinhardt@amd.com return cls._children[attr] 3287528Ssteve.reinhardt@amd.com 3291585SN/A raise AttributeError, \ 3301585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 3311585SN/A 3323100SN/A def __str__(cls): 3333100SN/A return cls.__name__ 3343100SN/A 3358596Ssteve.reinhardt@amd.com # See ParamValue.cxx_predecls for description. 3368596Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 3378596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 3388596Ssteve.reinhardt@amd.com 3398596Ssteve.reinhardt@amd.com # See ParamValue.swig_predecls for description. 3408596Ssteve.reinhardt@amd.com def swig_predecls(cls, code): 3418596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_$cls.i"') 3428596Ssteve.reinhardt@amd.com 3438596Ssteve.reinhardt@amd.com # Generate the declaration for this object for wrapping with SWIG. 3448596Ssteve.reinhardt@amd.com # Generates code that goes into a SWIG .i file. Called from 3458596Ssteve.reinhardt@amd.com # src/SConscript. 3468596Ssteve.reinhardt@amd.com def swig_decl(cls, code): 3478596Ssteve.reinhardt@amd.com class_path = cls.cxx_class.split('::') 3488596Ssteve.reinhardt@amd.com classname = class_path[-1] 3498596Ssteve.reinhardt@amd.com namespaces = class_path[:-1] 3508596Ssteve.reinhardt@amd.com 3518596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 3528596Ssteve.reinhardt@amd.com # the object itself, not including inherited params (which 3538596Ssteve.reinhardt@amd.com # will also be inherited from the base class's param struct 3548596Ssteve.reinhardt@amd.com # here). 3558596Ssteve.reinhardt@amd.com params = cls._params.local.values() 3568596Ssteve.reinhardt@amd.com 3578596Ssteve.reinhardt@amd.com code('%module(package="m5.internal") param_$cls') 3588596Ssteve.reinhardt@amd.com code() 3598596Ssteve.reinhardt@amd.com code('%{') 3608596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 3618596Ssteve.reinhardt@amd.com for param in params: 3628596Ssteve.reinhardt@amd.com param.cxx_predecls(code) 3638596Ssteve.reinhardt@amd.com code('%}') 3648596Ssteve.reinhardt@amd.com code() 3658596Ssteve.reinhardt@amd.com 3668596Ssteve.reinhardt@amd.com for param in params: 3678596Ssteve.reinhardt@amd.com param.swig_predecls(code) 3688596Ssteve.reinhardt@amd.com 3698596Ssteve.reinhardt@amd.com code() 3708596Ssteve.reinhardt@amd.com if cls._base: 3718596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_${{cls._base}}.i"') 3728596Ssteve.reinhardt@amd.com code() 3738596Ssteve.reinhardt@amd.com 3748596Ssteve.reinhardt@amd.com for ns in namespaces: 3758596Ssteve.reinhardt@amd.com code('namespace $ns {') 3768596Ssteve.reinhardt@amd.com 3778596Ssteve.reinhardt@amd.com if namespaces: 3788596Ssteve.reinhardt@amd.com code('// avoid name conflicts') 3798596Ssteve.reinhardt@amd.com sep_string = '_COLONS_' 3808596Ssteve.reinhardt@amd.com flat_name = sep_string.join(class_path) 3818596Ssteve.reinhardt@amd.com code('%rename($flat_name) $classname;') 3828596Ssteve.reinhardt@amd.com 3838596Ssteve.reinhardt@amd.com if cls == SimObject: 3848596Ssteve.reinhardt@amd.com code('%include "python/swig/sim_object.i"') 3858596Ssteve.reinhardt@amd.com else: 3868596Ssteve.reinhardt@amd.com code() 3878596Ssteve.reinhardt@amd.com code('// stop swig from creating/wrapping default ctor/dtor') 3888596Ssteve.reinhardt@amd.com code('%nodefault $classname;') 3898596Ssteve.reinhardt@amd.com code('class $classname') 3908596Ssteve.reinhardt@amd.com if cls._base: 3918596Ssteve.reinhardt@amd.com code(' : public ${{cls._base.cxx_class}}') 3928596Ssteve.reinhardt@amd.com code('{};') 3938596Ssteve.reinhardt@amd.com 3948596Ssteve.reinhardt@amd.com for ns in reversed(namespaces): 3958596Ssteve.reinhardt@amd.com code('} // namespace $ns') 3968596Ssteve.reinhardt@amd.com 3978596Ssteve.reinhardt@amd.com code() 3988596Ssteve.reinhardt@amd.com code('%include "params/$cls.hh"') 3998596Ssteve.reinhardt@amd.com 4008596Ssteve.reinhardt@amd.com 4018596Ssteve.reinhardt@amd.com # Generate the C++ declaration (.hh file) for this SimObject's 4028596Ssteve.reinhardt@amd.com # param struct. Called from src/SConscript. 4038596Ssteve.reinhardt@amd.com def cxx_param_decl(cls, code): 4048596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 4053100SN/A # the object itself, not including inherited params (which 4063100SN/A # will also be inherited from the base class's param struct 4073100SN/A # here). 4084762Snate@binkert.org params = cls._params.local.values() 4093100SN/A try: 4103100SN/A ptypes = [p.ptype for p in params] 4113100SN/A except: 4123100SN/A print cls, p, p.ptype_str 4133100SN/A print params 4143100SN/A raise 4153100SN/A 4167675Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 4177675Snate@binkert.org 4187675Snate@binkert.org code('''\ 4197675Snate@binkert.org#ifndef __PARAMS__${cls}__ 4207675Snate@binkert.org#define __PARAMS__${cls}__ 4217675Snate@binkert.org 4227675Snate@binkert.org''') 4237675Snate@binkert.org 4247675Snate@binkert.org # A forward class declaration is sufficient since we are just 4257675Snate@binkert.org # declaring a pointer. 4267675Snate@binkert.org for ns in class_path[:-1]: 4277675Snate@binkert.org code('namespace $ns {') 4287675Snate@binkert.org code('class $0;', class_path[-1]) 4297675Snate@binkert.org for ns in reversed(class_path[:-1]): 4307811Ssteve.reinhardt@amd.com code('} // namespace $ns') 4317675Snate@binkert.org code() 4327675Snate@binkert.org 4337673Snate@binkert.org for param in params: 4347673Snate@binkert.org param.cxx_predecls(code) 4357673Snate@binkert.org code() 4364762Snate@binkert.org 4375610Snate@binkert.org if cls._base: 4387673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 4397673Snate@binkert.org code() 4404762Snate@binkert.org 4414762Snate@binkert.org for ptype in ptypes: 4424762Snate@binkert.org if issubclass(ptype, Enum): 4437673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 4447673Snate@binkert.org code() 4454762Snate@binkert.org 4468596Ssteve.reinhardt@amd.com # now generate the actual param struct 4478596Ssteve.reinhardt@amd.com if cls == SimObject: 4488596Ssteve.reinhardt@amd.com code('#include "sim/sim_object_params.hh"') 4498596Ssteve.reinhardt@amd.com else: 4508596Ssteve.reinhardt@amd.com code("struct ${cls}Params") 4518596Ssteve.reinhardt@amd.com if cls._base: 4528596Ssteve.reinhardt@amd.com code(" : public ${{cls._base.type}}Params") 4538596Ssteve.reinhardt@amd.com code("{") 4548596Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 4558596Ssteve.reinhardt@amd.com if 'type' in cls.__dict__: 4568596Ssteve.reinhardt@amd.com code(" ${{cls.cxx_type}} create();") 4578596Ssteve.reinhardt@amd.com 4588596Ssteve.reinhardt@amd.com code.indent() 4598596Ssteve.reinhardt@amd.com for param in params: 4608596Ssteve.reinhardt@amd.com param.cxx_decl(code) 4618596Ssteve.reinhardt@amd.com code.dedent() 4628596Ssteve.reinhardt@amd.com code('};') 4635488Snate@binkert.org 4647673Snate@binkert.org code() 4657673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 4665488Snate@binkert.org return code 4675488Snate@binkert.org 4685488Snate@binkert.org 4693100SN/A 4702740SN/A# The SimObject class is the root of the special hierarchy. Most of 471679SN/A# the code in this class deals with the configuration hierarchy itself 472679SN/A# (parent/child node relationships). 4731692SN/Aclass SimObject(object): 4741692SN/A # Specify metaclass. Any class inheriting from SimObject will 475679SN/A # get this metaclass. 4761692SN/A __metaclass__ = MetaSimObject 4773100SN/A type = 'SimObject' 4784762Snate@binkert.org abstract = True 4793100SN/A 4802740SN/A # Initialize new instance. For objects with SimObject-valued 4812740SN/A # children, we need to recursively clone the classes represented 4822740SN/A # by those param values as well in a consistent "deep copy"-style 4832740SN/A # fashion. That is, we want to make sure that each instance is 4842740SN/A # cloned only once, and that if there are multiple references to 4852740SN/A # the same original object, we end up with the corresponding 4862740SN/A # cloned references all pointing to the same cloned instance. 4872740SN/A def __init__(self, **kwargs): 4882740SN/A ancestor = kwargs.get('_ancestor') 4892740SN/A memo_dict = kwargs.get('_memo') 4902740SN/A if memo_dict is None: 4912740SN/A # prepare to memoize any recursively instantiated objects 4922740SN/A memo_dict = {} 4932740SN/A elif ancestor: 4942740SN/A # memoize me now to avoid problems with recursive calls 4952740SN/A memo_dict[ancestor] = self 4962711SN/A 4972740SN/A if not ancestor: 4982740SN/A ancestor = self.__class__ 4992740SN/A ancestor._instantiated = True 5002711SN/A 5012740SN/A # initialize required attributes 5022740SN/A self._parent = None 5037528Ssteve.reinhardt@amd.com self._name = None 5042740SN/A self._ccObject = None # pointer to C++ object 5054762Snate@binkert.org self._ccParams = None 5062740SN/A self._instantiated = False # really "cloned" 5072712SN/A 5088321Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 5098321Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 5108321Ssteve.reinhardt@amd.com # Do children before parameter values so that children that 5118321Ssteve.reinhardt@amd.com # are also param values get cloned properly. 5128321Ssteve.reinhardt@amd.com self._children = {} 5138321Ssteve.reinhardt@amd.com for key,val in ancestor._children.iteritems(): 5148321Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 5158321Ssteve.reinhardt@amd.com 5162711SN/A # Inherit parameter values from class using multidict so 5177528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 5187528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 5192740SN/A self._values = multidict(ancestor._values) 5202740SN/A # clone SimObject-valued parameters 5212740SN/A for key,val in ancestor._values.iteritems(): 5227528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 5237528Ssteve.reinhardt@amd.com if val is not None: 5247528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 5257528Ssteve.reinhardt@amd.com 5262740SN/A # clone port references. no need to use a multidict here 5272740SN/A # since we will be creating new references for all ports. 5283105Sstever@eecs.umich.edu self._port_refs = {} 5293105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 5303105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 5311692SN/A # apply attribute assignments from keyword args, if any 5321692SN/A for key,val in kwargs.iteritems(): 5331692SN/A setattr(self, key, val) 534679SN/A 5352740SN/A # "Clone" the current instance by creating another instance of 5362740SN/A # this instance's class, but that inherits its parameter values 5372740SN/A # and port mappings from the current instance. If we're in a 5382740SN/A # "deep copy" recursive clone, check the _memo dict to see if 5392740SN/A # we've already cloned this instance. 5401692SN/A def __call__(self, **kwargs): 5412740SN/A memo_dict = kwargs.get('_memo') 5422740SN/A if memo_dict is None: 5432740SN/A # no memo_dict: must be top-level clone operation. 5442740SN/A # this is only allowed at the root of a hierarchy 5452740SN/A if self._parent: 5462740SN/A raise RuntimeError, "attempt to clone object %s " \ 5472740SN/A "not at the root of a tree (parent = %s)" \ 5482740SN/A % (self, self._parent) 5492740SN/A # create a new dict and use that. 5502740SN/A memo_dict = {} 5512740SN/A kwargs['_memo'] = memo_dict 5522740SN/A elif memo_dict.has_key(self): 5532740SN/A # clone already done & memoized 5542740SN/A return memo_dict[self] 5552740SN/A return self.__class__(_ancestor = self, **kwargs) 5561343SN/A 5573105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 5583105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 5593105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 5603105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 5613105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 5623105Sstever@eecs.umich.edu if not ref: 5633105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 5643105Sstever@eecs.umich.edu self._port_refs[attr] = ref 5653105Sstever@eecs.umich.edu return ref 5663105Sstever@eecs.umich.edu 5671692SN/A def __getattr__(self, attr): 5682738SN/A if self._ports.has_key(attr): 5693105Sstever@eecs.umich.edu return self._get_port_ref(attr) 5702738SN/A 5711692SN/A if self._values.has_key(attr): 5721692SN/A return self._values[attr] 5731427SN/A 5747528Ssteve.reinhardt@amd.com if self._children.has_key(attr): 5757528Ssteve.reinhardt@amd.com return self._children[attr] 5767528Ssteve.reinhardt@amd.com 5777500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 5787500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 5797500Ssteve.reinhardt@amd.com # SWIG-wrapped methods such as init(), regStats(), 5807527Ssteve.reinhardt@amd.com # regFormulas(), resetStats(), startup(), drain(), and 5817527Ssteve.reinhardt@amd.com # resume(). 5827500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 5837500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 5847500Ssteve.reinhardt@amd.com 5851692SN/A raise AttributeError, "object '%s' has no attribute '%s'" \ 5861692SN/A % (self.__class__.__name__, attr) 5871427SN/A 5881692SN/A # Set attribute (called on foo.attr = value when foo is an 5891692SN/A # instance of class cls). 5901692SN/A def __setattr__(self, attr, value): 5911692SN/A # normal processing for private attributes 5921692SN/A if attr.startswith('_'): 5931692SN/A object.__setattr__(self, attr, value) 5941692SN/A return 5951427SN/A 5962738SN/A if self._ports.has_key(attr): 5972738SN/A # set up port connection 5983105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 5992738SN/A return 6002738SN/A 6012740SN/A if isSimObjectOrSequence(value) and self._instantiated: 6022740SN/A raise RuntimeError, \ 6032740SN/A "cannot set SimObject parameter '%s' after\n" \ 6042740SN/A " instance been cloned %s" % (attr, `self`) 6052740SN/A 6063105Sstever@eecs.umich.edu param = self._params.get(attr) 6071692SN/A if param: 6081310SN/A try: 6091692SN/A value = param.convert(value) 6101587SN/A except Exception, e: 6111692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 6121692SN/A (e, self.__class__.__name__, attr, value) 6131605SN/A e.args = (msg, ) 6141605SN/A raise 6157528Ssteve.reinhardt@amd.com self._values[attr] = value 6168321Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 6178321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 6188321Ssteve.reinhardt@amd.com self.add_child(attr, value) 6193105Sstever@eecs.umich.edu return 6201310SN/A 6217528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 6223105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 6237528Ssteve.reinhardt@amd.com self.add_child(attr, value) 6243105Sstever@eecs.umich.edu return 6251693SN/A 6263105Sstever@eecs.umich.edu # no valid assignment... raise exception 6273105Sstever@eecs.umich.edu raise AttributeError, "Class %s has no parameter %s" \ 6283105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 6291310SN/A 6301310SN/A 6311692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 6321692SN/A # not be vectors, and always getting the first element (e.g. cpus) 6331692SN/A def __getitem__(self, key): 6341692SN/A if key == 0: 6351692SN/A return self 6361692SN/A raise TypeError, "Non-zero index '%s' to SimObject" % key 6371310SN/A 6387528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6397528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 6407528Ssteve.reinhardt@amd.com assert self._parent is old_parent 6417528Ssteve.reinhardt@amd.com self._parent = None 6427528Ssteve.reinhardt@amd.com 6437528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6447528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 6457528Ssteve.reinhardt@amd.com self._parent = parent 6467528Ssteve.reinhardt@amd.com self._name = name 6477528Ssteve.reinhardt@amd.com 6487528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6497528Ssteve.reinhardt@amd.com def get_name(self): 6507528Ssteve.reinhardt@amd.com return self._name 6517528Ssteve.reinhardt@amd.com 6528321Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6538321Ssteve.reinhardt@amd.com def has_parent(self): 6548321Ssteve.reinhardt@amd.com return self._parent is not None 6557528Ssteve.reinhardt@amd.com 6567742Sgblack@eecs.umich.edu # clear out child with given name. This code is not likely to be exercised. 6577742Sgblack@eecs.umich.edu # See comment in add_child. 6581693SN/A def clear_child(self, name): 6591693SN/A child = self._children[name] 6607528Ssteve.reinhardt@amd.com child.clear_parent(self) 6611693SN/A del self._children[name] 6621693SN/A 6637528Ssteve.reinhardt@amd.com # Add a new child to this object. 6647528Ssteve.reinhardt@amd.com def add_child(self, name, child): 6657528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 6668321Ssteve.reinhardt@amd.com if child.has_parent(): 6678321Ssteve.reinhardt@amd.com print "warning: add_child('%s'): child '%s' already has parent" % \ 6688321Ssteve.reinhardt@amd.com (name, child.get_name()) 6697528Ssteve.reinhardt@amd.com if self._children.has_key(name): 6707742Sgblack@eecs.umich.edu # This code path had an undiscovered bug that would make it fail 6717742Sgblack@eecs.umich.edu # at runtime. It had been here for a long time and was only 6727742Sgblack@eecs.umich.edu # exposed by a buggy script. Changes here will probably not be 6737742Sgblack@eecs.umich.edu # exercised without specialized testing. 6747738Sgblack@eecs.umich.edu self.clear_child(name) 6757528Ssteve.reinhardt@amd.com child.set_parent(self, name) 6767528Ssteve.reinhardt@amd.com self._children[name] = child 6771310SN/A 6787528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 6797528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 6807528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 6817528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 6827528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 6837528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 6847528Ssteve.reinhardt@amd.com for key,val in self._values.iteritems(): 6857528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 6867528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 6878321Ssteve.reinhardt@amd.com # SimObjectVector class so we can call has_parent() 6887528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 6897528Ssteve.reinhardt@amd.com self._values[key] = val 6908321Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 6918321Ssteve.reinhardt@amd.com print "warning: %s adopting orphan SimObject param '%s'" \ 6928321Ssteve.reinhardt@amd.com % (self, key) 6937528Ssteve.reinhardt@amd.com self.add_child(key, val) 6943105Sstever@eecs.umich.edu 6951692SN/A def path(self): 6962740SN/A if not self._parent: 6978321Ssteve.reinhardt@amd.com return '<orphan %s>' % self.__class__ 6981692SN/A ppath = self._parent.path() 6991692SN/A if ppath == 'root': 7001692SN/A return self._name 7011692SN/A return ppath + "." + self._name 7021310SN/A 7031692SN/A def __str__(self): 7041692SN/A return self.path() 7051310SN/A 7061692SN/A def ini_str(self): 7071692SN/A return self.path() 7081310SN/A 7091692SN/A def find_any(self, ptype): 7101692SN/A if isinstance(self, ptype): 7111692SN/A return self, True 7121310SN/A 7131692SN/A found_obj = None 7141692SN/A for child in self._children.itervalues(): 7151692SN/A if isinstance(child, ptype): 7161692SN/A if found_obj != None and child != found_obj: 7171692SN/A raise AttributeError, \ 7181692SN/A 'parent.any matched more than one: %s %s' % \ 7191814SN/A (found_obj.path, child.path) 7201692SN/A found_obj = child 7211692SN/A # search param space 7221692SN/A for pname,pdesc in self._params.iteritems(): 7231692SN/A if issubclass(pdesc.ptype, ptype): 7241692SN/A match_obj = self._values[pname] 7251692SN/A if found_obj != None and found_obj != match_obj: 7261692SN/A raise AttributeError, \ 7275952Ssaidi@eecs.umich.edu 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 7281692SN/A found_obj = match_obj 7291692SN/A return found_obj, found_obj != None 7301692SN/A 7318459SAli.Saidi@ARM.com def find_all(self, ptype): 7328459SAli.Saidi@ARM.com all = {} 7338459SAli.Saidi@ARM.com # search children 7348459SAli.Saidi@ARM.com for child in self._children.itervalues(): 7358459SAli.Saidi@ARM.com if isinstance(child, ptype) and not isproxy(child) and \ 7368459SAli.Saidi@ARM.com not isNullPointer(child): 7378459SAli.Saidi@ARM.com all[child] = True 7388459SAli.Saidi@ARM.com # search param space 7398459SAli.Saidi@ARM.com for pname,pdesc in self._params.iteritems(): 7408459SAli.Saidi@ARM.com if issubclass(pdesc.ptype, ptype): 7418459SAli.Saidi@ARM.com match_obj = self._values[pname] 7428459SAli.Saidi@ARM.com if not isproxy(match_obj) and not isNullPointer(match_obj): 7438459SAli.Saidi@ARM.com all[match_obj] = True 7448459SAli.Saidi@ARM.com return all.keys(), True 7458459SAli.Saidi@ARM.com 7461815SN/A def unproxy(self, base): 7471815SN/A return self 7481815SN/A 7497527Ssteve.reinhardt@amd.com def unproxyParams(self): 7503105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 7513105Sstever@eecs.umich.edu value = self._values.get(param) 7526654Snate@binkert.org if value != None and isproxy(value): 7533105Sstever@eecs.umich.edu try: 7543105Sstever@eecs.umich.edu value = value.unproxy(self) 7553105Sstever@eecs.umich.edu except: 7563105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 7573105Sstever@eecs.umich.edu (param, self.path()) 7583105Sstever@eecs.umich.edu raise 7593105Sstever@eecs.umich.edu setattr(self, param, value) 7603105Sstever@eecs.umich.edu 7613107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 7623107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 7633107Sstever@eecs.umich.edu port_names = self._ports.keys() 7643107Sstever@eecs.umich.edu port_names.sort() 7653107Sstever@eecs.umich.edu for port_name in port_names: 7663105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 7673105Sstever@eecs.umich.edu if port != None: 7683105Sstever@eecs.umich.edu port.unproxy(self) 7693105Sstever@eecs.umich.edu 7705037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 7715543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 7721692SN/A 7732738SN/A instanceDict[self.path()] = self 7742738SN/A 7754081Sbinkertn@umich.edu if hasattr(self, 'type'): 7765037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 7771692SN/A 7781692SN/A child_names = self._children.keys() 7791692SN/A child_names.sort() 7804081Sbinkertn@umich.edu if len(child_names): 7817528Ssteve.reinhardt@amd.com print >>ini_file, 'children=%s' % \ 7827528Ssteve.reinhardt@amd.com ' '.join(self._children[n].get_name() for n in child_names) 7831692SN/A 7841692SN/A param_names = self._params.keys() 7851692SN/A param_names.sort() 7861692SN/A for param in param_names: 7873105Sstever@eecs.umich.edu value = self._values.get(param) 7881692SN/A if value != None: 7895037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 7905037Smilesck@eecs.umich.edu self._values[param].ini_str()) 7911692SN/A 7923103Sstever@eecs.umich.edu port_names = self._ports.keys() 7933103Sstever@eecs.umich.edu port_names.sort() 7943103Sstever@eecs.umich.edu for port_name in port_names: 7953105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 7963105Sstever@eecs.umich.edu if port != None: 7975037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 7983103Sstever@eecs.umich.edu 7995543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 8001692SN/A 8014762Snate@binkert.org def getCCParams(self): 8024762Snate@binkert.org if self._ccParams: 8034762Snate@binkert.org return self._ccParams 8044762Snate@binkert.org 8057677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 8064762Snate@binkert.org cc_params = cc_params_struct() 8075488Snate@binkert.org cc_params.pyobj = self 8084762Snate@binkert.org cc_params.name = str(self) 8094762Snate@binkert.org 8104762Snate@binkert.org param_names = self._params.keys() 8114762Snate@binkert.org param_names.sort() 8124762Snate@binkert.org for param in param_names: 8134762Snate@binkert.org value = self._values.get(param) 8144762Snate@binkert.org if value is None: 8156654Snate@binkert.org fatal("%s.%s without default or user set value", 8166654Snate@binkert.org self.path(), param) 8174762Snate@binkert.org 8184762Snate@binkert.org value = value.getValue() 8194762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 8204762Snate@binkert.org assert isinstance(value, list) 8214762Snate@binkert.org vec = getattr(cc_params, param) 8224762Snate@binkert.org assert not len(vec) 8234762Snate@binkert.org for v in value: 8244762Snate@binkert.org vec.append(v) 8254762Snate@binkert.org else: 8264762Snate@binkert.org setattr(cc_params, param, value) 8274762Snate@binkert.org 8284762Snate@binkert.org port_names = self._ports.keys() 8294762Snate@binkert.org port_names.sort() 8304762Snate@binkert.org for port_name in port_names: 8314762Snate@binkert.org port = self._port_refs.get(port_name, None) 8324762Snate@binkert.org if port != None: 8334762Snate@binkert.org setattr(cc_params, port_name, port) 8344762Snate@binkert.org self._ccParams = cc_params 8354762Snate@binkert.org return self._ccParams 8362738SN/A 8372740SN/A # Get C++ object corresponding to this object, calling C++ if 8382740SN/A # necessary to construct it. Does *not* recursively create 8392740SN/A # children. 8402740SN/A def getCCObject(self): 8412740SN/A if not self._ccObject: 8427526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 8437526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 8447526Ssteve.reinhardt@amd.com raise RuntimeError, "Attempt to instantiate orphan node" 8457526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 8465244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 8475244Sgblack@eecs.umich.edu self._ccObject = -1 8485244Sgblack@eecs.umich.edu params = self.getCCParams() 8494762Snate@binkert.org self._ccObject = params.create() 8502740SN/A elif self._ccObject == -1: 8517526Ssteve.reinhardt@amd.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 8522740SN/A % self.path() 8532740SN/A return self._ccObject 8542740SN/A 8557527Ssteve.reinhardt@amd.com def descendants(self): 8567527Ssteve.reinhardt@amd.com yield self 8577527Ssteve.reinhardt@amd.com for child in self._children.itervalues(): 8587527Ssteve.reinhardt@amd.com for obj in child.descendants(): 8597527Ssteve.reinhardt@amd.com yield obj 8607527Ssteve.reinhardt@amd.com 8617527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 8624762Snate@binkert.org def createCCObject(self): 8634762Snate@binkert.org self.getCCParams() 8644762Snate@binkert.org self.getCCObject() # force creation 8654762Snate@binkert.org 8664762Snate@binkert.org def getValue(self): 8674762Snate@binkert.org return self.getCCObject() 8684762Snate@binkert.org 8692738SN/A # Create C++ port connections corresponding to the connections in 8707527Ssteve.reinhardt@amd.com # _port_refs 8712738SN/A def connectPorts(self): 8723105Sstever@eecs.umich.edu for portRef in self._port_refs.itervalues(): 8733105Sstever@eecs.umich.edu portRef.ccConnect() 8742797SN/A 8754553Sbinkertn@umich.edu def getMemoryMode(self): 8764553Sbinkertn@umich.edu if not isinstance(self, m5.objects.System): 8774553Sbinkertn@umich.edu return None 8784553Sbinkertn@umich.edu 8794859Snate@binkert.org return self._ccObject.getMemoryMode() 8804553Sbinkertn@umich.edu 8812797SN/A def changeTiming(self, mode): 8823202Shsul@eecs.umich.edu if isinstance(self, m5.objects.System): 8833202Shsul@eecs.umich.edu # i don't know if there's a better way to do this - calling 8843202Shsul@eecs.umich.edu # setMemoryMode directly from self._ccObject results in calling 8853202Shsul@eecs.umich.edu # SimObject::setMemoryMode, not the System::setMemoryMode 8864859Snate@binkert.org self._ccObject.setMemoryMode(mode) 8872797SN/A 8882797SN/A def takeOverFrom(self, old_cpu): 8894859Snate@binkert.org self._ccObject.takeOverFrom(old_cpu._ccObject) 8902797SN/A 8911692SN/A # generate output file for 'dot' to display as a pretty graph. 8921692SN/A # this code is currently broken. 8931342SN/A def outputDot(self, dot): 8941342SN/A label = "{%s|" % self.path 8951342SN/A if isSimObject(self.realtype): 8961342SN/A label += '%s|' % self.type 8971342SN/A 8981342SN/A if self.children: 8991342SN/A # instantiate children in same order they were added for 9001342SN/A # backward compatibility (else we can end up with cpu1 9011342SN/A # before cpu0). 9021342SN/A for c in self.children: 9031342SN/A dot.add_edge(pydot.Edge(self.path,c.path, style="bold")) 9041342SN/A 9051342SN/A simobjs = [] 9061342SN/A for param in self.params: 9071342SN/A try: 9081342SN/A if param.value is None: 9091342SN/A raise AttributeError, 'Parameter with no value' 9101342SN/A 9111692SN/A value = param.value 9121342SN/A string = param.string(value) 9131587SN/A except Exception, e: 9141605SN/A msg = 'exception in %s:%s\n%s' % (self.name, param.name, e) 9151605SN/A e.args = (msg, ) 9161342SN/A raise 9171605SN/A 9181692SN/A if isSimObject(param.ptype) and string != "Null": 9191342SN/A simobjs.append(string) 9201342SN/A else: 9211342SN/A label += '%s = %s\\n' % (param.name, string) 9221342SN/A 9231342SN/A for so in simobjs: 9241342SN/A label += "|<%s> %s" % (so, so) 9251587SN/A dot.add_edge(pydot.Edge("%s:%s" % (self.path, so), so, 9261587SN/A tailport="w")) 9271342SN/A label += '}' 9281342SN/A dot.add_node(pydot.Node(self.path,shape="Mrecord",label=label)) 9291342SN/A 9301342SN/A # recursively dump out children 9311342SN/A for c in self.children: 9321342SN/A c.outputDot(dot) 9331342SN/A 9343101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 9353101Sstever@eecs.umich.edudef resolveSimObject(name): 9363101Sstever@eecs.umich.edu obj = instanceDict[name] 9373101Sstever@eecs.umich.edu return obj.getCCObject() 938679SN/A 9396654Snate@binkert.orgdef isSimObject(value): 9406654Snate@binkert.org return isinstance(value, SimObject) 9416654Snate@binkert.org 9426654Snate@binkert.orgdef isSimObjectClass(value): 9436654Snate@binkert.org return issubclass(value, SimObject) 9446654Snate@binkert.org 9457528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 9467528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 9477528Ssteve.reinhardt@amd.com 9486654Snate@binkert.orgdef isSimObjectSequence(value): 9496654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 9506654Snate@binkert.org return False 9516654Snate@binkert.org 9526654Snate@binkert.org for val in value: 9536654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 9546654Snate@binkert.org return False 9556654Snate@binkert.org 9566654Snate@binkert.org return True 9576654Snate@binkert.org 9586654Snate@binkert.orgdef isSimObjectOrSequence(value): 9596654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 9606654Snate@binkert.org 9617526Ssteve.reinhardt@amd.comdef isRoot(obj): 9627526Ssteve.reinhardt@amd.com from m5.objects import Root 9637526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 9647526Ssteve.reinhardt@amd.com 9657528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 9667528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 9677528Ssteve.reinhardt@amd.com 9687528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 9697528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 9707528Ssteve.reinhardt@amd.com return value 9717528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 9727528Ssteve.reinhardt@amd.com return SimObjectVector(value) 9737528Ssteve.reinhardt@amd.com return None 9747528Ssteve.reinhardt@amd.com 9757528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 9767528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 9777528Ssteve.reinhardt@amd.com if value is None: 9787528Ssteve.reinhardt@amd.com raise TypeError, "SimObject or SimObjectVector expected" 9797528Ssteve.reinhardt@amd.com return value 9807528Ssteve.reinhardt@amd.com 9816654Snate@binkert.orgbaseClasses = allClasses.copy() 9826654Snate@binkert.orgbaseInstances = instanceDict.copy() 9836654Snate@binkert.org 9846654Snate@binkert.orgdef clear(): 9856654Snate@binkert.org global allClasses, instanceDict 9866654Snate@binkert.org 9876654Snate@binkert.org allClasses = baseClasses.copy() 9886654Snate@binkert.org instanceDict = baseInstances.copy() 9896654Snate@binkert.org 9901528SN/A# __all__ defines the list of symbols that get exported when 9911528SN/A# 'from config import *' is invoked. Try to keep this reasonably 9921528SN/A# short to avoid polluting other namespaces. 9934762Snate@binkert.org__all__ = [ 'SimObject' ] 994