SimObject.py revision 7677
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 327673Snate@binkert.orgfrom types import FunctionType, MethodType 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 default_cxx_predecls(cls, code): 1017675Snate@binkert.org code('#include "params/$cls.hh"') 1027673Snate@binkert.org 1037675Snate@binkert.orgdef default_swig_predecls(cls, code): 1047677Snate@binkert.org code('%import "python/m5/internal/param_$cls.i"') 1057673Snate@binkert.org 1067673Snate@binkert.orgdef default_swig_objdecls(cls, code): 1077673Snate@binkert.org class_path = cls.cxx_class.split('::') 1087673Snate@binkert.org classname = class_path[-1] 1097673Snate@binkert.org namespaces = class_path[:-1] 1107673Snate@binkert.org 1117673Snate@binkert.org for ns in namespaces: 1127673Snate@binkert.org code('namespace $ns {') 1137673Snate@binkert.org 1147673Snate@binkert.org if namespaces: 1157673Snate@binkert.org code('// avoid name conflicts') 1167673Snate@binkert.org sep_string = '_COLONS_' 1177673Snate@binkert.org flat_name = sep_string.join(class_path) 1187673Snate@binkert.org code('%rename($flat_name) $classname;') 1197673Snate@binkert.org 1207673Snate@binkert.org code() 1217673Snate@binkert.org code('// stop swig from creating/wrapping default ctor/dtor') 1227673Snate@binkert.org code('%nodefault $classname;') 1237673Snate@binkert.org code('class $classname') 1247673Snate@binkert.org if cls._base: 1257673Snate@binkert.org code(' : public ${{cls._base.cxx_class}}') 1267673Snate@binkert.org code('{};') 1277673Snate@binkert.org 1287673Snate@binkert.org for ns in reversed(namespaces): 1297673Snate@binkert.org code('/* namespace $ns */ }') 1307673Snate@binkert.org 1317673Snate@binkert.orgdef public_value(key, value): 1327673Snate@binkert.org return key.startswith('_') or \ 1337673Snate@binkert.org isinstance(value, (FunctionType, MethodType, classmethod, type)) 1347673Snate@binkert.org 1352740SN/A# The metaclass for SimObject. This class controls how new classes 1362740SN/A# that derive from SimObject are instantiated, and provides inherited 1372740SN/A# class behavior (just like a class controls how instances of that 1382740SN/A# class are instantiated, and provides inherited instance behavior). 1391692SN/Aclass MetaSimObject(type): 1401427SN/A # Attributes that can be set only at initialization time 1417493Ssteve.reinhardt@amd.com init_keywords = { 'abstract' : bool, 1427493Ssteve.reinhardt@amd.com 'cxx_class' : str, 1437493Ssteve.reinhardt@amd.com 'cxx_type' : str, 1447673Snate@binkert.org 'cxx_predecls' : MethodType, 1457673Snate@binkert.org 'swig_objdecls' : MethodType, 1467673Snate@binkert.org 'swig_predecls' : MethodType, 1477493Ssteve.reinhardt@amd.com 'type' : str } 1481427SN/A # Attributes that can be set any time 1497493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 150679SN/A 151679SN/A # __new__ is called before __init__, and is where the statements 152679SN/A # in the body of the class definition get loaded into the class's 1532740SN/A # __dict__. We intercept this to filter out parameter & port assignments 154679SN/A # and only allow "private" attributes to be passed to the base 155679SN/A # __new__ (starting with underscore). 1561310SN/A def __new__(mcls, name, bases, dict): 1576654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 1584762Snate@binkert.org 1592740SN/A # Copy "private" attributes, functions, and classes to the 1602740SN/A # official dict. Everything else goes in _init_dict to be 1612740SN/A # filtered in __init__. 1622740SN/A cls_dict = {} 1632740SN/A value_dict = {} 1642740SN/A for key,val in dict.items(): 1657673Snate@binkert.org if public_value(key, val): 1662740SN/A cls_dict[key] = val 1672740SN/A else: 1682740SN/A # must be a param/port setting 1692740SN/A value_dict[key] = val 1704762Snate@binkert.org if 'abstract' not in value_dict: 1714762Snate@binkert.org value_dict['abstract'] = False 1722740SN/A cls_dict['_value_dict'] = value_dict 1734762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 1744762Snate@binkert.org if 'type' in value_dict: 1754762Snate@binkert.org allClasses[name] = cls 1764762Snate@binkert.org return cls 177679SN/A 1782711SN/A # subclass initialization 179679SN/A def __init__(cls, name, bases, dict): 1802711SN/A # calls type.__init__()... I think that's a no-op, but leave 1812711SN/A # it here just in case it's not. 1821692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 1831310SN/A 1841427SN/A # initialize required attributes 1852740SN/A 1862740SN/A # class-only attributes 1872740SN/A cls._params = multidict() # param descriptions 1882740SN/A cls._ports = multidict() # port descriptions 1892740SN/A 1902740SN/A # class or instance attributes 1912740SN/A cls._values = multidict() # param values 1927528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 1933105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 1942740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 1951310SN/A 1961692SN/A # We don't support multiple inheritance. If you want to, you 1971585SN/A # must fix multidict to deal with it properly. 1981692SN/A if len(bases) > 1: 1991692SN/A raise TypeError, "SimObjects do not support multiple inheritance" 2001692SN/A 2011692SN/A base = bases[0] 2021692SN/A 2032740SN/A # Set up general inheritance via multidicts. A subclass will 2042740SN/A # inherit all its settings from the base class. The only time 2052740SN/A # the following is not true is when we define the SimObject 2062740SN/A # class itself (in which case the multidicts have no parent). 2071692SN/A if isinstance(base, MetaSimObject): 2085610Snate@binkert.org cls._base = base 2091692SN/A cls._params.parent = base._params 2102740SN/A cls._ports.parent = base._ports 2111692SN/A cls._values.parent = base._values 2127528Ssteve.reinhardt@amd.com cls._children.parent = base._children 2133105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 2142740SN/A # mark base as having been subclassed 2152712SN/A base._instantiated = True 2165610Snate@binkert.org else: 2175610Snate@binkert.org cls._base = None 2181692SN/A 2194762Snate@binkert.org # default keyword values 2204762Snate@binkert.org if 'type' in cls._value_dict: 2214762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 2225610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 2234762Snate@binkert.org 2245610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 2255610Snate@binkert.org 2267673Snate@binkert.org if 'cxx_predecls' not in cls.__dict__: 2277673Snate@binkert.org m = MethodType(default_cxx_predecls, cls, MetaSimObject) 2287673Snate@binkert.org setattr(cls, 'cxx_predecls', m) 2294762Snate@binkert.org 2307673Snate@binkert.org if 'swig_predecls' not in cls.__dict__: 2317675Snate@binkert.org m = MethodType(default_swig_predecls, cls, MetaSimObject) 2327675Snate@binkert.org setattr(cls, 'swig_predecls', m) 2334762Snate@binkert.org 2347673Snate@binkert.org if 'swig_objdecls' not in cls.__dict__: 2357673Snate@binkert.org m = MethodType(default_swig_objdecls, cls, MetaSimObject) 2367673Snate@binkert.org setattr(cls, 'swig_objdecls', m) 2374859Snate@binkert.org 2382740SN/A # Now process the _value_dict items. They could be defining 2392740SN/A # new (or overriding existing) parameters or ports, setting 2402740SN/A # class keywords (e.g., 'abstract'), or setting parameter 2412740SN/A # values or port bindings. The first 3 can only be set when 2422740SN/A # the class is defined, so we handle them here. The others 2432740SN/A # can be set later too, so just emulate that by calling 2442740SN/A # setattr(). 2452740SN/A for key,val in cls._value_dict.items(): 2461527SN/A # param descriptions 2472740SN/A if isinstance(val, ParamDesc): 2481585SN/A cls._new_param(key, val) 2491427SN/A 2502738SN/A # port objects 2512738SN/A elif isinstance(val, Port): 2523105Sstever@eecs.umich.edu cls._new_port(key, val) 2532738SN/A 2541427SN/A # init-time-only keywords 2551427SN/A elif cls.init_keywords.has_key(key): 2561427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 2571427SN/A 2581427SN/A # default: use normal path (ends up in __setattr__) 2591427SN/A else: 2601427SN/A setattr(cls, key, val) 2611427SN/A 2621427SN/A def _set_keyword(cls, keyword, val, kwtype): 2631427SN/A if not isinstance(val, kwtype): 2641427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 2651427SN/A (keyword, type(val), kwtype) 2667493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 2671427SN/A val = classmethod(val) 2681427SN/A type.__setattr__(cls, keyword, val) 2691427SN/A 2703100SN/A def _new_param(cls, name, pdesc): 2713100SN/A # each param desc should be uniquely assigned to one variable 2723100SN/A assert(not hasattr(pdesc, 'name')) 2733100SN/A pdesc.name = name 2743100SN/A cls._params[name] = pdesc 2753100SN/A if hasattr(pdesc, 'default'): 2763105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 2773105Sstever@eecs.umich.edu 2783105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 2793105Sstever@eecs.umich.edu assert(param.name == name) 2803105Sstever@eecs.umich.edu try: 2813105Sstever@eecs.umich.edu cls._values[name] = param.convert(value) 2823105Sstever@eecs.umich.edu except Exception, e: 2833105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 2843105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 2853105Sstever@eecs.umich.edu e.args = (msg, ) 2863105Sstever@eecs.umich.edu raise 2873105Sstever@eecs.umich.edu 2883105Sstever@eecs.umich.edu def _new_port(cls, name, port): 2893105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 2903105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 2913105Sstever@eecs.umich.edu port.name = name 2923105Sstever@eecs.umich.edu cls._ports[name] = port 2933105Sstever@eecs.umich.edu if hasattr(port, 'default'): 2943105Sstever@eecs.umich.edu cls._cls_get_port_ref(name).connect(port.default) 2953105Sstever@eecs.umich.edu 2963105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 2973105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 2983105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 2993105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 3003105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 3013105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 3023105Sstever@eecs.umich.edu if not ref: 3033105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 3043105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 3053105Sstever@eecs.umich.edu return ref 3061585SN/A 3071310SN/A # Set attribute (called on foo.attr = value when foo is an 3081310SN/A # instance of class cls). 3091310SN/A def __setattr__(cls, attr, value): 3101310SN/A # normal processing for private attributes 3117673Snate@binkert.org if public_value(attr, value): 3121310SN/A type.__setattr__(cls, attr, value) 3131310SN/A return 3141310SN/A 3151310SN/A if cls.keywords.has_key(attr): 3161427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 3171310SN/A return 3181310SN/A 3192738SN/A if cls._ports.has_key(attr): 3203105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 3212738SN/A return 3222738SN/A 3232740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 3242740SN/A raise RuntimeError, \ 3252740SN/A "cannot set SimObject parameter '%s' after\n" \ 3262740SN/A " class %s has been instantiated or subclassed" \ 3272740SN/A % (attr, cls.__name__) 3282740SN/A 3292740SN/A # check for param 3303105Sstever@eecs.umich.edu param = cls._params.get(attr) 3311310SN/A if param: 3323105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 3333105Sstever@eecs.umich.edu return 3343105Sstever@eecs.umich.edu 3353105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 3363105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 3377528Ssteve.reinhardt@amd.com cls._children[attr] = coerceSimObjectOrVector(value) 3383105Sstever@eecs.umich.edu return 3393105Sstever@eecs.umich.edu 3403105Sstever@eecs.umich.edu # no valid assignment... raise exception 3413105Sstever@eecs.umich.edu raise AttributeError, \ 3423105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 3431310SN/A 3441585SN/A def __getattr__(cls, attr): 3457675Snate@binkert.org if attr == 'cxx_class_path': 3467675Snate@binkert.org return cls.cxx_class.split('::') 3477675Snate@binkert.org 3487675Snate@binkert.org if attr == 'cxx_class_name': 3497675Snate@binkert.org return cls.cxx_class_path[-1] 3507675Snate@binkert.org 3517675Snate@binkert.org if attr == 'cxx_namespaces': 3527675Snate@binkert.org return cls.cxx_class_path[:-1] 3537675Snate@binkert.org 3541692SN/A if cls._values.has_key(attr): 3551692SN/A return cls._values[attr] 3561585SN/A 3577528Ssteve.reinhardt@amd.com if cls._children.has_key(attr): 3587528Ssteve.reinhardt@amd.com return cls._children[attr] 3597528Ssteve.reinhardt@amd.com 3601585SN/A raise AttributeError, \ 3611585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 3621585SN/A 3633100SN/A def __str__(cls): 3643100SN/A return cls.__name__ 3653100SN/A 3667673Snate@binkert.org def cxx_decl(cls, code): 3673100SN/A # The 'dict' attribute restricts us to the params declared in 3683100SN/A # the object itself, not including inherited params (which 3693100SN/A # will also be inherited from the base class's param struct 3703100SN/A # here). 3714762Snate@binkert.org params = cls._params.local.values() 3723100SN/A try: 3733100SN/A ptypes = [p.ptype for p in params] 3743100SN/A except: 3753100SN/A print cls, p, p.ptype_str 3763100SN/A print params 3773100SN/A raise 3783100SN/A 3797675Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 3807675Snate@binkert.org 3817675Snate@binkert.org code('''\ 3827675Snate@binkert.org#ifndef __PARAMS__${cls}__ 3837675Snate@binkert.org#define __PARAMS__${cls}__ 3847675Snate@binkert.org 3857675Snate@binkert.org''') 3867675Snate@binkert.org 3877675Snate@binkert.org # A forward class declaration is sufficient since we are just 3887675Snate@binkert.org # declaring a pointer. 3897675Snate@binkert.org for ns in class_path[:-1]: 3907675Snate@binkert.org code('namespace $ns {') 3917675Snate@binkert.org code('class $0;', class_path[-1]) 3927675Snate@binkert.org for ns in reversed(class_path[:-1]): 3937675Snate@binkert.org code('/* namespace $ns */ }') 3947675Snate@binkert.org code() 3957675Snate@binkert.org 3967673Snate@binkert.org for param in params: 3977673Snate@binkert.org param.cxx_predecls(code) 3987673Snate@binkert.org code() 3994762Snate@binkert.org 4005610Snate@binkert.org if cls._base: 4017673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 4027673Snate@binkert.org code() 4034762Snate@binkert.org 4044762Snate@binkert.org for ptype in ptypes: 4054762Snate@binkert.org if issubclass(ptype, Enum): 4067673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 4077673Snate@binkert.org code() 4084762Snate@binkert.org 4097673Snate@binkert.org cls.cxx_struct(code, cls._base, params) 4105488Snate@binkert.org 4117673Snate@binkert.org code() 4127673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 4135488Snate@binkert.org return code 4145488Snate@binkert.org 4157673Snate@binkert.org def cxx_struct(cls, code, base, params): 4165488Snate@binkert.org if cls == SimObject: 4177673Snate@binkert.org code('#include "sim/sim_object_params.hh"') 4187673Snate@binkert.org return 4195488Snate@binkert.org 4204762Snate@binkert.org # now generate the actual param struct 4217673Snate@binkert.org code("struct ${cls}Params") 4224762Snate@binkert.org if base: 4237673Snate@binkert.org code(" : public ${{base.type}}Params") 4247673Snate@binkert.org code("{") 4254762Snate@binkert.org if not hasattr(cls, 'abstract') or not cls.abstract: 4264762Snate@binkert.org if 'type' in cls.__dict__: 4277673Snate@binkert.org code(" ${{cls.cxx_type}} create();") 4284762Snate@binkert.org 4297673Snate@binkert.org code.indent() 4307673Snate@binkert.org for param in params: 4317673Snate@binkert.org param.cxx_decl(code) 4327673Snate@binkert.org code.dedent() 4337673Snate@binkert.org code('};') 4344762Snate@binkert.org 4357673Snate@binkert.org def swig_decl(cls, code): 4367673Snate@binkert.org code('''\ 4377673Snate@binkert.org%module $cls 4384762Snate@binkert.org 4397673Snate@binkert.org%{ 4407673Snate@binkert.org#include "params/$cls.hh" 4417673Snate@binkert.org%} 4427673Snate@binkert.org 4437673Snate@binkert.org''') 4444762Snate@binkert.org 4454762Snate@binkert.org # The 'dict' attribute restricts us to the params declared in 4464762Snate@binkert.org # the object itself, not including inherited params (which 4474762Snate@binkert.org # will also be inherited from the base class's param struct 4484762Snate@binkert.org # here). 4494762Snate@binkert.org params = cls._params.local.values() 4504762Snate@binkert.org ptypes = [p.ptype for p in params] 4514762Snate@binkert.org 4527673Snate@binkert.org # get all predeclarations 4537673Snate@binkert.org for param in params: 4547673Snate@binkert.org param.swig_predecls(code) 4557673Snate@binkert.org code() 4563100SN/A 4575610Snate@binkert.org if cls._base: 4587677Snate@binkert.org code('%import "python/m5/internal/param_${{cls._base.type}}.i"') 4597673Snate@binkert.org code() 4603100SN/A 4614762Snate@binkert.org for ptype in ptypes: 4624762Snate@binkert.org if issubclass(ptype, Enum): 4637673Snate@binkert.org code('%import "enums/${{ptype.__name__}}.hh"') 4647673Snate@binkert.org code() 4653100SN/A 4667673Snate@binkert.org code('%import "params/${cls}_type.hh"') 4677673Snate@binkert.org code('%include "params/${cls}.hh"') 4683100SN/A 4692740SN/A# The SimObject class is the root of the special hierarchy. Most of 470679SN/A# the code in this class deals with the configuration hierarchy itself 471679SN/A# (parent/child node relationships). 4721692SN/Aclass SimObject(object): 4731692SN/A # Specify metaclass. Any class inheriting from SimObject will 474679SN/A # get this metaclass. 4751692SN/A __metaclass__ = MetaSimObject 4763100SN/A type = 'SimObject' 4774762Snate@binkert.org abstract = True 4783100SN/A 4797673Snate@binkert.org @classmethod 4807673Snate@binkert.org def swig_objdecls(cls, code): 4817673Snate@binkert.org code('%include "python/swig/sim_object.i"') 482679SN/A 4832740SN/A # Initialize new instance. For objects with SimObject-valued 4842740SN/A # children, we need to recursively clone the classes represented 4852740SN/A # by those param values as well in a consistent "deep copy"-style 4862740SN/A # fashion. That is, we want to make sure that each instance is 4872740SN/A # cloned only once, and that if there are multiple references to 4882740SN/A # the same original object, we end up with the corresponding 4892740SN/A # cloned references all pointing to the same cloned instance. 4902740SN/A def __init__(self, **kwargs): 4912740SN/A ancestor = kwargs.get('_ancestor') 4922740SN/A memo_dict = kwargs.get('_memo') 4932740SN/A if memo_dict is None: 4942740SN/A # prepare to memoize any recursively instantiated objects 4952740SN/A memo_dict = {} 4962740SN/A elif ancestor: 4972740SN/A # memoize me now to avoid problems with recursive calls 4982740SN/A memo_dict[ancestor] = self 4992711SN/A 5002740SN/A if not ancestor: 5012740SN/A ancestor = self.__class__ 5022740SN/A ancestor._instantiated = True 5032711SN/A 5042740SN/A # initialize required attributes 5052740SN/A self._parent = None 5067528Ssteve.reinhardt@amd.com self._name = None 5072740SN/A self._ccObject = None # pointer to C++ object 5084762Snate@binkert.org self._ccParams = None 5092740SN/A self._instantiated = False # really "cloned" 5102712SN/A 5112711SN/A # Inherit parameter values from class using multidict so 5127528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 5137528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 5142740SN/A self._values = multidict(ancestor._values) 5152740SN/A # clone SimObject-valued parameters 5162740SN/A for key,val in ancestor._values.iteritems(): 5177528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 5187528Ssteve.reinhardt@amd.com if val is not None: 5197528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 5207528Ssteve.reinhardt@amd.com 5217528Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 5227528Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 5237528Ssteve.reinhardt@amd.com self._children = {} 5247528Ssteve.reinhardt@amd.com for key,val in ancestor._children.iteritems(): 5257528Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 5267528Ssteve.reinhardt@amd.com 5272740SN/A # clone port references. no need to use a multidict here 5282740SN/A # since we will be creating new references for all ports. 5293105Sstever@eecs.umich.edu self._port_refs = {} 5303105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 5313105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 5321692SN/A # apply attribute assignments from keyword args, if any 5331692SN/A for key,val in kwargs.iteritems(): 5341692SN/A setattr(self, key, val) 535679SN/A 5362740SN/A # "Clone" the current instance by creating another instance of 5372740SN/A # this instance's class, but that inherits its parameter values 5382740SN/A # and port mappings from the current instance. If we're in a 5392740SN/A # "deep copy" recursive clone, check the _memo dict to see if 5402740SN/A # we've already cloned this instance. 5411692SN/A def __call__(self, **kwargs): 5422740SN/A memo_dict = kwargs.get('_memo') 5432740SN/A if memo_dict is None: 5442740SN/A # no memo_dict: must be top-level clone operation. 5452740SN/A # this is only allowed at the root of a hierarchy 5462740SN/A if self._parent: 5472740SN/A raise RuntimeError, "attempt to clone object %s " \ 5482740SN/A "not at the root of a tree (parent = %s)" \ 5492740SN/A % (self, self._parent) 5502740SN/A # create a new dict and use that. 5512740SN/A memo_dict = {} 5522740SN/A kwargs['_memo'] = memo_dict 5532740SN/A elif memo_dict.has_key(self): 5542740SN/A # clone already done & memoized 5552740SN/A return memo_dict[self] 5562740SN/A return self.__class__(_ancestor = self, **kwargs) 5571343SN/A 5583105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 5593105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 5603105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 5613105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 5623105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 5633105Sstever@eecs.umich.edu if not ref: 5643105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 5653105Sstever@eecs.umich.edu self._port_refs[attr] = ref 5663105Sstever@eecs.umich.edu return ref 5673105Sstever@eecs.umich.edu 5681692SN/A def __getattr__(self, attr): 5692738SN/A if self._ports.has_key(attr): 5703105Sstever@eecs.umich.edu return self._get_port_ref(attr) 5712738SN/A 5721692SN/A if self._values.has_key(attr): 5731692SN/A return self._values[attr] 5741427SN/A 5757528Ssteve.reinhardt@amd.com if self._children.has_key(attr): 5767528Ssteve.reinhardt@amd.com return self._children[attr] 5777528Ssteve.reinhardt@amd.com 5787500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 5797500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 5807500Ssteve.reinhardt@amd.com # SWIG-wrapped methods such as init(), regStats(), 5817527Ssteve.reinhardt@amd.com # regFormulas(), resetStats(), startup(), drain(), and 5827527Ssteve.reinhardt@amd.com # resume(). 5837500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 5847500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 5857500Ssteve.reinhardt@amd.com 5861692SN/A raise AttributeError, "object '%s' has no attribute '%s'" \ 5871692SN/A % (self.__class__.__name__, attr) 5881427SN/A 5891692SN/A # Set attribute (called on foo.attr = value when foo is an 5901692SN/A # instance of class cls). 5911692SN/A def __setattr__(self, attr, value): 5921692SN/A # normal processing for private attributes 5931692SN/A if attr.startswith('_'): 5941692SN/A object.__setattr__(self, attr, value) 5951692SN/A return 5961427SN/A 5972738SN/A if self._ports.has_key(attr): 5982738SN/A # set up port connection 5993105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 6002738SN/A return 6012738SN/A 6022740SN/A if isSimObjectOrSequence(value) and self._instantiated: 6032740SN/A raise RuntimeError, \ 6042740SN/A "cannot set SimObject parameter '%s' after\n" \ 6052740SN/A " instance been cloned %s" % (attr, `self`) 6062740SN/A 6073105Sstever@eecs.umich.edu param = self._params.get(attr) 6081692SN/A if param: 6091310SN/A try: 6101692SN/A value = param.convert(value) 6111587SN/A except Exception, e: 6121692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 6131692SN/A (e, self.__class__.__name__, attr, value) 6141605SN/A e.args = (msg, ) 6151605SN/A raise 6167528Ssteve.reinhardt@amd.com self._values[attr] = value 6173105Sstever@eecs.umich.edu return 6181310SN/A 6197528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 6203105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 6217528Ssteve.reinhardt@amd.com self.add_child(attr, value) 6223105Sstever@eecs.umich.edu return 6231693SN/A 6243105Sstever@eecs.umich.edu # no valid assignment... raise exception 6253105Sstever@eecs.umich.edu raise AttributeError, "Class %s has no parameter %s" \ 6263105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 6271310SN/A 6281310SN/A 6291692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 6301692SN/A # not be vectors, and always getting the first element (e.g. cpus) 6311692SN/A def __getitem__(self, key): 6321692SN/A if key == 0: 6331692SN/A return self 6341692SN/A raise TypeError, "Non-zero index '%s' to SimObject" % key 6351310SN/A 6367528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6377528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 6387528Ssteve.reinhardt@amd.com assert self._parent is old_parent 6397528Ssteve.reinhardt@amd.com self._parent = None 6407528Ssteve.reinhardt@amd.com 6417528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6427528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 6437528Ssteve.reinhardt@amd.com self._parent = parent 6447528Ssteve.reinhardt@amd.com self._name = name 6457528Ssteve.reinhardt@amd.com 6467528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 6477528Ssteve.reinhardt@amd.com def get_name(self): 6487528Ssteve.reinhardt@amd.com return self._name 6497528Ssteve.reinhardt@amd.com 6507528Ssteve.reinhardt@amd.com # use this rather than directly accessing _parent for symmetry 6517528Ssteve.reinhardt@amd.com # with SimObjectVector 6527528Ssteve.reinhardt@amd.com def get_parent(self): 6537528Ssteve.reinhardt@amd.com return self._parent 6547528Ssteve.reinhardt@amd.com 6557528Ssteve.reinhardt@amd.com # clear out child with given name 6561693SN/A def clear_child(self, name): 6571693SN/A child = self._children[name] 6587528Ssteve.reinhardt@amd.com child.clear_parent(self) 6591693SN/A del self._children[name] 6601693SN/A 6617528Ssteve.reinhardt@amd.com # Add a new child to this object. 6627528Ssteve.reinhardt@amd.com def add_child(self, name, child): 6637528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 6647528Ssteve.reinhardt@amd.com if child.get_parent(): 6657528Ssteve.reinhardt@amd.com raise RuntimeError, \ 6667528Ssteve.reinhardt@amd.com "add_child('%s'): child '%s' already has parent '%s'" % \ 6677528Ssteve.reinhardt@amd.com (name, child._name, child._parent) 6687528Ssteve.reinhardt@amd.com if self._children.has_key(name): 6697528Ssteve.reinhardt@amd.com clear_child(name) 6707528Ssteve.reinhardt@amd.com child.set_parent(self, name) 6717528Ssteve.reinhardt@amd.com self._children[name] = child 6721310SN/A 6737528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 6747528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 6757528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 6767528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 6777528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 6787528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 6797528Ssteve.reinhardt@amd.com for key,val in self._values.iteritems(): 6807528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 6817528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 6827528Ssteve.reinhardt@amd.com # SimObjectVector class so we can call get_parent() 6837528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 6847528Ssteve.reinhardt@amd.com self._values[key] = val 6857528Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.get_parent(): 6867528Ssteve.reinhardt@amd.com self.add_child(key, val) 6873105Sstever@eecs.umich.edu 6881692SN/A def path(self): 6892740SN/A if not self._parent: 6907525Ssteve.reinhardt@amd.com return '(orphan)' 6911692SN/A ppath = self._parent.path() 6921692SN/A if ppath == 'root': 6931692SN/A return self._name 6941692SN/A return ppath + "." + self._name 6951310SN/A 6961692SN/A def __str__(self): 6971692SN/A return self.path() 6981310SN/A 6991692SN/A def ini_str(self): 7001692SN/A return self.path() 7011310SN/A 7021692SN/A def find_any(self, ptype): 7031692SN/A if isinstance(self, ptype): 7041692SN/A return self, True 7051310SN/A 7061692SN/A found_obj = None 7071692SN/A for child in self._children.itervalues(): 7081692SN/A if isinstance(child, ptype): 7091692SN/A if found_obj != None and child != found_obj: 7101692SN/A raise AttributeError, \ 7111692SN/A 'parent.any matched more than one: %s %s' % \ 7121814SN/A (found_obj.path, child.path) 7131692SN/A found_obj = child 7141692SN/A # search param space 7151692SN/A for pname,pdesc in self._params.iteritems(): 7161692SN/A if issubclass(pdesc.ptype, ptype): 7171692SN/A match_obj = self._values[pname] 7181692SN/A if found_obj != None and found_obj != match_obj: 7191692SN/A raise AttributeError, \ 7205952Ssaidi@eecs.umich.edu 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 7211692SN/A found_obj = match_obj 7221692SN/A return found_obj, found_obj != None 7231692SN/A 7241815SN/A def unproxy(self, base): 7251815SN/A return self 7261815SN/A 7277527Ssteve.reinhardt@amd.com def unproxyParams(self): 7283105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 7293105Sstever@eecs.umich.edu value = self._values.get(param) 7306654Snate@binkert.org if value != None and isproxy(value): 7313105Sstever@eecs.umich.edu try: 7323105Sstever@eecs.umich.edu value = value.unproxy(self) 7333105Sstever@eecs.umich.edu except: 7343105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 7353105Sstever@eecs.umich.edu (param, self.path()) 7363105Sstever@eecs.umich.edu raise 7373105Sstever@eecs.umich.edu setattr(self, param, value) 7383105Sstever@eecs.umich.edu 7393107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 7403107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 7413107Sstever@eecs.umich.edu port_names = self._ports.keys() 7423107Sstever@eecs.umich.edu port_names.sort() 7433107Sstever@eecs.umich.edu for port_name in port_names: 7443105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 7453105Sstever@eecs.umich.edu if port != None: 7463105Sstever@eecs.umich.edu port.unproxy(self) 7473105Sstever@eecs.umich.edu 7485037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 7495543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 7501692SN/A 7512738SN/A instanceDict[self.path()] = self 7522738SN/A 7534081Sbinkertn@umich.edu if hasattr(self, 'type'): 7545037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 7551692SN/A 7561692SN/A child_names = self._children.keys() 7571692SN/A child_names.sort() 7584081Sbinkertn@umich.edu if len(child_names): 7597528Ssteve.reinhardt@amd.com print >>ini_file, 'children=%s' % \ 7607528Ssteve.reinhardt@amd.com ' '.join(self._children[n].get_name() for n in child_names) 7611692SN/A 7621692SN/A param_names = self._params.keys() 7631692SN/A param_names.sort() 7641692SN/A for param in param_names: 7653105Sstever@eecs.umich.edu value = self._values.get(param) 7661692SN/A if value != None: 7675037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 7685037Smilesck@eecs.umich.edu self._values[param].ini_str()) 7691692SN/A 7703103Sstever@eecs.umich.edu port_names = self._ports.keys() 7713103Sstever@eecs.umich.edu port_names.sort() 7723103Sstever@eecs.umich.edu for port_name in port_names: 7733105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 7743105Sstever@eecs.umich.edu if port != None: 7755037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 7763103Sstever@eecs.umich.edu 7775543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 7781692SN/A 7794762Snate@binkert.org def getCCParams(self): 7804762Snate@binkert.org if self._ccParams: 7814762Snate@binkert.org return self._ccParams 7824762Snate@binkert.org 7837677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 7844762Snate@binkert.org cc_params = cc_params_struct() 7855488Snate@binkert.org cc_params.pyobj = self 7864762Snate@binkert.org cc_params.name = str(self) 7874762Snate@binkert.org 7884762Snate@binkert.org param_names = self._params.keys() 7894762Snate@binkert.org param_names.sort() 7904762Snate@binkert.org for param in param_names: 7914762Snate@binkert.org value = self._values.get(param) 7924762Snate@binkert.org if value is None: 7936654Snate@binkert.org fatal("%s.%s without default or user set value", 7946654Snate@binkert.org self.path(), param) 7954762Snate@binkert.org 7964762Snate@binkert.org value = value.getValue() 7974762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 7984762Snate@binkert.org assert isinstance(value, list) 7994762Snate@binkert.org vec = getattr(cc_params, param) 8004762Snate@binkert.org assert not len(vec) 8014762Snate@binkert.org for v in value: 8024762Snate@binkert.org vec.append(v) 8034762Snate@binkert.org else: 8044762Snate@binkert.org setattr(cc_params, param, value) 8054762Snate@binkert.org 8064762Snate@binkert.org port_names = self._ports.keys() 8074762Snate@binkert.org port_names.sort() 8084762Snate@binkert.org for port_name in port_names: 8094762Snate@binkert.org port = self._port_refs.get(port_name, None) 8104762Snate@binkert.org if port != None: 8114762Snate@binkert.org setattr(cc_params, port_name, port) 8124762Snate@binkert.org self._ccParams = cc_params 8134762Snate@binkert.org return self._ccParams 8142738SN/A 8152740SN/A # Get C++ object corresponding to this object, calling C++ if 8162740SN/A # necessary to construct it. Does *not* recursively create 8172740SN/A # children. 8182740SN/A def getCCObject(self): 8192740SN/A if not self._ccObject: 8207526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 8217526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 8227526Ssteve.reinhardt@amd.com raise RuntimeError, "Attempt to instantiate orphan node" 8237526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 8245244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 8255244Sgblack@eecs.umich.edu self._ccObject = -1 8265244Sgblack@eecs.umich.edu params = self.getCCParams() 8274762Snate@binkert.org self._ccObject = params.create() 8282740SN/A elif self._ccObject == -1: 8297526Ssteve.reinhardt@amd.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 8302740SN/A % self.path() 8312740SN/A return self._ccObject 8322740SN/A 8337527Ssteve.reinhardt@amd.com def descendants(self): 8347527Ssteve.reinhardt@amd.com yield self 8357527Ssteve.reinhardt@amd.com for child in self._children.itervalues(): 8367527Ssteve.reinhardt@amd.com for obj in child.descendants(): 8377527Ssteve.reinhardt@amd.com yield obj 8387527Ssteve.reinhardt@amd.com 8397527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 8404762Snate@binkert.org def createCCObject(self): 8414762Snate@binkert.org self.getCCParams() 8424762Snate@binkert.org self.getCCObject() # force creation 8434762Snate@binkert.org 8444762Snate@binkert.org def getValue(self): 8454762Snate@binkert.org return self.getCCObject() 8464762Snate@binkert.org 8472738SN/A # Create C++ port connections corresponding to the connections in 8487527Ssteve.reinhardt@amd.com # _port_refs 8492738SN/A def connectPorts(self): 8503105Sstever@eecs.umich.edu for portRef in self._port_refs.itervalues(): 8513105Sstever@eecs.umich.edu portRef.ccConnect() 8522797SN/A 8534553Sbinkertn@umich.edu def getMemoryMode(self): 8544553Sbinkertn@umich.edu if not isinstance(self, m5.objects.System): 8554553Sbinkertn@umich.edu return None 8564553Sbinkertn@umich.edu 8574859Snate@binkert.org return self._ccObject.getMemoryMode() 8584553Sbinkertn@umich.edu 8592797SN/A def changeTiming(self, mode): 8603202Shsul@eecs.umich.edu if isinstance(self, m5.objects.System): 8613202Shsul@eecs.umich.edu # i don't know if there's a better way to do this - calling 8623202Shsul@eecs.umich.edu # setMemoryMode directly from self._ccObject results in calling 8633202Shsul@eecs.umich.edu # SimObject::setMemoryMode, not the System::setMemoryMode 8644859Snate@binkert.org self._ccObject.setMemoryMode(mode) 8652797SN/A 8662797SN/A def takeOverFrom(self, old_cpu): 8674859Snate@binkert.org self._ccObject.takeOverFrom(old_cpu._ccObject) 8682797SN/A 8691692SN/A # generate output file for 'dot' to display as a pretty graph. 8701692SN/A # this code is currently broken. 8711342SN/A def outputDot(self, dot): 8721342SN/A label = "{%s|" % self.path 8731342SN/A if isSimObject(self.realtype): 8741342SN/A label += '%s|' % self.type 8751342SN/A 8761342SN/A if self.children: 8771342SN/A # instantiate children in same order they were added for 8781342SN/A # backward compatibility (else we can end up with cpu1 8791342SN/A # before cpu0). 8801342SN/A for c in self.children: 8811342SN/A dot.add_edge(pydot.Edge(self.path,c.path, style="bold")) 8821342SN/A 8831342SN/A simobjs = [] 8841342SN/A for param in self.params: 8851342SN/A try: 8861342SN/A if param.value is None: 8871342SN/A raise AttributeError, 'Parameter with no value' 8881342SN/A 8891692SN/A value = param.value 8901342SN/A string = param.string(value) 8911587SN/A except Exception, e: 8921605SN/A msg = 'exception in %s:%s\n%s' % (self.name, param.name, e) 8931605SN/A e.args = (msg, ) 8941342SN/A raise 8951605SN/A 8961692SN/A if isSimObject(param.ptype) and string != "Null": 8971342SN/A simobjs.append(string) 8981342SN/A else: 8991342SN/A label += '%s = %s\\n' % (param.name, string) 9001342SN/A 9011342SN/A for so in simobjs: 9021342SN/A label += "|<%s> %s" % (so, so) 9031587SN/A dot.add_edge(pydot.Edge("%s:%s" % (self.path, so), so, 9041587SN/A tailport="w")) 9051342SN/A label += '}' 9061342SN/A dot.add_node(pydot.Node(self.path,shape="Mrecord",label=label)) 9071342SN/A 9081342SN/A # recursively dump out children 9091342SN/A for c in self.children: 9101342SN/A c.outputDot(dot) 9111342SN/A 9123101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 9133101Sstever@eecs.umich.edudef resolveSimObject(name): 9143101Sstever@eecs.umich.edu obj = instanceDict[name] 9153101Sstever@eecs.umich.edu return obj.getCCObject() 916679SN/A 9176654Snate@binkert.orgdef isSimObject(value): 9186654Snate@binkert.org return isinstance(value, SimObject) 9196654Snate@binkert.org 9206654Snate@binkert.orgdef isSimObjectClass(value): 9216654Snate@binkert.org return issubclass(value, SimObject) 9226654Snate@binkert.org 9237528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 9247528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 9257528Ssteve.reinhardt@amd.com 9266654Snate@binkert.orgdef isSimObjectSequence(value): 9276654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 9286654Snate@binkert.org return False 9296654Snate@binkert.org 9306654Snate@binkert.org for val in value: 9316654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 9326654Snate@binkert.org return False 9336654Snate@binkert.org 9346654Snate@binkert.org return True 9356654Snate@binkert.org 9366654Snate@binkert.orgdef isSimObjectOrSequence(value): 9376654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 9386654Snate@binkert.org 9397526Ssteve.reinhardt@amd.comdef isRoot(obj): 9407526Ssteve.reinhardt@amd.com from m5.objects import Root 9417526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 9427526Ssteve.reinhardt@amd.com 9437528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 9447528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 9457528Ssteve.reinhardt@amd.com 9467528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 9477528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 9487528Ssteve.reinhardt@amd.com return value 9497528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 9507528Ssteve.reinhardt@amd.com return SimObjectVector(value) 9517528Ssteve.reinhardt@amd.com return None 9527528Ssteve.reinhardt@amd.com 9537528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 9547528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 9557528Ssteve.reinhardt@amd.com if value is None: 9567528Ssteve.reinhardt@amd.com raise TypeError, "SimObject or SimObjectVector expected" 9577528Ssteve.reinhardt@amd.com return value 9587528Ssteve.reinhardt@amd.com 9596654Snate@binkert.orgbaseClasses = allClasses.copy() 9606654Snate@binkert.orgbaseInstances = instanceDict.copy() 9616654Snate@binkert.org 9626654Snate@binkert.orgdef clear(): 9636654Snate@binkert.org global allClasses, instanceDict 9646654Snate@binkert.org 9656654Snate@binkert.org allClasses = baseClasses.copy() 9666654Snate@binkert.org instanceDict = baseInstances.copy() 9676654Snate@binkert.org 9681528SN/A# __all__ defines the list of symbols that get exported when 9691528SN/A# 'from config import *' is invoked. Try to keep this reasonably 9701528SN/A# short to avoid polluting other namespaces. 9714762Snate@binkert.org__all__ = [ 'SimObject' ] 972