SimObject.py revision 9195
18840Sandreas.hansson@arm.com# Copyright (c) 2012 ARM Limited 28840Sandreas.hansson@arm.com# All rights reserved. 38840Sandreas.hansson@arm.com# 48840Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 58840Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 68840Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 78840Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 88840Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 98840Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 108840Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 118840Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 128840Sandreas.hansson@arm.com# 132740SN/A# Copyright (c) 2004-2006 The Regents of The University of Michigan 147534Ssteve.reinhardt@amd.com# Copyright (c) 2010 Advanced Micro Devices, Inc. 151046SN/A# All rights reserved. 161046SN/A# 171046SN/A# Redistribution and use in source and binary forms, with or without 181046SN/A# modification, are permitted provided that the following conditions are 191046SN/A# met: redistributions of source code must retain the above copyright 201046SN/A# notice, this list of conditions and the following disclaimer; 211046SN/A# redistributions in binary form must reproduce the above copyright 221046SN/A# notice, this list of conditions and the following disclaimer in the 231046SN/A# documentation and/or other materials provided with the distribution; 241046SN/A# neither the name of the copyright holders nor the names of its 251046SN/A# contributors may be used to endorse or promote products derived from 261046SN/A# this software without specific prior written permission. 271046SN/A# 281046SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 291046SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 301046SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 311046SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 321046SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 331046SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 341046SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 351046SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 361046SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 371046SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 381046SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392665SN/A# 402665SN/A# Authors: Steve Reinhardt 412665SN/A# Nathan Binkert 428840Sandreas.hansson@arm.com# Andreas Hansson 431046SN/A 445766Snate@binkert.orgimport sys 458331Ssteve.reinhardt@amd.comfrom types import FunctionType, MethodType, ModuleType 461438SN/A 474762Snate@binkert.orgimport m5 486654Snate@binkert.orgfrom m5.util import * 493102Sstever@eecs.umich.edu 503102Sstever@eecs.umich.edu# Have to import params up top since Param is referenced on initial 513102Sstever@eecs.umich.edu# load (when SimObject class references Param to create a class 523102Sstever@eecs.umich.edu# variable, the 'name' param)... 536654Snate@binkert.orgfrom m5.params import * 543102Sstever@eecs.umich.edu# There are a few things we need that aren't in params.__all__ since 553102Sstever@eecs.umich.edu# normal users don't need them 567528Ssteve.reinhardt@amd.comfrom m5.params import ParamDesc, VectorParamDesc, \ 578839Sandreas.hansson@arm.com isNullPointer, SimObjectVector, Port 583102Sstever@eecs.umich.edu 596654Snate@binkert.orgfrom m5.proxy import * 606654Snate@binkert.orgfrom m5.proxy import isproxy 61679SN/A 62679SN/A##################################################################### 63679SN/A# 64679SN/A# M5 Python Configuration Utility 65679SN/A# 66679SN/A# The basic idea is to write simple Python programs that build Python 671692SN/A# objects corresponding to M5 SimObjects for the desired simulation 68679SN/A# configuration. For now, the Python emits a .ini file that can be 69679SN/A# parsed by M5. In the future, some tighter integration between M5 70679SN/A# and the Python interpreter may allow bypassing the .ini file. 71679SN/A# 72679SN/A# Each SimObject class in M5 is represented by a Python class with the 73679SN/A# same name. The Python inheritance tree mirrors the M5 C++ tree 74679SN/A# (e.g., SimpleCPU derives from BaseCPU in both cases, and all 75679SN/A# SimObjects inherit from a single SimObject base class). To specify 76679SN/A# an instance of an M5 SimObject in a configuration, the user simply 77679SN/A# instantiates the corresponding Python object. The parameters for 78679SN/A# that SimObject are given by assigning to attributes of the Python 79679SN/A# object, either using keyword assignment in the constructor or in 80679SN/A# separate assignment statements. For example: 81679SN/A# 821692SN/A# cache = BaseCache(size='64KB') 83679SN/A# cache.hit_latency = 3 84679SN/A# cache.assoc = 8 85679SN/A# 86679SN/A# The magic lies in the mapping of the Python attributes for SimObject 87679SN/A# classes to the actual SimObject parameter specifications. This 88679SN/A# allows parameter validity checking in the Python code. Continuing 89679SN/A# the example above, the statements "cache.blurfl=3" or 90679SN/A# "cache.assoc='hello'" would both result in runtime errors in Python, 91679SN/A# since the BaseCache object has no 'blurfl' parameter and the 'assoc' 92679SN/A# parameter requires an integer, respectively. This magic is done 93679SN/A# primarily by overriding the special __setattr__ method that controls 94679SN/A# assignment to object attributes. 95679SN/A# 96679SN/A# Once a set of Python objects have been instantiated in a hierarchy, 97679SN/A# calling 'instantiate(obj)' (where obj is the root of the hierarchy) 982740SN/A# will generate a .ini file. 99679SN/A# 100679SN/A##################################################################### 101679SN/A 1024762Snate@binkert.org# list of all SimObject classes 1034762Snate@binkert.orgallClasses = {} 1044762Snate@binkert.org 1052738SN/A# dict to look up SimObjects based on path 1062738SN/AinstanceDict = {} 1072738SN/A 1087673Snate@binkert.orgdef public_value(key, value): 1097673Snate@binkert.org return key.startswith('_') or \ 1108331Ssteve.reinhardt@amd.com isinstance(value, (FunctionType, MethodType, ModuleType, 1118331Ssteve.reinhardt@amd.com classmethod, type)) 1127673Snate@binkert.org 1132740SN/A# The metaclass for SimObject. This class controls how new classes 1142740SN/A# that derive from SimObject are instantiated, and provides inherited 1152740SN/A# class behavior (just like a class controls how instances of that 1162740SN/A# class are instantiated, and provides inherited instance behavior). 1171692SN/Aclass MetaSimObject(type): 1181427SN/A # Attributes that can be set only at initialization time 1197493Ssteve.reinhardt@amd.com init_keywords = { 'abstract' : bool, 1207493Ssteve.reinhardt@amd.com 'cxx_class' : str, 1217493Ssteve.reinhardt@amd.com 'cxx_type' : str, 1227493Ssteve.reinhardt@amd.com 'type' : str } 1231427SN/A # Attributes that can be set any time 1247493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 125679SN/A 126679SN/A # __new__ is called before __init__, and is where the statements 127679SN/A # in the body of the class definition get loaded into the class's 1282740SN/A # __dict__. We intercept this to filter out parameter & port assignments 129679SN/A # and only allow "private" attributes to be passed to the base 130679SN/A # __new__ (starting with underscore). 1311310SN/A def __new__(mcls, name, bases, dict): 1326654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 1334762Snate@binkert.org 1342740SN/A # Copy "private" attributes, functions, and classes to the 1352740SN/A # official dict. Everything else goes in _init_dict to be 1362740SN/A # filtered in __init__. 1372740SN/A cls_dict = {} 1382740SN/A value_dict = {} 1392740SN/A for key,val in dict.items(): 1407673Snate@binkert.org if public_value(key, val): 1412740SN/A cls_dict[key] = val 1422740SN/A else: 1432740SN/A # must be a param/port setting 1442740SN/A value_dict[key] = val 1454762Snate@binkert.org if 'abstract' not in value_dict: 1464762Snate@binkert.org value_dict['abstract'] = False 1472740SN/A cls_dict['_value_dict'] = value_dict 1484762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 1494762Snate@binkert.org if 'type' in value_dict: 1504762Snate@binkert.org allClasses[name] = cls 1514762Snate@binkert.org return cls 152679SN/A 1532711SN/A # subclass initialization 154679SN/A def __init__(cls, name, bases, dict): 1552711SN/A # calls type.__init__()... I think that's a no-op, but leave 1562711SN/A # it here just in case it's not. 1571692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 1581310SN/A 1591427SN/A # initialize required attributes 1602740SN/A 1612740SN/A # class-only attributes 1622740SN/A cls._params = multidict() # param descriptions 1632740SN/A cls._ports = multidict() # port descriptions 1642740SN/A 1652740SN/A # class or instance attributes 1662740SN/A cls._values = multidict() # param values 1677528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 1683105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 1692740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 1701310SN/A 1719100SBrad.Beckmann@amd.com # We don't support multiple inheritance of sim objects. If you want 1729100SBrad.Beckmann@amd.com # to, you must fix multidict to deal with it properly. Non sim-objects 1739100SBrad.Beckmann@amd.com # are ok, though 1749100SBrad.Beckmann@amd.com bTotal = 0 1759100SBrad.Beckmann@amd.com for c in bases: 1769100SBrad.Beckmann@amd.com if isinstance(c, MetaSimObject): 1779100SBrad.Beckmann@amd.com bTotal += 1 1789100SBrad.Beckmann@amd.com if bTotal > 1: 1799100SBrad.Beckmann@amd.com raise TypeError, "SimObjects do not support multiple inheritance" 1801692SN/A 1811692SN/A base = bases[0] 1821692SN/A 1832740SN/A # Set up general inheritance via multidicts. A subclass will 1842740SN/A # inherit all its settings from the base class. The only time 1852740SN/A # the following is not true is when we define the SimObject 1862740SN/A # class itself (in which case the multidicts have no parent). 1871692SN/A if isinstance(base, MetaSimObject): 1885610Snate@binkert.org cls._base = base 1891692SN/A cls._params.parent = base._params 1902740SN/A cls._ports.parent = base._ports 1911692SN/A cls._values.parent = base._values 1927528Ssteve.reinhardt@amd.com cls._children.parent = base._children 1933105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 1942740SN/A # mark base as having been subclassed 1952712SN/A base._instantiated = True 1965610Snate@binkert.org else: 1975610Snate@binkert.org cls._base = None 1981692SN/A 1994762Snate@binkert.org # default keyword values 2004762Snate@binkert.org if 'type' in cls._value_dict: 2014762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 2025610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 2034762Snate@binkert.org 2045610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 2054859Snate@binkert.org 2068597Ssteve.reinhardt@amd.com # Export methods are automatically inherited via C++, so we 2078597Ssteve.reinhardt@amd.com # don't want the method declarations to get inherited on the 2088597Ssteve.reinhardt@amd.com # python side (and thus end up getting repeated in the wrapped 2098597Ssteve.reinhardt@amd.com # versions of derived classes). The code below basicallly 2108597Ssteve.reinhardt@amd.com # suppresses inheritance by substituting in the base (null) 2118597Ssteve.reinhardt@amd.com # versions of these methods unless a different version is 2128597Ssteve.reinhardt@amd.com # explicitly supplied. 2138597Ssteve.reinhardt@amd.com for method_name in ('export_methods', 'export_method_cxx_predecls', 2148597Ssteve.reinhardt@amd.com 'export_method_swig_predecls'): 2158597Ssteve.reinhardt@amd.com if method_name not in cls.__dict__: 2168597Ssteve.reinhardt@amd.com base_method = getattr(MetaSimObject, method_name) 2178597Ssteve.reinhardt@amd.com m = MethodType(base_method, cls, MetaSimObject) 2188597Ssteve.reinhardt@amd.com setattr(cls, method_name, m) 2198597Ssteve.reinhardt@amd.com 2202740SN/A # Now process the _value_dict items. They could be defining 2212740SN/A # new (or overriding existing) parameters or ports, setting 2222740SN/A # class keywords (e.g., 'abstract'), or setting parameter 2232740SN/A # values or port bindings. The first 3 can only be set when 2242740SN/A # the class is defined, so we handle them here. The others 2252740SN/A # can be set later too, so just emulate that by calling 2262740SN/A # setattr(). 2272740SN/A for key,val in cls._value_dict.items(): 2281527SN/A # param descriptions 2292740SN/A if isinstance(val, ParamDesc): 2301585SN/A cls._new_param(key, val) 2311427SN/A 2322738SN/A # port objects 2332738SN/A elif isinstance(val, Port): 2343105Sstever@eecs.umich.edu cls._new_port(key, val) 2352738SN/A 2361427SN/A # init-time-only keywords 2371427SN/A elif cls.init_keywords.has_key(key): 2381427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 2391427SN/A 2401427SN/A # default: use normal path (ends up in __setattr__) 2411427SN/A else: 2421427SN/A setattr(cls, key, val) 2431427SN/A 2441427SN/A def _set_keyword(cls, keyword, val, kwtype): 2451427SN/A if not isinstance(val, kwtype): 2461427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 2471427SN/A (keyword, type(val), kwtype) 2487493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 2491427SN/A val = classmethod(val) 2501427SN/A type.__setattr__(cls, keyword, val) 2511427SN/A 2523100SN/A def _new_param(cls, name, pdesc): 2533100SN/A # each param desc should be uniquely assigned to one variable 2543100SN/A assert(not hasattr(pdesc, 'name')) 2553100SN/A pdesc.name = name 2563100SN/A cls._params[name] = pdesc 2573100SN/A if hasattr(pdesc, 'default'): 2583105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 2593105Sstever@eecs.umich.edu 2603105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 2613105Sstever@eecs.umich.edu assert(param.name == name) 2623105Sstever@eecs.umich.edu try: 2638321Ssteve.reinhardt@amd.com value = param.convert(value) 2643105Sstever@eecs.umich.edu except Exception, e: 2653105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 2663105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 2673105Sstever@eecs.umich.edu e.args = (msg, ) 2683105Sstever@eecs.umich.edu raise 2698321Ssteve.reinhardt@amd.com cls._values[name] = value 2708321Ssteve.reinhardt@amd.com # if param value is a SimObject, make it a child too, so that 2718321Ssteve.reinhardt@amd.com # it gets cloned properly when the class is instantiated 2728321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 2738321Ssteve.reinhardt@amd.com cls._add_cls_child(name, value) 2748321Ssteve.reinhardt@amd.com 2758321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 2768321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 2778321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 2788321Ssteve.reinhardt@amd.com # clears the parent pointer), and this makes it clear that the 2798321Ssteve.reinhardt@amd.com # object is not an orphan and can provide better error 2808321Ssteve.reinhardt@amd.com # messages. 2818321Ssteve.reinhardt@amd.com child.set_parent(cls, name) 2828321Ssteve.reinhardt@amd.com cls._children[name] = child 2833105Sstever@eecs.umich.edu 2843105Sstever@eecs.umich.edu def _new_port(cls, name, port): 2853105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 2863105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 2873105Sstever@eecs.umich.edu port.name = name 2883105Sstever@eecs.umich.edu cls._ports[name] = port 2893105Sstever@eecs.umich.edu 2903105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 2913105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 2923105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 2933105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 2943105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 2953105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 2963105Sstever@eecs.umich.edu if not ref: 2973105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 2983105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 2993105Sstever@eecs.umich.edu return ref 3001585SN/A 3011310SN/A # Set attribute (called on foo.attr = value when foo is an 3021310SN/A # instance of class cls). 3031310SN/A def __setattr__(cls, attr, value): 3041310SN/A # normal processing for private attributes 3057673Snate@binkert.org if public_value(attr, value): 3061310SN/A type.__setattr__(cls, attr, value) 3071310SN/A return 3081310SN/A 3091310SN/A if cls.keywords.has_key(attr): 3101427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 3111310SN/A return 3121310SN/A 3132738SN/A if cls._ports.has_key(attr): 3143105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 3152738SN/A return 3162738SN/A 3172740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 3182740SN/A raise RuntimeError, \ 3192740SN/A "cannot set SimObject parameter '%s' after\n" \ 3202740SN/A " class %s has been instantiated or subclassed" \ 3212740SN/A % (attr, cls.__name__) 3222740SN/A 3232740SN/A # check for param 3243105Sstever@eecs.umich.edu param = cls._params.get(attr) 3251310SN/A if param: 3263105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 3273105Sstever@eecs.umich.edu return 3283105Sstever@eecs.umich.edu 3293105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 3303105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 3318321Ssteve.reinhardt@amd.com cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 3323105Sstever@eecs.umich.edu return 3333105Sstever@eecs.umich.edu 3343105Sstever@eecs.umich.edu # no valid assignment... raise exception 3353105Sstever@eecs.umich.edu raise AttributeError, \ 3363105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 3371310SN/A 3381585SN/A def __getattr__(cls, attr): 3397675Snate@binkert.org if attr == 'cxx_class_path': 3407675Snate@binkert.org return cls.cxx_class.split('::') 3417675Snate@binkert.org 3427675Snate@binkert.org if attr == 'cxx_class_name': 3437675Snate@binkert.org return cls.cxx_class_path[-1] 3447675Snate@binkert.org 3457675Snate@binkert.org if attr == 'cxx_namespaces': 3467675Snate@binkert.org return cls.cxx_class_path[:-1] 3477675Snate@binkert.org 3481692SN/A if cls._values.has_key(attr): 3491692SN/A return cls._values[attr] 3501585SN/A 3517528Ssteve.reinhardt@amd.com if cls._children.has_key(attr): 3527528Ssteve.reinhardt@amd.com return cls._children[attr] 3537528Ssteve.reinhardt@amd.com 3541585SN/A raise AttributeError, \ 3551585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 3561585SN/A 3573100SN/A def __str__(cls): 3583100SN/A return cls.__name__ 3593100SN/A 3608596Ssteve.reinhardt@amd.com # See ParamValue.cxx_predecls for description. 3618596Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 3628596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 3638596Ssteve.reinhardt@amd.com 3648596Ssteve.reinhardt@amd.com # See ParamValue.swig_predecls for description. 3658596Ssteve.reinhardt@amd.com def swig_predecls(cls, code): 3668596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_$cls.i"') 3678596Ssteve.reinhardt@amd.com 3688597Ssteve.reinhardt@amd.com # Hook for exporting additional C++ methods to Python via SWIG. 3698597Ssteve.reinhardt@amd.com # Default is none, override using @classmethod in class definition. 3708597Ssteve.reinhardt@amd.com def export_methods(cls, code): 3718597Ssteve.reinhardt@amd.com pass 3728597Ssteve.reinhardt@amd.com 3738597Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 3748597Ssteve.reinhardt@amd.com # exported via export_methods() to be compiled in the _wrap.cc 3758597Ssteve.reinhardt@amd.com # file. Typically generates one or more #include statements. If 3768597Ssteve.reinhardt@amd.com # any methods are exported, typically at least the C++ header 3778597Ssteve.reinhardt@amd.com # declaring the relevant SimObject class must be included. 3788597Ssteve.reinhardt@amd.com def export_method_cxx_predecls(cls, code): 3798597Ssteve.reinhardt@amd.com pass 3808597Ssteve.reinhardt@amd.com 3818597Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 3828597Ssteve.reinhardt@amd.com # exported via export_methods() to be processed by SWIG. 3838597Ssteve.reinhardt@amd.com # Typically generates one or more %include or %import statements. 3848597Ssteve.reinhardt@amd.com # If any methods are exported, typically at least the C++ header 3858597Ssteve.reinhardt@amd.com # declaring the relevant SimObject class must be included. 3868597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 3878597Ssteve.reinhardt@amd.com pass 3888597Ssteve.reinhardt@amd.com 3898596Ssteve.reinhardt@amd.com # Generate the declaration for this object for wrapping with SWIG. 3908596Ssteve.reinhardt@amd.com # Generates code that goes into a SWIG .i file. Called from 3918596Ssteve.reinhardt@amd.com # src/SConscript. 3928596Ssteve.reinhardt@amd.com def swig_decl(cls, code): 3938596Ssteve.reinhardt@amd.com class_path = cls.cxx_class.split('::') 3948596Ssteve.reinhardt@amd.com classname = class_path[-1] 3958596Ssteve.reinhardt@amd.com namespaces = class_path[:-1] 3968596Ssteve.reinhardt@amd.com 3978596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 3988596Ssteve.reinhardt@amd.com # the object itself, not including inherited params (which 3998596Ssteve.reinhardt@amd.com # will also be inherited from the base class's param struct 4008596Ssteve.reinhardt@amd.com # here). 4018596Ssteve.reinhardt@amd.com params = cls._params.local.values() 4028840Sandreas.hansson@arm.com ports = cls._ports.local 4038596Ssteve.reinhardt@amd.com 4048596Ssteve.reinhardt@amd.com code('%module(package="m5.internal") param_$cls') 4058596Ssteve.reinhardt@amd.com code() 4068596Ssteve.reinhardt@amd.com code('%{') 4078596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 4088596Ssteve.reinhardt@amd.com for param in params: 4098596Ssteve.reinhardt@amd.com param.cxx_predecls(code) 4108597Ssteve.reinhardt@amd.com cls.export_method_cxx_predecls(code) 4118860Sandreas.hansson@arm.com code('''\ 4128860Sandreas.hansson@arm.com/** 4138860Sandreas.hansson@arm.com * This is a workaround for bug in swig. Prior to gcc 4.6.1 the STL 4148860Sandreas.hansson@arm.com * headers like vector, string, etc. used to automatically pull in 4158860Sandreas.hansson@arm.com * the cstddef header but starting with gcc 4.6.1 they no longer do. 4168860Sandreas.hansson@arm.com * This leads to swig generated a file that does not compile so we 4178860Sandreas.hansson@arm.com * explicitly include cstddef. Additionally, including version 2.0.4, 4188860Sandreas.hansson@arm.com * swig uses ptrdiff_t without the std:: namespace prefix which is 4198860Sandreas.hansson@arm.com * required with gcc 4.6.1. We explicitly provide access to it. 4208860Sandreas.hansson@arm.com */ 4218860Sandreas.hansson@arm.com#include <cstddef> 4228860Sandreas.hansson@arm.comusing std::ptrdiff_t; 4238860Sandreas.hansson@arm.com''') 4248596Ssteve.reinhardt@amd.com code('%}') 4258596Ssteve.reinhardt@amd.com code() 4268596Ssteve.reinhardt@amd.com 4278596Ssteve.reinhardt@amd.com for param in params: 4288596Ssteve.reinhardt@amd.com param.swig_predecls(code) 4298597Ssteve.reinhardt@amd.com cls.export_method_swig_predecls(code) 4308596Ssteve.reinhardt@amd.com 4318596Ssteve.reinhardt@amd.com code() 4328596Ssteve.reinhardt@amd.com if cls._base: 4338596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_${{cls._base}}.i"') 4348596Ssteve.reinhardt@amd.com code() 4358596Ssteve.reinhardt@amd.com 4368596Ssteve.reinhardt@amd.com for ns in namespaces: 4378596Ssteve.reinhardt@amd.com code('namespace $ns {') 4388596Ssteve.reinhardt@amd.com 4398596Ssteve.reinhardt@amd.com if namespaces: 4408596Ssteve.reinhardt@amd.com code('// avoid name conflicts') 4418596Ssteve.reinhardt@amd.com sep_string = '_COLONS_' 4428596Ssteve.reinhardt@amd.com flat_name = sep_string.join(class_path) 4438596Ssteve.reinhardt@amd.com code('%rename($flat_name) $classname;') 4448596Ssteve.reinhardt@amd.com 4458597Ssteve.reinhardt@amd.com code() 4468597Ssteve.reinhardt@amd.com code('// stop swig from creating/wrapping default ctor/dtor') 4478597Ssteve.reinhardt@amd.com code('%nodefault $classname;') 4488597Ssteve.reinhardt@amd.com code('class $classname') 4498597Ssteve.reinhardt@amd.com if cls._base: 4508597Ssteve.reinhardt@amd.com code(' : public ${{cls._base.cxx_class}}') 4518597Ssteve.reinhardt@amd.com code('{') 4528597Ssteve.reinhardt@amd.com code(' public:') 4538597Ssteve.reinhardt@amd.com cls.export_methods(code) 4548597Ssteve.reinhardt@amd.com code('};') 4558596Ssteve.reinhardt@amd.com 4568596Ssteve.reinhardt@amd.com for ns in reversed(namespaces): 4578596Ssteve.reinhardt@amd.com code('} // namespace $ns') 4588596Ssteve.reinhardt@amd.com 4598596Ssteve.reinhardt@amd.com code() 4608596Ssteve.reinhardt@amd.com code('%include "params/$cls.hh"') 4618596Ssteve.reinhardt@amd.com 4628596Ssteve.reinhardt@amd.com 4638596Ssteve.reinhardt@amd.com # Generate the C++ declaration (.hh file) for this SimObject's 4648596Ssteve.reinhardt@amd.com # param struct. Called from src/SConscript. 4658596Ssteve.reinhardt@amd.com def cxx_param_decl(cls, code): 4668596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 4673100SN/A # the object itself, not including inherited params (which 4683100SN/A # will also be inherited from the base class's param struct 4693100SN/A # here). 4704762Snate@binkert.org params = cls._params.local.values() 4718840Sandreas.hansson@arm.com ports = cls._ports.local 4723100SN/A try: 4733100SN/A ptypes = [p.ptype for p in params] 4743100SN/A except: 4753100SN/A print cls, p, p.ptype_str 4763100SN/A print params 4773100SN/A raise 4783100SN/A 4797675Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 4807675Snate@binkert.org 4817675Snate@binkert.org code('''\ 4827675Snate@binkert.org#ifndef __PARAMS__${cls}__ 4837675Snate@binkert.org#define __PARAMS__${cls}__ 4847675Snate@binkert.org 4857675Snate@binkert.org''') 4867675Snate@binkert.org 4877675Snate@binkert.org # A forward class declaration is sufficient since we are just 4887675Snate@binkert.org # declaring a pointer. 4897675Snate@binkert.org for ns in class_path[:-1]: 4907675Snate@binkert.org code('namespace $ns {') 4917675Snate@binkert.org code('class $0;', class_path[-1]) 4927675Snate@binkert.org for ns in reversed(class_path[:-1]): 4937811Ssteve.reinhardt@amd.com code('} // namespace $ns') 4947675Snate@binkert.org code() 4957675Snate@binkert.org 4968597Ssteve.reinhardt@amd.com # The base SimObject has a couple of params that get 4978597Ssteve.reinhardt@amd.com # automatically set from Python without being declared through 4988597Ssteve.reinhardt@amd.com # the normal Param mechanism; we slip them in here (needed 4998597Ssteve.reinhardt@amd.com # predecls now, actual declarations below) 5008597Ssteve.reinhardt@amd.com if cls == SimObject: 5018597Ssteve.reinhardt@amd.com code(''' 5028597Ssteve.reinhardt@amd.com#ifndef PY_VERSION 5038597Ssteve.reinhardt@amd.comstruct PyObject; 5048597Ssteve.reinhardt@amd.com#endif 5058597Ssteve.reinhardt@amd.com 5068597Ssteve.reinhardt@amd.com#include <string> 5078597Ssteve.reinhardt@amd.com 5088737Skoansin.tan@gmail.comclass EventQueue; 5098597Ssteve.reinhardt@amd.com''') 5107673Snate@binkert.org for param in params: 5117673Snate@binkert.org param.cxx_predecls(code) 5128840Sandreas.hansson@arm.com for port in ports.itervalues(): 5138840Sandreas.hansson@arm.com port.cxx_predecls(code) 5147673Snate@binkert.org code() 5154762Snate@binkert.org 5165610Snate@binkert.org if cls._base: 5177673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 5187673Snate@binkert.org code() 5194762Snate@binkert.org 5204762Snate@binkert.org for ptype in ptypes: 5214762Snate@binkert.org if issubclass(ptype, Enum): 5227673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 5237673Snate@binkert.org code() 5244762Snate@binkert.org 5258596Ssteve.reinhardt@amd.com # now generate the actual param struct 5268597Ssteve.reinhardt@amd.com code("struct ${cls}Params") 5278597Ssteve.reinhardt@amd.com if cls._base: 5288597Ssteve.reinhardt@amd.com code(" : public ${{cls._base.type}}Params") 5298597Ssteve.reinhardt@amd.com code("{") 5308597Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 5318597Ssteve.reinhardt@amd.com if 'type' in cls.__dict__: 5328597Ssteve.reinhardt@amd.com code(" ${{cls.cxx_type}} create();") 5338597Ssteve.reinhardt@amd.com 5348597Ssteve.reinhardt@amd.com code.indent() 5358596Ssteve.reinhardt@amd.com if cls == SimObject: 5368597Ssteve.reinhardt@amd.com code(''' 5378597Ssteve.reinhardt@amd.com SimObjectParams() 5388597Ssteve.reinhardt@amd.com { 5398597Ssteve.reinhardt@amd.com extern EventQueue mainEventQueue; 5408597Ssteve.reinhardt@amd.com eventq = &mainEventQueue; 5418597Ssteve.reinhardt@amd.com } 5428597Ssteve.reinhardt@amd.com virtual ~SimObjectParams() {} 5438596Ssteve.reinhardt@amd.com 5448597Ssteve.reinhardt@amd.com std::string name; 5458597Ssteve.reinhardt@amd.com PyObject *pyobj; 5468597Ssteve.reinhardt@amd.com EventQueue *eventq; 5478597Ssteve.reinhardt@amd.com ''') 5488597Ssteve.reinhardt@amd.com for param in params: 5498597Ssteve.reinhardt@amd.com param.cxx_decl(code) 5508840Sandreas.hansson@arm.com for port in ports.itervalues(): 5518840Sandreas.hansson@arm.com port.cxx_decl(code) 5528840Sandreas.hansson@arm.com 5538597Ssteve.reinhardt@amd.com code.dedent() 5548597Ssteve.reinhardt@amd.com code('};') 5555488Snate@binkert.org 5567673Snate@binkert.org code() 5577673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 5585488Snate@binkert.org return code 5595488Snate@binkert.org 5605488Snate@binkert.org 5613100SN/A 5622740SN/A# The SimObject class is the root of the special hierarchy. Most of 563679SN/A# the code in this class deals with the configuration hierarchy itself 564679SN/A# (parent/child node relationships). 5651692SN/Aclass SimObject(object): 5661692SN/A # Specify metaclass. Any class inheriting from SimObject will 567679SN/A # get this metaclass. 5681692SN/A __metaclass__ = MetaSimObject 5693100SN/A type = 'SimObject' 5704762Snate@binkert.org abstract = True 5713100SN/A 5728597Ssteve.reinhardt@amd.com @classmethod 5738597Ssteve.reinhardt@amd.com def export_method_cxx_predecls(cls, code): 5748597Ssteve.reinhardt@amd.com code(''' 5758597Ssteve.reinhardt@amd.com#include <Python.h> 5768597Ssteve.reinhardt@amd.com 5778597Ssteve.reinhardt@amd.com#include "sim/serialize.hh" 5788597Ssteve.reinhardt@amd.com#include "sim/sim_object.hh" 5798597Ssteve.reinhardt@amd.com''') 5808597Ssteve.reinhardt@amd.com 5818597Ssteve.reinhardt@amd.com @classmethod 5828597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 5838597Ssteve.reinhardt@amd.com code(''' 5848597Ssteve.reinhardt@amd.com%include <std_string.i> 5858597Ssteve.reinhardt@amd.com''') 5868597Ssteve.reinhardt@amd.com 5878597Ssteve.reinhardt@amd.com @classmethod 5888597Ssteve.reinhardt@amd.com def export_methods(cls, code): 5898597Ssteve.reinhardt@amd.com code(''' 5908597Ssteve.reinhardt@amd.com enum State { 5918597Ssteve.reinhardt@amd.com Running, 5928597Ssteve.reinhardt@amd.com Draining, 5938597Ssteve.reinhardt@amd.com Drained 5948597Ssteve.reinhardt@amd.com }; 5958597Ssteve.reinhardt@amd.com 5968597Ssteve.reinhardt@amd.com void init(); 5978597Ssteve.reinhardt@amd.com void loadState(Checkpoint *cp); 5988597Ssteve.reinhardt@amd.com void initState(); 5998597Ssteve.reinhardt@amd.com void regStats(); 6008597Ssteve.reinhardt@amd.com void resetStats(); 6018597Ssteve.reinhardt@amd.com void startup(); 6028597Ssteve.reinhardt@amd.com 6038597Ssteve.reinhardt@amd.com unsigned int drain(Event *drain_event); 6048597Ssteve.reinhardt@amd.com void resume(); 6058597Ssteve.reinhardt@amd.com void switchOut(); 6068597Ssteve.reinhardt@amd.com void takeOverFrom(BaseCPU *cpu); 6078597Ssteve.reinhardt@amd.com''') 6088597Ssteve.reinhardt@amd.com 6092740SN/A # Initialize new instance. For objects with SimObject-valued 6102740SN/A # children, we need to recursively clone the classes represented 6112740SN/A # by those param values as well in a consistent "deep copy"-style 6122740SN/A # fashion. That is, we want to make sure that each instance is 6132740SN/A # cloned only once, and that if there are multiple references to 6142740SN/A # the same original object, we end up with the corresponding 6152740SN/A # cloned references all pointing to the same cloned instance. 6162740SN/A def __init__(self, **kwargs): 6172740SN/A ancestor = kwargs.get('_ancestor') 6182740SN/A memo_dict = kwargs.get('_memo') 6192740SN/A if memo_dict is None: 6202740SN/A # prepare to memoize any recursively instantiated objects 6212740SN/A memo_dict = {} 6222740SN/A elif ancestor: 6232740SN/A # memoize me now to avoid problems with recursive calls 6242740SN/A memo_dict[ancestor] = self 6252711SN/A 6262740SN/A if not ancestor: 6272740SN/A ancestor = self.__class__ 6282740SN/A ancestor._instantiated = True 6292711SN/A 6302740SN/A # initialize required attributes 6312740SN/A self._parent = None 6327528Ssteve.reinhardt@amd.com self._name = None 6332740SN/A self._ccObject = None # pointer to C++ object 6344762Snate@binkert.org self._ccParams = None 6352740SN/A self._instantiated = False # really "cloned" 6362712SN/A 6378321Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 6388321Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 6398321Ssteve.reinhardt@amd.com # Do children before parameter values so that children that 6408321Ssteve.reinhardt@amd.com # are also param values get cloned properly. 6418321Ssteve.reinhardt@amd.com self._children = {} 6428321Ssteve.reinhardt@amd.com for key,val in ancestor._children.iteritems(): 6438321Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 6448321Ssteve.reinhardt@amd.com 6452711SN/A # Inherit parameter values from class using multidict so 6467528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 6477528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 6482740SN/A self._values = multidict(ancestor._values) 6492740SN/A # clone SimObject-valued parameters 6502740SN/A for key,val in ancestor._values.iteritems(): 6517528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 6527528Ssteve.reinhardt@amd.com if val is not None: 6537528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 6547528Ssteve.reinhardt@amd.com 6552740SN/A # clone port references. no need to use a multidict here 6562740SN/A # since we will be creating new references for all ports. 6573105Sstever@eecs.umich.edu self._port_refs = {} 6583105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 6593105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 6601692SN/A # apply attribute assignments from keyword args, if any 6611692SN/A for key,val in kwargs.iteritems(): 6621692SN/A setattr(self, key, val) 663679SN/A 6642740SN/A # "Clone" the current instance by creating another instance of 6652740SN/A # this instance's class, but that inherits its parameter values 6662740SN/A # and port mappings from the current instance. If we're in a 6672740SN/A # "deep copy" recursive clone, check the _memo dict to see if 6682740SN/A # we've already cloned this instance. 6691692SN/A def __call__(self, **kwargs): 6702740SN/A memo_dict = kwargs.get('_memo') 6712740SN/A if memo_dict is None: 6722740SN/A # no memo_dict: must be top-level clone operation. 6732740SN/A # this is only allowed at the root of a hierarchy 6742740SN/A if self._parent: 6752740SN/A raise RuntimeError, "attempt to clone object %s " \ 6762740SN/A "not at the root of a tree (parent = %s)" \ 6772740SN/A % (self, self._parent) 6782740SN/A # create a new dict and use that. 6792740SN/A memo_dict = {} 6802740SN/A kwargs['_memo'] = memo_dict 6812740SN/A elif memo_dict.has_key(self): 6822740SN/A # clone already done & memoized 6832740SN/A return memo_dict[self] 6842740SN/A return self.__class__(_ancestor = self, **kwargs) 6851343SN/A 6863105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 6873105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 6883105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 6893105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 6903105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 6913105Sstever@eecs.umich.edu if not ref: 6923105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 6933105Sstever@eecs.umich.edu self._port_refs[attr] = ref 6943105Sstever@eecs.umich.edu return ref 6953105Sstever@eecs.umich.edu 6961692SN/A def __getattr__(self, attr): 6972738SN/A if self._ports.has_key(attr): 6983105Sstever@eecs.umich.edu return self._get_port_ref(attr) 6992738SN/A 7001692SN/A if self._values.has_key(attr): 7011692SN/A return self._values[attr] 7021427SN/A 7037528Ssteve.reinhardt@amd.com if self._children.has_key(attr): 7047528Ssteve.reinhardt@amd.com return self._children[attr] 7057528Ssteve.reinhardt@amd.com 7067500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 7077500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 7087500Ssteve.reinhardt@amd.com # SWIG-wrapped methods such as init(), regStats(), 7099195SAndreas.Sandberg@arm.com # resetStats(), startup(), drain(), and 7107527Ssteve.reinhardt@amd.com # resume(). 7117500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 7127500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 7137500Ssteve.reinhardt@amd.com 7141692SN/A raise AttributeError, "object '%s' has no attribute '%s'" \ 7151692SN/A % (self.__class__.__name__, attr) 7161427SN/A 7171692SN/A # Set attribute (called on foo.attr = value when foo is an 7181692SN/A # instance of class cls). 7191692SN/A def __setattr__(self, attr, value): 7201692SN/A # normal processing for private attributes 7211692SN/A if attr.startswith('_'): 7221692SN/A object.__setattr__(self, attr, value) 7231692SN/A return 7241427SN/A 7252738SN/A if self._ports.has_key(attr): 7262738SN/A # set up port connection 7273105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 7282738SN/A return 7292738SN/A 7302740SN/A if isSimObjectOrSequence(value) and self._instantiated: 7312740SN/A raise RuntimeError, \ 7322740SN/A "cannot set SimObject parameter '%s' after\n" \ 7332740SN/A " instance been cloned %s" % (attr, `self`) 7342740SN/A 7353105Sstever@eecs.umich.edu param = self._params.get(attr) 7361692SN/A if param: 7371310SN/A try: 7381692SN/A value = param.convert(value) 7391587SN/A except Exception, e: 7401692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 7411692SN/A (e, self.__class__.__name__, attr, value) 7421605SN/A e.args = (msg, ) 7431605SN/A raise 7447528Ssteve.reinhardt@amd.com self._values[attr] = value 7458321Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 7468321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 7478321Ssteve.reinhardt@amd.com self.add_child(attr, value) 7483105Sstever@eecs.umich.edu return 7491310SN/A 7507528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 7513105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 7527528Ssteve.reinhardt@amd.com self.add_child(attr, value) 7533105Sstever@eecs.umich.edu return 7541693SN/A 7553105Sstever@eecs.umich.edu # no valid assignment... raise exception 7563105Sstever@eecs.umich.edu raise AttributeError, "Class %s has no parameter %s" \ 7573105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 7581310SN/A 7591310SN/A 7601692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 7611692SN/A # not be vectors, and always getting the first element (e.g. cpus) 7621692SN/A def __getitem__(self, key): 7631692SN/A if key == 0: 7641692SN/A return self 7651692SN/A raise TypeError, "Non-zero index '%s' to SimObject" % key 7661310SN/A 7677528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7687528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 7697528Ssteve.reinhardt@amd.com assert self._parent is old_parent 7707528Ssteve.reinhardt@amd.com self._parent = None 7717528Ssteve.reinhardt@amd.com 7727528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7737528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 7747528Ssteve.reinhardt@amd.com self._parent = parent 7757528Ssteve.reinhardt@amd.com self._name = name 7767528Ssteve.reinhardt@amd.com 7777528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7787528Ssteve.reinhardt@amd.com def get_name(self): 7797528Ssteve.reinhardt@amd.com return self._name 7807528Ssteve.reinhardt@amd.com 7818321Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7828321Ssteve.reinhardt@amd.com def has_parent(self): 7838321Ssteve.reinhardt@amd.com return self._parent is not None 7847528Ssteve.reinhardt@amd.com 7857742Sgblack@eecs.umich.edu # clear out child with given name. This code is not likely to be exercised. 7867742Sgblack@eecs.umich.edu # See comment in add_child. 7871693SN/A def clear_child(self, name): 7881693SN/A child = self._children[name] 7897528Ssteve.reinhardt@amd.com child.clear_parent(self) 7901693SN/A del self._children[name] 7911693SN/A 7927528Ssteve.reinhardt@amd.com # Add a new child to this object. 7937528Ssteve.reinhardt@amd.com def add_child(self, name, child): 7947528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 7958321Ssteve.reinhardt@amd.com if child.has_parent(): 7968321Ssteve.reinhardt@amd.com print "warning: add_child('%s'): child '%s' already has parent" % \ 7978321Ssteve.reinhardt@amd.com (name, child.get_name()) 7987528Ssteve.reinhardt@amd.com if self._children.has_key(name): 7997742Sgblack@eecs.umich.edu # This code path had an undiscovered bug that would make it fail 8007742Sgblack@eecs.umich.edu # at runtime. It had been here for a long time and was only 8017742Sgblack@eecs.umich.edu # exposed by a buggy script. Changes here will probably not be 8027742Sgblack@eecs.umich.edu # exercised without specialized testing. 8037738Sgblack@eecs.umich.edu self.clear_child(name) 8047528Ssteve.reinhardt@amd.com child.set_parent(self, name) 8057528Ssteve.reinhardt@amd.com self._children[name] = child 8061310SN/A 8077528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 8087528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 8097528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 8107528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 8117528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 8127528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 8137528Ssteve.reinhardt@amd.com for key,val in self._values.iteritems(): 8147528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 8157528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 8168321Ssteve.reinhardt@amd.com # SimObjectVector class so we can call has_parent() 8177528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 8187528Ssteve.reinhardt@amd.com self._values[key] = val 8198321Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 8208321Ssteve.reinhardt@amd.com print "warning: %s adopting orphan SimObject param '%s'" \ 8218321Ssteve.reinhardt@amd.com % (self, key) 8227528Ssteve.reinhardt@amd.com self.add_child(key, val) 8233105Sstever@eecs.umich.edu 8241692SN/A def path(self): 8252740SN/A if not self._parent: 8268321Ssteve.reinhardt@amd.com return '<orphan %s>' % self.__class__ 8271692SN/A ppath = self._parent.path() 8281692SN/A if ppath == 'root': 8291692SN/A return self._name 8301692SN/A return ppath + "." + self._name 8311310SN/A 8321692SN/A def __str__(self): 8331692SN/A return self.path() 8341310SN/A 8351692SN/A def ini_str(self): 8361692SN/A return self.path() 8371310SN/A 8381692SN/A def find_any(self, ptype): 8391692SN/A if isinstance(self, ptype): 8401692SN/A return self, True 8411310SN/A 8421692SN/A found_obj = None 8431692SN/A for child in self._children.itervalues(): 8441692SN/A if isinstance(child, ptype): 8451692SN/A if found_obj != None and child != found_obj: 8461692SN/A raise AttributeError, \ 8471692SN/A 'parent.any matched more than one: %s %s' % \ 8481814SN/A (found_obj.path, child.path) 8491692SN/A found_obj = child 8501692SN/A # search param space 8511692SN/A for pname,pdesc in self._params.iteritems(): 8521692SN/A if issubclass(pdesc.ptype, ptype): 8531692SN/A match_obj = self._values[pname] 8541692SN/A if found_obj != None and found_obj != match_obj: 8551692SN/A raise AttributeError, \ 8565952Ssaidi@eecs.umich.edu 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 8571692SN/A found_obj = match_obj 8581692SN/A return found_obj, found_obj != None 8591692SN/A 8608459SAli.Saidi@ARM.com def find_all(self, ptype): 8618459SAli.Saidi@ARM.com all = {} 8628459SAli.Saidi@ARM.com # search children 8638459SAli.Saidi@ARM.com for child in self._children.itervalues(): 8648459SAli.Saidi@ARM.com if isinstance(child, ptype) and not isproxy(child) and \ 8658459SAli.Saidi@ARM.com not isNullPointer(child): 8668459SAli.Saidi@ARM.com all[child] = True 8678927Sandreas.hansson@arm.com if isSimObject(child): 8688927Sandreas.hansson@arm.com # also add results from the child itself 8698927Sandreas.hansson@arm.com child_all, done = child.find_all(ptype) 8708927Sandreas.hansson@arm.com all.update(dict(zip(child_all, [done] * len(child_all)))) 8718459SAli.Saidi@ARM.com # search param space 8728459SAli.Saidi@ARM.com for pname,pdesc in self._params.iteritems(): 8738459SAli.Saidi@ARM.com if issubclass(pdesc.ptype, ptype): 8748459SAli.Saidi@ARM.com match_obj = self._values[pname] 8758459SAli.Saidi@ARM.com if not isproxy(match_obj) and not isNullPointer(match_obj): 8768459SAli.Saidi@ARM.com all[match_obj] = True 8778459SAli.Saidi@ARM.com return all.keys(), True 8788459SAli.Saidi@ARM.com 8791815SN/A def unproxy(self, base): 8801815SN/A return self 8811815SN/A 8827527Ssteve.reinhardt@amd.com def unproxyParams(self): 8833105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 8843105Sstever@eecs.umich.edu value = self._values.get(param) 8856654Snate@binkert.org if value != None and isproxy(value): 8863105Sstever@eecs.umich.edu try: 8873105Sstever@eecs.umich.edu value = value.unproxy(self) 8883105Sstever@eecs.umich.edu except: 8893105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 8903105Sstever@eecs.umich.edu (param, self.path()) 8913105Sstever@eecs.umich.edu raise 8923105Sstever@eecs.umich.edu setattr(self, param, value) 8933105Sstever@eecs.umich.edu 8943107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 8953107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 8963107Sstever@eecs.umich.edu port_names = self._ports.keys() 8973107Sstever@eecs.umich.edu port_names.sort() 8983107Sstever@eecs.umich.edu for port_name in port_names: 8993105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 9003105Sstever@eecs.umich.edu if port != None: 9013105Sstever@eecs.umich.edu port.unproxy(self) 9023105Sstever@eecs.umich.edu 9035037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 9045543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 9051692SN/A 9062738SN/A instanceDict[self.path()] = self 9072738SN/A 9084081Sbinkertn@umich.edu if hasattr(self, 'type'): 9095037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 9101692SN/A 9118664SAli.Saidi@ARM.com if len(self._children.keys()): 9127528Ssteve.reinhardt@amd.com print >>ini_file, 'children=%s' % \ 9138664SAli.Saidi@ARM.com ' '.join(self._children[n].get_name() \ 9148664SAli.Saidi@ARM.com for n in sorted(self._children.keys())) 9151692SN/A 9168664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 9173105Sstever@eecs.umich.edu value = self._values.get(param) 9181692SN/A if value != None: 9195037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 9205037Smilesck@eecs.umich.edu self._values[param].ini_str()) 9211692SN/A 9228664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 9233105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 9243105Sstever@eecs.umich.edu if port != None: 9255037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 9263103Sstever@eecs.umich.edu 9275543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 9281692SN/A 9298664SAli.Saidi@ARM.com # generate a tree of dictionaries expressing all the parameters in the 9308664SAli.Saidi@ARM.com # instantiated system for use by scripts that want to do power, thermal 9318664SAli.Saidi@ARM.com # visualization, and other similar tasks 9328664SAli.Saidi@ARM.com def get_config_as_dict(self): 9338664SAli.Saidi@ARM.com d = attrdict() 9348664SAli.Saidi@ARM.com if hasattr(self, 'type'): 9358664SAli.Saidi@ARM.com d.type = self.type 9368664SAli.Saidi@ARM.com if hasattr(self, 'cxx_class'): 9378664SAli.Saidi@ARM.com d.cxx_class = self.cxx_class 9389017Sandreas.hansson@arm.com # Add the name and path of this object to be able to link to 9399017Sandreas.hansson@arm.com # the stats 9409017Sandreas.hansson@arm.com d.name = self.get_name() 9419017Sandreas.hansson@arm.com d.path = self.path() 9428664SAli.Saidi@ARM.com 9438664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 9448664SAli.Saidi@ARM.com value = self._values.get(param) 9458848Ssteve.reinhardt@amd.com if value != None: 9468848Ssteve.reinhardt@amd.com try: 9478848Ssteve.reinhardt@amd.com # Use native type for those supported by JSON and 9488848Ssteve.reinhardt@amd.com # strings for everything else. skipkeys=True seems 9498848Ssteve.reinhardt@amd.com # to not work as well as one would hope 9508848Ssteve.reinhardt@amd.com if type(self._values[param].value) in \ 9518848Ssteve.reinhardt@amd.com [str, unicode, int, long, float, bool, None]: 9528848Ssteve.reinhardt@amd.com d[param] = self._values[param].value 9538848Ssteve.reinhardt@amd.com else: 9548848Ssteve.reinhardt@amd.com d[param] = str(self._values[param]) 9558669Ssaidi@eecs.umich.edu 9568848Ssteve.reinhardt@amd.com except AttributeError: 9578848Ssteve.reinhardt@amd.com pass 9588664SAli.Saidi@ARM.com 9598664SAli.Saidi@ARM.com for n in sorted(self._children.keys()): 9609017Sandreas.hansson@arm.com child = self._children[n] 9619017Sandreas.hansson@arm.com # Use the name of the attribute (and not get_name()) as 9629017Sandreas.hansson@arm.com # the key in the JSON dictionary to capture the hierarchy 9639017Sandreas.hansson@arm.com # in the Python code that assembled this system 9649017Sandreas.hansson@arm.com d[n] = child.get_config_as_dict() 9658664SAli.Saidi@ARM.com 9668664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 9678664SAli.Saidi@ARM.com port = self._port_refs.get(port_name, None) 9688664SAli.Saidi@ARM.com if port != None: 9699017Sandreas.hansson@arm.com # Represent each port with a dictionary containing the 9709017Sandreas.hansson@arm.com # prominent attributes 9719017Sandreas.hansson@arm.com d[port_name] = port.get_config_as_dict() 9728664SAli.Saidi@ARM.com 9738664SAli.Saidi@ARM.com return d 9748664SAli.Saidi@ARM.com 9754762Snate@binkert.org def getCCParams(self): 9764762Snate@binkert.org if self._ccParams: 9774762Snate@binkert.org return self._ccParams 9784762Snate@binkert.org 9797677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 9804762Snate@binkert.org cc_params = cc_params_struct() 9815488Snate@binkert.org cc_params.pyobj = self 9824762Snate@binkert.org cc_params.name = str(self) 9834762Snate@binkert.org 9844762Snate@binkert.org param_names = self._params.keys() 9854762Snate@binkert.org param_names.sort() 9864762Snate@binkert.org for param in param_names: 9874762Snate@binkert.org value = self._values.get(param) 9884762Snate@binkert.org if value is None: 9896654Snate@binkert.org fatal("%s.%s without default or user set value", 9906654Snate@binkert.org self.path(), param) 9914762Snate@binkert.org 9924762Snate@binkert.org value = value.getValue() 9934762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 9944762Snate@binkert.org assert isinstance(value, list) 9954762Snate@binkert.org vec = getattr(cc_params, param) 9964762Snate@binkert.org assert not len(vec) 9974762Snate@binkert.org for v in value: 9984762Snate@binkert.org vec.append(v) 9994762Snate@binkert.org else: 10004762Snate@binkert.org setattr(cc_params, param, value) 10014762Snate@binkert.org 10024762Snate@binkert.org port_names = self._ports.keys() 10034762Snate@binkert.org port_names.sort() 10044762Snate@binkert.org for port_name in port_names: 10054762Snate@binkert.org port = self._port_refs.get(port_name, None) 10068912Sandreas.hansson@arm.com if port != None: 10078912Sandreas.hansson@arm.com port_count = len(port) 10088912Sandreas.hansson@arm.com else: 10098912Sandreas.hansson@arm.com port_count = 0 10108900Sandreas.hansson@arm.com setattr(cc_params, 'port_' + port_name + '_connection_count', 10118912Sandreas.hansson@arm.com port_count) 10124762Snate@binkert.org self._ccParams = cc_params 10134762Snate@binkert.org return self._ccParams 10142738SN/A 10152740SN/A # Get C++ object corresponding to this object, calling C++ if 10162740SN/A # necessary to construct it. Does *not* recursively create 10172740SN/A # children. 10182740SN/A def getCCObject(self): 10192740SN/A if not self._ccObject: 10207526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 10217526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 10227526Ssteve.reinhardt@amd.com raise RuntimeError, "Attempt to instantiate orphan node" 10237526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 10245244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 10255244Sgblack@eecs.umich.edu self._ccObject = -1 10265244Sgblack@eecs.umich.edu params = self.getCCParams() 10274762Snate@binkert.org self._ccObject = params.create() 10282740SN/A elif self._ccObject == -1: 10297526Ssteve.reinhardt@amd.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 10302740SN/A % self.path() 10312740SN/A return self._ccObject 10322740SN/A 10337527Ssteve.reinhardt@amd.com def descendants(self): 10347527Ssteve.reinhardt@amd.com yield self 10357527Ssteve.reinhardt@amd.com for child in self._children.itervalues(): 10367527Ssteve.reinhardt@amd.com for obj in child.descendants(): 10377527Ssteve.reinhardt@amd.com yield obj 10387527Ssteve.reinhardt@amd.com 10397527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 10404762Snate@binkert.org def createCCObject(self): 10414762Snate@binkert.org self.getCCParams() 10424762Snate@binkert.org self.getCCObject() # force creation 10434762Snate@binkert.org 10444762Snate@binkert.org def getValue(self): 10454762Snate@binkert.org return self.getCCObject() 10464762Snate@binkert.org 10472738SN/A # Create C++ port connections corresponding to the connections in 10487527Ssteve.reinhardt@amd.com # _port_refs 10492738SN/A def connectPorts(self): 10503105Sstever@eecs.umich.edu for portRef in self._port_refs.itervalues(): 10513105Sstever@eecs.umich.edu portRef.ccConnect() 10522797SN/A 10534553Sbinkertn@umich.edu def getMemoryMode(self): 10544553Sbinkertn@umich.edu if not isinstance(self, m5.objects.System): 10554553Sbinkertn@umich.edu return None 10564553Sbinkertn@umich.edu 10574859Snate@binkert.org return self._ccObject.getMemoryMode() 10584553Sbinkertn@umich.edu 10592797SN/A def changeTiming(self, mode): 10603202Shsul@eecs.umich.edu if isinstance(self, m5.objects.System): 10613202Shsul@eecs.umich.edu # i don't know if there's a better way to do this - calling 10623202Shsul@eecs.umich.edu # setMemoryMode directly from self._ccObject results in calling 10633202Shsul@eecs.umich.edu # SimObject::setMemoryMode, not the System::setMemoryMode 10644859Snate@binkert.org self._ccObject.setMemoryMode(mode) 10652797SN/A 10662797SN/A def takeOverFrom(self, old_cpu): 10674859Snate@binkert.org self._ccObject.takeOverFrom(old_cpu._ccObject) 10682797SN/A 10693101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 10703101Sstever@eecs.umich.edudef resolveSimObject(name): 10713101Sstever@eecs.umich.edu obj = instanceDict[name] 10723101Sstever@eecs.umich.edu return obj.getCCObject() 1073679SN/A 10746654Snate@binkert.orgdef isSimObject(value): 10756654Snate@binkert.org return isinstance(value, SimObject) 10766654Snate@binkert.org 10776654Snate@binkert.orgdef isSimObjectClass(value): 10786654Snate@binkert.org return issubclass(value, SimObject) 10796654Snate@binkert.org 10807528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 10817528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 10827528Ssteve.reinhardt@amd.com 10836654Snate@binkert.orgdef isSimObjectSequence(value): 10846654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 10856654Snate@binkert.org return False 10866654Snate@binkert.org 10876654Snate@binkert.org for val in value: 10886654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 10896654Snate@binkert.org return False 10906654Snate@binkert.org 10916654Snate@binkert.org return True 10926654Snate@binkert.org 10936654Snate@binkert.orgdef isSimObjectOrSequence(value): 10946654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 10956654Snate@binkert.org 10967526Ssteve.reinhardt@amd.comdef isRoot(obj): 10977526Ssteve.reinhardt@amd.com from m5.objects import Root 10987526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 10997526Ssteve.reinhardt@amd.com 11007528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 11017528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 11027528Ssteve.reinhardt@amd.com 11037528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 11047528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 11057528Ssteve.reinhardt@amd.com return value 11067528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 11077528Ssteve.reinhardt@amd.com return SimObjectVector(value) 11087528Ssteve.reinhardt@amd.com return None 11097528Ssteve.reinhardt@amd.com 11107528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 11117528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 11127528Ssteve.reinhardt@amd.com if value is None: 11137528Ssteve.reinhardt@amd.com raise TypeError, "SimObject or SimObjectVector expected" 11147528Ssteve.reinhardt@amd.com return value 11157528Ssteve.reinhardt@amd.com 11166654Snate@binkert.orgbaseClasses = allClasses.copy() 11176654Snate@binkert.orgbaseInstances = instanceDict.copy() 11186654Snate@binkert.org 11196654Snate@binkert.orgdef clear(): 11206654Snate@binkert.org global allClasses, instanceDict 11216654Snate@binkert.org 11226654Snate@binkert.org allClasses = baseClasses.copy() 11236654Snate@binkert.org instanceDict = baseInstances.copy() 11246654Snate@binkert.org 11251528SN/A# __all__ defines the list of symbols that get exported when 11261528SN/A# 'from config import *' is invoked. Try to keep this reasonably 11271528SN/A# short to avoid polluting other namespaces. 11284762Snate@binkert.org__all__ = [ 'SimObject' ] 1129