SimObject.py revision 9953
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 1089338SAndreas.Sandberg@arm.com# Did any of the SimObjects lack a header file? 1099338SAndreas.Sandberg@arm.comnoCxxHeader = False 1109338SAndreas.Sandberg@arm.com 1117673Snate@binkert.orgdef public_value(key, value): 1127673Snate@binkert.org return key.startswith('_') or \ 1138331Ssteve.reinhardt@amd.com isinstance(value, (FunctionType, MethodType, ModuleType, 1148331Ssteve.reinhardt@amd.com classmethod, type)) 1157673Snate@binkert.org 1162740SN/A# The metaclass for SimObject. This class controls how new classes 1172740SN/A# that derive from SimObject are instantiated, and provides inherited 1182740SN/A# class behavior (just like a class controls how instances of that 1192740SN/A# class are instantiated, and provides inherited instance behavior). 1201692SN/Aclass MetaSimObject(type): 1211427SN/A # Attributes that can be set only at initialization time 1227493Ssteve.reinhardt@amd.com init_keywords = { 'abstract' : bool, 1237493Ssteve.reinhardt@amd.com 'cxx_class' : str, 1247493Ssteve.reinhardt@amd.com 'cxx_type' : str, 1259338SAndreas.Sandberg@arm.com 'cxx_header' : str, 1269342SAndreas.Sandberg@arm.com 'type' : str, 1279342SAndreas.Sandberg@arm.com 'cxx_bases' : list } 1281427SN/A # Attributes that can be set any time 1297493Ssteve.reinhardt@amd.com keywords = { 'check' : FunctionType } 130679SN/A 131679SN/A # __new__ is called before __init__, and is where the statements 132679SN/A # in the body of the class definition get loaded into the class's 1332740SN/A # __dict__. We intercept this to filter out parameter & port assignments 134679SN/A # and only allow "private" attributes to be passed to the base 135679SN/A # __new__ (starting with underscore). 1361310SN/A def __new__(mcls, name, bases, dict): 1376654Snate@binkert.org assert name not in allClasses, "SimObject %s already present" % name 1384762Snate@binkert.org 1392740SN/A # Copy "private" attributes, functions, and classes to the 1402740SN/A # official dict. Everything else goes in _init_dict to be 1412740SN/A # filtered in __init__. 1422740SN/A cls_dict = {} 1432740SN/A value_dict = {} 1442740SN/A for key,val in dict.items(): 1457673Snate@binkert.org if public_value(key, val): 1462740SN/A cls_dict[key] = val 1472740SN/A else: 1482740SN/A # must be a param/port setting 1492740SN/A value_dict[key] = val 1504762Snate@binkert.org if 'abstract' not in value_dict: 1514762Snate@binkert.org value_dict['abstract'] = False 1529342SAndreas.Sandberg@arm.com if 'cxx_bases' not in value_dict: 1539342SAndreas.Sandberg@arm.com value_dict['cxx_bases'] = [] 1542740SN/A cls_dict['_value_dict'] = value_dict 1554762Snate@binkert.org cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict) 1564762Snate@binkert.org if 'type' in value_dict: 1574762Snate@binkert.org allClasses[name] = cls 1584762Snate@binkert.org return cls 159679SN/A 1602711SN/A # subclass initialization 161679SN/A def __init__(cls, name, bases, dict): 1622711SN/A # calls type.__init__()... I think that's a no-op, but leave 1632711SN/A # it here just in case it's not. 1641692SN/A super(MetaSimObject, cls).__init__(name, bases, dict) 1651310SN/A 1661427SN/A # initialize required attributes 1672740SN/A 1682740SN/A # class-only attributes 1692740SN/A cls._params = multidict() # param descriptions 1702740SN/A cls._ports = multidict() # port descriptions 1712740SN/A 1722740SN/A # class or instance attributes 1732740SN/A cls._values = multidict() # param values 1747528Ssteve.reinhardt@amd.com cls._children = multidict() # SimObject children 1753105Sstever@eecs.umich.edu cls._port_refs = multidict() # port ref objects 1762740SN/A cls._instantiated = False # really instantiated, cloned, or subclassed 1771310SN/A 1789100SBrad.Beckmann@amd.com # We don't support multiple inheritance of sim objects. If you want 1799100SBrad.Beckmann@amd.com # to, you must fix multidict to deal with it properly. Non sim-objects 1809100SBrad.Beckmann@amd.com # are ok, though 1819100SBrad.Beckmann@amd.com bTotal = 0 1829100SBrad.Beckmann@amd.com for c in bases: 1839100SBrad.Beckmann@amd.com if isinstance(c, MetaSimObject): 1849100SBrad.Beckmann@amd.com bTotal += 1 1859100SBrad.Beckmann@amd.com if bTotal > 1: 1869100SBrad.Beckmann@amd.com raise TypeError, "SimObjects do not support multiple inheritance" 1871692SN/A 1881692SN/A base = bases[0] 1891692SN/A 1902740SN/A # Set up general inheritance via multidicts. A subclass will 1912740SN/A # inherit all its settings from the base class. The only time 1922740SN/A # the following is not true is when we define the SimObject 1932740SN/A # class itself (in which case the multidicts have no parent). 1941692SN/A if isinstance(base, MetaSimObject): 1955610Snate@binkert.org cls._base = base 1961692SN/A cls._params.parent = base._params 1972740SN/A cls._ports.parent = base._ports 1981692SN/A cls._values.parent = base._values 1997528Ssteve.reinhardt@amd.com cls._children.parent = base._children 2003105Sstever@eecs.umich.edu cls._port_refs.parent = base._port_refs 2012740SN/A # mark base as having been subclassed 2022712SN/A base._instantiated = True 2035610Snate@binkert.org else: 2045610Snate@binkert.org cls._base = None 2051692SN/A 2064762Snate@binkert.org # default keyword values 2074762Snate@binkert.org if 'type' in cls._value_dict: 2084762Snate@binkert.org if 'cxx_class' not in cls._value_dict: 2095610Snate@binkert.org cls._value_dict['cxx_class'] = cls._value_dict['type'] 2104762Snate@binkert.org 2115610Snate@binkert.org cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class'] 2124859Snate@binkert.org 2139338SAndreas.Sandberg@arm.com if 'cxx_header' not in cls._value_dict: 2149338SAndreas.Sandberg@arm.com global noCxxHeader 2159338SAndreas.Sandberg@arm.com noCxxHeader = True 2169528Ssascha.bischoff@arm.com warn("No header file specified for SimObject: %s", name) 2179338SAndreas.Sandberg@arm.com 2188597Ssteve.reinhardt@amd.com # Export methods are automatically inherited via C++, so we 2198597Ssteve.reinhardt@amd.com # don't want the method declarations to get inherited on the 2208597Ssteve.reinhardt@amd.com # python side (and thus end up getting repeated in the wrapped 2218597Ssteve.reinhardt@amd.com # versions of derived classes). The code below basicallly 2228597Ssteve.reinhardt@amd.com # suppresses inheritance by substituting in the base (null) 2238597Ssteve.reinhardt@amd.com # versions of these methods unless a different version is 2248597Ssteve.reinhardt@amd.com # explicitly supplied. 2258597Ssteve.reinhardt@amd.com for method_name in ('export_methods', 'export_method_cxx_predecls', 2268597Ssteve.reinhardt@amd.com 'export_method_swig_predecls'): 2278597Ssteve.reinhardt@amd.com if method_name not in cls.__dict__: 2288597Ssteve.reinhardt@amd.com base_method = getattr(MetaSimObject, method_name) 2298597Ssteve.reinhardt@amd.com m = MethodType(base_method, cls, MetaSimObject) 2308597Ssteve.reinhardt@amd.com setattr(cls, method_name, m) 2318597Ssteve.reinhardt@amd.com 2322740SN/A # Now process the _value_dict items. They could be defining 2332740SN/A # new (or overriding existing) parameters or ports, setting 2342740SN/A # class keywords (e.g., 'abstract'), or setting parameter 2352740SN/A # values or port bindings. The first 3 can only be set when 2362740SN/A # the class is defined, so we handle them here. The others 2372740SN/A # can be set later too, so just emulate that by calling 2382740SN/A # setattr(). 2392740SN/A for key,val in cls._value_dict.items(): 2401527SN/A # param descriptions 2412740SN/A if isinstance(val, ParamDesc): 2421585SN/A cls._new_param(key, val) 2431427SN/A 2442738SN/A # port objects 2452738SN/A elif isinstance(val, Port): 2463105Sstever@eecs.umich.edu cls._new_port(key, val) 2472738SN/A 2481427SN/A # init-time-only keywords 2491427SN/A elif cls.init_keywords.has_key(key): 2501427SN/A cls._set_keyword(key, val, cls.init_keywords[key]) 2511427SN/A 2521427SN/A # default: use normal path (ends up in __setattr__) 2531427SN/A else: 2541427SN/A setattr(cls, key, val) 2551427SN/A 2561427SN/A def _set_keyword(cls, keyword, val, kwtype): 2571427SN/A if not isinstance(val, kwtype): 2581427SN/A raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \ 2591427SN/A (keyword, type(val), kwtype) 2607493Ssteve.reinhardt@amd.com if isinstance(val, FunctionType): 2611427SN/A val = classmethod(val) 2621427SN/A type.__setattr__(cls, keyword, val) 2631427SN/A 2643100SN/A def _new_param(cls, name, pdesc): 2653100SN/A # each param desc should be uniquely assigned to one variable 2663100SN/A assert(not hasattr(pdesc, 'name')) 2673100SN/A pdesc.name = name 2683100SN/A cls._params[name] = pdesc 2693100SN/A if hasattr(pdesc, 'default'): 2703105Sstever@eecs.umich.edu cls._set_param(name, pdesc.default, pdesc) 2713105Sstever@eecs.umich.edu 2723105Sstever@eecs.umich.edu def _set_param(cls, name, value, param): 2733105Sstever@eecs.umich.edu assert(param.name == name) 2743105Sstever@eecs.umich.edu try: 2758321Ssteve.reinhardt@amd.com value = param.convert(value) 2763105Sstever@eecs.umich.edu except Exception, e: 2773105Sstever@eecs.umich.edu msg = "%s\nError setting param %s.%s to %s\n" % \ 2783105Sstever@eecs.umich.edu (e, cls.__name__, name, value) 2793105Sstever@eecs.umich.edu e.args = (msg, ) 2803105Sstever@eecs.umich.edu raise 2818321Ssteve.reinhardt@amd.com cls._values[name] = value 2828321Ssteve.reinhardt@amd.com # if param value is a SimObject, make it a child too, so that 2838321Ssteve.reinhardt@amd.com # it gets cloned properly when the class is instantiated 2848321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 2858321Ssteve.reinhardt@amd.com cls._add_cls_child(name, value) 2868321Ssteve.reinhardt@amd.com 2878321Ssteve.reinhardt@amd.com def _add_cls_child(cls, name, child): 2888321Ssteve.reinhardt@amd.com # It's a little funky to have a class as a parent, but these 2898321Ssteve.reinhardt@amd.com # objects should never be instantiated (only cloned, which 2908321Ssteve.reinhardt@amd.com # clears the parent pointer), and this makes it clear that the 2918321Ssteve.reinhardt@amd.com # object is not an orphan and can provide better error 2928321Ssteve.reinhardt@amd.com # messages. 2938321Ssteve.reinhardt@amd.com child.set_parent(cls, name) 2948321Ssteve.reinhardt@amd.com cls._children[name] = child 2953105Sstever@eecs.umich.edu 2963105Sstever@eecs.umich.edu def _new_port(cls, name, port): 2973105Sstever@eecs.umich.edu # each port should be uniquely assigned to one variable 2983105Sstever@eecs.umich.edu assert(not hasattr(port, 'name')) 2993105Sstever@eecs.umich.edu port.name = name 3003105Sstever@eecs.umich.edu cls._ports[name] = port 3013105Sstever@eecs.umich.edu 3023105Sstever@eecs.umich.edu # same as _get_port_ref, effectively, but for classes 3033105Sstever@eecs.umich.edu def _cls_get_port_ref(cls, attr): 3043105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 3053105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 3063105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 3073105Sstever@eecs.umich.edu ref = cls._port_refs.get(attr) 3083105Sstever@eecs.umich.edu if not ref: 3093105Sstever@eecs.umich.edu ref = cls._ports[attr].makeRef(cls) 3103105Sstever@eecs.umich.edu cls._port_refs[attr] = ref 3113105Sstever@eecs.umich.edu return ref 3121585SN/A 3131310SN/A # Set attribute (called on foo.attr = value when foo is an 3141310SN/A # instance of class cls). 3151310SN/A def __setattr__(cls, attr, value): 3161310SN/A # normal processing for private attributes 3177673Snate@binkert.org if public_value(attr, value): 3181310SN/A type.__setattr__(cls, attr, value) 3191310SN/A return 3201310SN/A 3211310SN/A if cls.keywords.has_key(attr): 3221427SN/A cls._set_keyword(attr, value, cls.keywords[attr]) 3231310SN/A return 3241310SN/A 3252738SN/A if cls._ports.has_key(attr): 3263105Sstever@eecs.umich.edu cls._cls_get_port_ref(attr).connect(value) 3272738SN/A return 3282738SN/A 3292740SN/A if isSimObjectOrSequence(value) and cls._instantiated: 3302740SN/A raise RuntimeError, \ 3312740SN/A "cannot set SimObject parameter '%s' after\n" \ 3322740SN/A " class %s has been instantiated or subclassed" \ 3332740SN/A % (attr, cls.__name__) 3342740SN/A 3352740SN/A # check for param 3363105Sstever@eecs.umich.edu param = cls._params.get(attr) 3371310SN/A if param: 3383105Sstever@eecs.umich.edu cls._set_param(attr, value, param) 3393105Sstever@eecs.umich.edu return 3403105Sstever@eecs.umich.edu 3413105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 3423105Sstever@eecs.umich.edu # If RHS is a SimObject, it's an implicit child assignment. 3438321Ssteve.reinhardt@amd.com cls._add_cls_child(attr, coerceSimObjectOrVector(value)) 3443105Sstever@eecs.umich.edu return 3453105Sstever@eecs.umich.edu 3463105Sstever@eecs.umich.edu # no valid assignment... raise exception 3473105Sstever@eecs.umich.edu raise AttributeError, \ 3483105Sstever@eecs.umich.edu "Class %s has no parameter \'%s\'" % (cls.__name__, attr) 3491310SN/A 3501585SN/A def __getattr__(cls, attr): 3517675Snate@binkert.org if attr == 'cxx_class_path': 3527675Snate@binkert.org return cls.cxx_class.split('::') 3537675Snate@binkert.org 3547675Snate@binkert.org if attr == 'cxx_class_name': 3557675Snate@binkert.org return cls.cxx_class_path[-1] 3567675Snate@binkert.org 3577675Snate@binkert.org if attr == 'cxx_namespaces': 3587675Snate@binkert.org return cls.cxx_class_path[:-1] 3597675Snate@binkert.org 3601692SN/A if cls._values.has_key(attr): 3611692SN/A return cls._values[attr] 3621585SN/A 3637528Ssteve.reinhardt@amd.com if cls._children.has_key(attr): 3647528Ssteve.reinhardt@amd.com return cls._children[attr] 3657528Ssteve.reinhardt@amd.com 3661585SN/A raise AttributeError, \ 3671585SN/A "object '%s' has no attribute '%s'" % (cls.__name__, attr) 3681585SN/A 3693100SN/A def __str__(cls): 3703100SN/A return cls.__name__ 3713100SN/A 3728596Ssteve.reinhardt@amd.com # See ParamValue.cxx_predecls for description. 3738596Ssteve.reinhardt@amd.com def cxx_predecls(cls, code): 3748596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 3758596Ssteve.reinhardt@amd.com 3768596Ssteve.reinhardt@amd.com # See ParamValue.swig_predecls for description. 3778596Ssteve.reinhardt@amd.com def swig_predecls(cls, code): 3788596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_$cls.i"') 3798596Ssteve.reinhardt@amd.com 3808597Ssteve.reinhardt@amd.com # Hook for exporting additional C++ methods to Python via SWIG. 3818597Ssteve.reinhardt@amd.com # Default is none, override using @classmethod in class definition. 3828597Ssteve.reinhardt@amd.com def export_methods(cls, code): 3838597Ssteve.reinhardt@amd.com pass 3848597Ssteve.reinhardt@amd.com 3858597Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 3868597Ssteve.reinhardt@amd.com # exported via export_methods() to be compiled in the _wrap.cc 3878597Ssteve.reinhardt@amd.com # file. Typically generates one or more #include statements. If 3888597Ssteve.reinhardt@amd.com # any methods are exported, typically at least the C++ header 3898597Ssteve.reinhardt@amd.com # declaring the relevant SimObject class must be included. 3908597Ssteve.reinhardt@amd.com def export_method_cxx_predecls(cls, code): 3918597Ssteve.reinhardt@amd.com pass 3928597Ssteve.reinhardt@amd.com 3938597Ssteve.reinhardt@amd.com # Generate the code needed as a prerequisite for the C++ methods 3948597Ssteve.reinhardt@amd.com # exported via export_methods() to be processed by SWIG. 3958597Ssteve.reinhardt@amd.com # Typically generates one or more %include or %import statements. 3968597Ssteve.reinhardt@amd.com # If any methods are exported, typically at least the C++ header 3978597Ssteve.reinhardt@amd.com # declaring the relevant SimObject class must be included. 3988597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 3998597Ssteve.reinhardt@amd.com pass 4008597Ssteve.reinhardt@amd.com 4018596Ssteve.reinhardt@amd.com # Generate the declaration for this object for wrapping with SWIG. 4028596Ssteve.reinhardt@amd.com # Generates code that goes into a SWIG .i file. Called from 4038596Ssteve.reinhardt@amd.com # src/SConscript. 4048596Ssteve.reinhardt@amd.com def swig_decl(cls, code): 4058596Ssteve.reinhardt@amd.com class_path = cls.cxx_class.split('::') 4068596Ssteve.reinhardt@amd.com classname = class_path[-1] 4078596Ssteve.reinhardt@amd.com namespaces = class_path[:-1] 4088596Ssteve.reinhardt@amd.com 4098596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 4108596Ssteve.reinhardt@amd.com # the object itself, not including inherited params (which 4118596Ssteve.reinhardt@amd.com # will also be inherited from the base class's param struct 4128596Ssteve.reinhardt@amd.com # here). 4138596Ssteve.reinhardt@amd.com params = cls._params.local.values() 4148840Sandreas.hansson@arm.com ports = cls._ports.local 4158596Ssteve.reinhardt@amd.com 4168596Ssteve.reinhardt@amd.com code('%module(package="m5.internal") param_$cls') 4178596Ssteve.reinhardt@amd.com code() 4188596Ssteve.reinhardt@amd.com code('%{') 4199342SAndreas.Sandberg@arm.com code('#include "sim/sim_object.hh"') 4208596Ssteve.reinhardt@amd.com code('#include "params/$cls.hh"') 4218596Ssteve.reinhardt@amd.com for param in params: 4228596Ssteve.reinhardt@amd.com param.cxx_predecls(code) 4239338SAndreas.Sandberg@arm.com code('#include "${{cls.cxx_header}}"') 4248597Ssteve.reinhardt@amd.com cls.export_method_cxx_predecls(code) 4258860Sandreas.hansson@arm.com code('''\ 4268860Sandreas.hansson@arm.com/** 4278860Sandreas.hansson@arm.com * This is a workaround for bug in swig. Prior to gcc 4.6.1 the STL 4288860Sandreas.hansson@arm.com * headers like vector, string, etc. used to automatically pull in 4298860Sandreas.hansson@arm.com * the cstddef header but starting with gcc 4.6.1 they no longer do. 4308860Sandreas.hansson@arm.com * This leads to swig generated a file that does not compile so we 4318860Sandreas.hansson@arm.com * explicitly include cstddef. Additionally, including version 2.0.4, 4328860Sandreas.hansson@arm.com * swig uses ptrdiff_t without the std:: namespace prefix which is 4338860Sandreas.hansson@arm.com * required with gcc 4.6.1. We explicitly provide access to it. 4348860Sandreas.hansson@arm.com */ 4358860Sandreas.hansson@arm.com#include <cstddef> 4368860Sandreas.hansson@arm.comusing std::ptrdiff_t; 4378860Sandreas.hansson@arm.com''') 4388596Ssteve.reinhardt@amd.com code('%}') 4398596Ssteve.reinhardt@amd.com code() 4408596Ssteve.reinhardt@amd.com 4418596Ssteve.reinhardt@amd.com for param in params: 4428596Ssteve.reinhardt@amd.com param.swig_predecls(code) 4438597Ssteve.reinhardt@amd.com cls.export_method_swig_predecls(code) 4448596Ssteve.reinhardt@amd.com 4458596Ssteve.reinhardt@amd.com code() 4468596Ssteve.reinhardt@amd.com if cls._base: 4478596Ssteve.reinhardt@amd.com code('%import "python/m5/internal/param_${{cls._base}}.i"') 4488596Ssteve.reinhardt@amd.com code() 4498596Ssteve.reinhardt@amd.com 4508596Ssteve.reinhardt@amd.com for ns in namespaces: 4518596Ssteve.reinhardt@amd.com code('namespace $ns {') 4528596Ssteve.reinhardt@amd.com 4538596Ssteve.reinhardt@amd.com if namespaces: 4548596Ssteve.reinhardt@amd.com code('// avoid name conflicts') 4558596Ssteve.reinhardt@amd.com sep_string = '_COLONS_' 4568596Ssteve.reinhardt@amd.com flat_name = sep_string.join(class_path) 4578596Ssteve.reinhardt@amd.com code('%rename($flat_name) $classname;') 4588596Ssteve.reinhardt@amd.com 4598597Ssteve.reinhardt@amd.com code() 4608597Ssteve.reinhardt@amd.com code('// stop swig from creating/wrapping default ctor/dtor') 4618597Ssteve.reinhardt@amd.com code('%nodefault $classname;') 4628597Ssteve.reinhardt@amd.com code('class $classname') 4638597Ssteve.reinhardt@amd.com if cls._base: 4649342SAndreas.Sandberg@arm.com bases = [ cls._base.cxx_class ] + cls.cxx_bases 4659342SAndreas.Sandberg@arm.com else: 4669342SAndreas.Sandberg@arm.com bases = cls.cxx_bases 4679342SAndreas.Sandberg@arm.com base_first = True 4689342SAndreas.Sandberg@arm.com for base in bases: 4699342SAndreas.Sandberg@arm.com if base_first: 4709342SAndreas.Sandberg@arm.com code(' : public ${{base}}') 4719342SAndreas.Sandberg@arm.com base_first = False 4729342SAndreas.Sandberg@arm.com else: 4739342SAndreas.Sandberg@arm.com code(' , public ${{base}}') 4749342SAndreas.Sandberg@arm.com 4758597Ssteve.reinhardt@amd.com code('{') 4768597Ssteve.reinhardt@amd.com code(' public:') 4778597Ssteve.reinhardt@amd.com cls.export_methods(code) 4788597Ssteve.reinhardt@amd.com code('};') 4798596Ssteve.reinhardt@amd.com 4808596Ssteve.reinhardt@amd.com for ns in reversed(namespaces): 4818596Ssteve.reinhardt@amd.com code('} // namespace $ns') 4828596Ssteve.reinhardt@amd.com 4838596Ssteve.reinhardt@amd.com code() 4848596Ssteve.reinhardt@amd.com code('%include "params/$cls.hh"') 4858596Ssteve.reinhardt@amd.com 4868596Ssteve.reinhardt@amd.com 4878596Ssteve.reinhardt@amd.com # Generate the C++ declaration (.hh file) for this SimObject's 4888596Ssteve.reinhardt@amd.com # param struct. Called from src/SConscript. 4898596Ssteve.reinhardt@amd.com def cxx_param_decl(cls, code): 4908596Ssteve.reinhardt@amd.com # The 'local' attribute restricts us to the params declared in 4913100SN/A # the object itself, not including inherited params (which 4923100SN/A # will also be inherited from the base class's param struct 4933100SN/A # here). 4944762Snate@binkert.org params = cls._params.local.values() 4958840Sandreas.hansson@arm.com ports = cls._ports.local 4963100SN/A try: 4973100SN/A ptypes = [p.ptype for p in params] 4983100SN/A except: 4993100SN/A print cls, p, p.ptype_str 5003100SN/A print params 5013100SN/A raise 5023100SN/A 5037675Snate@binkert.org class_path = cls._value_dict['cxx_class'].split('::') 5047675Snate@binkert.org 5057675Snate@binkert.org code('''\ 5067675Snate@binkert.org#ifndef __PARAMS__${cls}__ 5077675Snate@binkert.org#define __PARAMS__${cls}__ 5087675Snate@binkert.org 5097675Snate@binkert.org''') 5107675Snate@binkert.org 5117675Snate@binkert.org # A forward class declaration is sufficient since we are just 5127675Snate@binkert.org # declaring a pointer. 5137675Snate@binkert.org for ns in class_path[:-1]: 5147675Snate@binkert.org code('namespace $ns {') 5157675Snate@binkert.org code('class $0;', class_path[-1]) 5167675Snate@binkert.org for ns in reversed(class_path[:-1]): 5177811Ssteve.reinhardt@amd.com code('} // namespace $ns') 5187675Snate@binkert.org code() 5197675Snate@binkert.org 5208597Ssteve.reinhardt@amd.com # The base SimObject has a couple of params that get 5218597Ssteve.reinhardt@amd.com # automatically set from Python without being declared through 5228597Ssteve.reinhardt@amd.com # the normal Param mechanism; we slip them in here (needed 5238597Ssteve.reinhardt@amd.com # predecls now, actual declarations below) 5248597Ssteve.reinhardt@amd.com if cls == SimObject: 5258597Ssteve.reinhardt@amd.com code(''' 5268597Ssteve.reinhardt@amd.com#ifndef PY_VERSION 5278597Ssteve.reinhardt@amd.comstruct PyObject; 5288597Ssteve.reinhardt@amd.com#endif 5298597Ssteve.reinhardt@amd.com 5308597Ssteve.reinhardt@amd.com#include <string> 5318597Ssteve.reinhardt@amd.com 5328737Skoansin.tan@gmail.comclass EventQueue; 5338597Ssteve.reinhardt@amd.com''') 5347673Snate@binkert.org for param in params: 5357673Snate@binkert.org param.cxx_predecls(code) 5368840Sandreas.hansson@arm.com for port in ports.itervalues(): 5378840Sandreas.hansson@arm.com port.cxx_predecls(code) 5387673Snate@binkert.org code() 5394762Snate@binkert.org 5405610Snate@binkert.org if cls._base: 5417673Snate@binkert.org code('#include "params/${{cls._base.type}}.hh"') 5427673Snate@binkert.org code() 5434762Snate@binkert.org 5444762Snate@binkert.org for ptype in ptypes: 5454762Snate@binkert.org if issubclass(ptype, Enum): 5467673Snate@binkert.org code('#include "enums/${{ptype.__name__}}.hh"') 5477673Snate@binkert.org code() 5484762Snate@binkert.org 5498596Ssteve.reinhardt@amd.com # now generate the actual param struct 5508597Ssteve.reinhardt@amd.com code("struct ${cls}Params") 5518597Ssteve.reinhardt@amd.com if cls._base: 5528597Ssteve.reinhardt@amd.com code(" : public ${{cls._base.type}}Params") 5538597Ssteve.reinhardt@amd.com code("{") 5548597Ssteve.reinhardt@amd.com if not hasattr(cls, 'abstract') or not cls.abstract: 5558597Ssteve.reinhardt@amd.com if 'type' in cls.__dict__: 5568597Ssteve.reinhardt@amd.com code(" ${{cls.cxx_type}} create();") 5578597Ssteve.reinhardt@amd.com 5588597Ssteve.reinhardt@amd.com code.indent() 5598596Ssteve.reinhardt@amd.com if cls == SimObject: 5608597Ssteve.reinhardt@amd.com code(''' 5618597Ssteve.reinhardt@amd.com SimObjectParams() 5628597Ssteve.reinhardt@amd.com { 5638597Ssteve.reinhardt@amd.com extern EventQueue mainEventQueue; 5648597Ssteve.reinhardt@amd.com eventq = &mainEventQueue; 5658597Ssteve.reinhardt@amd.com } 5668597Ssteve.reinhardt@amd.com virtual ~SimObjectParams() {} 5678596Ssteve.reinhardt@amd.com 5688597Ssteve.reinhardt@amd.com std::string name; 5698597Ssteve.reinhardt@amd.com PyObject *pyobj; 5708597Ssteve.reinhardt@amd.com EventQueue *eventq; 5718597Ssteve.reinhardt@amd.com ''') 5728597Ssteve.reinhardt@amd.com for param in params: 5738597Ssteve.reinhardt@amd.com param.cxx_decl(code) 5748840Sandreas.hansson@arm.com for port in ports.itervalues(): 5758840Sandreas.hansson@arm.com port.cxx_decl(code) 5768840Sandreas.hansson@arm.com 5778597Ssteve.reinhardt@amd.com code.dedent() 5788597Ssteve.reinhardt@amd.com code('};') 5795488Snate@binkert.org 5807673Snate@binkert.org code() 5817673Snate@binkert.org code('#endif // __PARAMS__${cls}__') 5825488Snate@binkert.org return code 5835488Snate@binkert.org 5845488Snate@binkert.org 5853100SN/A 5862740SN/A# The SimObject class is the root of the special hierarchy. Most of 587679SN/A# the code in this class deals with the configuration hierarchy itself 588679SN/A# (parent/child node relationships). 5891692SN/Aclass SimObject(object): 5901692SN/A # Specify metaclass. Any class inheriting from SimObject will 591679SN/A # get this metaclass. 5921692SN/A __metaclass__ = MetaSimObject 5933100SN/A type = 'SimObject' 5944762Snate@binkert.org abstract = True 5959338SAndreas.Sandberg@arm.com cxx_header = "sim/sim_object.hh" 5968597Ssteve.reinhardt@amd.com 5979345SAndreas.Sandberg@ARM.com cxx_bases = [ "Drainable", "Serializable" ] 5989342SAndreas.Sandberg@arm.com 5998597Ssteve.reinhardt@amd.com @classmethod 6008597Ssteve.reinhardt@amd.com def export_method_swig_predecls(cls, code): 6018597Ssteve.reinhardt@amd.com code(''' 6028597Ssteve.reinhardt@amd.com%include <std_string.i> 6039342SAndreas.Sandberg@arm.com 6049342SAndreas.Sandberg@arm.com%import "python/swig/drain.i" 6059345SAndreas.Sandberg@ARM.com%import "python/swig/serialize.i" 6068597Ssteve.reinhardt@amd.com''') 6078597Ssteve.reinhardt@amd.com 6088597Ssteve.reinhardt@amd.com @classmethod 6098597Ssteve.reinhardt@amd.com def export_methods(cls, code): 6108597Ssteve.reinhardt@amd.com code(''' 6118597Ssteve.reinhardt@amd.com void init(); 6128597Ssteve.reinhardt@amd.com void loadState(Checkpoint *cp); 6138597Ssteve.reinhardt@amd.com void initState(); 6148597Ssteve.reinhardt@amd.com void regStats(); 6158597Ssteve.reinhardt@amd.com void resetStats(); 6168597Ssteve.reinhardt@amd.com void startup(); 6178597Ssteve.reinhardt@amd.com''') 6188597Ssteve.reinhardt@amd.com 6192740SN/A # Initialize new instance. For objects with SimObject-valued 6202740SN/A # children, we need to recursively clone the classes represented 6212740SN/A # by those param values as well in a consistent "deep copy"-style 6222740SN/A # fashion. That is, we want to make sure that each instance is 6232740SN/A # cloned only once, and that if there are multiple references to 6242740SN/A # the same original object, we end up with the corresponding 6252740SN/A # cloned references all pointing to the same cloned instance. 6262740SN/A def __init__(self, **kwargs): 6272740SN/A ancestor = kwargs.get('_ancestor') 6282740SN/A memo_dict = kwargs.get('_memo') 6292740SN/A if memo_dict is None: 6302740SN/A # prepare to memoize any recursively instantiated objects 6312740SN/A memo_dict = {} 6322740SN/A elif ancestor: 6332740SN/A # memoize me now to avoid problems with recursive calls 6342740SN/A memo_dict[ancestor] = self 6352711SN/A 6362740SN/A if not ancestor: 6372740SN/A ancestor = self.__class__ 6382740SN/A ancestor._instantiated = True 6392711SN/A 6402740SN/A # initialize required attributes 6412740SN/A self._parent = None 6427528Ssteve.reinhardt@amd.com self._name = None 6432740SN/A self._ccObject = None # pointer to C++ object 6444762Snate@binkert.org self._ccParams = None 6452740SN/A self._instantiated = False # really "cloned" 6462712SN/A 6478321Ssteve.reinhardt@amd.com # Clone children specified at class level. No need for a 6488321Ssteve.reinhardt@amd.com # multidict here since we will be cloning everything. 6498321Ssteve.reinhardt@amd.com # Do children before parameter values so that children that 6508321Ssteve.reinhardt@amd.com # are also param values get cloned properly. 6518321Ssteve.reinhardt@amd.com self._children = {} 6528321Ssteve.reinhardt@amd.com for key,val in ancestor._children.iteritems(): 6538321Ssteve.reinhardt@amd.com self.add_child(key, val(_memo=memo_dict)) 6548321Ssteve.reinhardt@amd.com 6552711SN/A # Inherit parameter values from class using multidict so 6567528Ssteve.reinhardt@amd.com # individual value settings can be overridden but we still 6577528Ssteve.reinhardt@amd.com # inherit late changes to non-overridden class values. 6582740SN/A self._values = multidict(ancestor._values) 6592740SN/A # clone SimObject-valued parameters 6602740SN/A for key,val in ancestor._values.iteritems(): 6617528Ssteve.reinhardt@amd.com val = tryAsSimObjectOrVector(val) 6627528Ssteve.reinhardt@amd.com if val is not None: 6637528Ssteve.reinhardt@amd.com self._values[key] = val(_memo=memo_dict) 6647528Ssteve.reinhardt@amd.com 6652740SN/A # clone port references. no need to use a multidict here 6662740SN/A # since we will be creating new references for all ports. 6673105Sstever@eecs.umich.edu self._port_refs = {} 6683105Sstever@eecs.umich.edu for key,val in ancestor._port_refs.iteritems(): 6693105Sstever@eecs.umich.edu self._port_refs[key] = val.clone(self, memo_dict) 6701692SN/A # apply attribute assignments from keyword args, if any 6711692SN/A for key,val in kwargs.iteritems(): 6721692SN/A setattr(self, key, val) 673679SN/A 6742740SN/A # "Clone" the current instance by creating another instance of 6752740SN/A # this instance's class, but that inherits its parameter values 6762740SN/A # and port mappings from the current instance. If we're in a 6772740SN/A # "deep copy" recursive clone, check the _memo dict to see if 6782740SN/A # we've already cloned this instance. 6791692SN/A def __call__(self, **kwargs): 6802740SN/A memo_dict = kwargs.get('_memo') 6812740SN/A if memo_dict is None: 6822740SN/A # no memo_dict: must be top-level clone operation. 6832740SN/A # this is only allowed at the root of a hierarchy 6842740SN/A if self._parent: 6852740SN/A raise RuntimeError, "attempt to clone object %s " \ 6862740SN/A "not at the root of a tree (parent = %s)" \ 6872740SN/A % (self, self._parent) 6882740SN/A # create a new dict and use that. 6892740SN/A memo_dict = {} 6902740SN/A kwargs['_memo'] = memo_dict 6912740SN/A elif memo_dict.has_key(self): 6922740SN/A # clone already done & memoized 6932740SN/A return memo_dict[self] 6942740SN/A return self.__class__(_ancestor = self, **kwargs) 6951343SN/A 6963105Sstever@eecs.umich.edu def _get_port_ref(self, attr): 6973105Sstever@eecs.umich.edu # Return reference that can be assigned to another port 6983105Sstever@eecs.umich.edu # via __setattr__. There is only ever one reference 6993105Sstever@eecs.umich.edu # object per port, but we create them lazily here. 7003105Sstever@eecs.umich.edu ref = self._port_refs.get(attr) 7019940SGeoffrey.Blake@arm.com if ref == None: 7023105Sstever@eecs.umich.edu ref = self._ports[attr].makeRef(self) 7033105Sstever@eecs.umich.edu self._port_refs[attr] = ref 7043105Sstever@eecs.umich.edu return ref 7053105Sstever@eecs.umich.edu 7061692SN/A def __getattr__(self, attr): 7072738SN/A if self._ports.has_key(attr): 7083105Sstever@eecs.umich.edu return self._get_port_ref(attr) 7092738SN/A 7101692SN/A if self._values.has_key(attr): 7111692SN/A return self._values[attr] 7121427SN/A 7137528Ssteve.reinhardt@amd.com if self._children.has_key(attr): 7147528Ssteve.reinhardt@amd.com return self._children[attr] 7157528Ssteve.reinhardt@amd.com 7167500Ssteve.reinhardt@amd.com # If the attribute exists on the C++ object, transparently 7177500Ssteve.reinhardt@amd.com # forward the reference there. This is typically used for 7187500Ssteve.reinhardt@amd.com # SWIG-wrapped methods such as init(), regStats(), 7199195SAndreas.Sandberg@arm.com # resetStats(), startup(), drain(), and 7207527Ssteve.reinhardt@amd.com # resume(). 7217500Ssteve.reinhardt@amd.com if self._ccObject and hasattr(self._ccObject, attr): 7227500Ssteve.reinhardt@amd.com return getattr(self._ccObject, attr) 7237500Ssteve.reinhardt@amd.com 7241692SN/A raise AttributeError, "object '%s' has no attribute '%s'" \ 7251692SN/A % (self.__class__.__name__, attr) 7261427SN/A 7271692SN/A # Set attribute (called on foo.attr = value when foo is an 7281692SN/A # instance of class cls). 7291692SN/A def __setattr__(self, attr, value): 7301692SN/A # normal processing for private attributes 7311692SN/A if attr.startswith('_'): 7321692SN/A object.__setattr__(self, attr, value) 7331692SN/A return 7341427SN/A 7352738SN/A if self._ports.has_key(attr): 7362738SN/A # set up port connection 7373105Sstever@eecs.umich.edu self._get_port_ref(attr).connect(value) 7382738SN/A return 7392738SN/A 7402740SN/A if isSimObjectOrSequence(value) and self._instantiated: 7412740SN/A raise RuntimeError, \ 7422740SN/A "cannot set SimObject parameter '%s' after\n" \ 7432740SN/A " instance been cloned %s" % (attr, `self`) 7442740SN/A 7453105Sstever@eecs.umich.edu param = self._params.get(attr) 7461692SN/A if param: 7471310SN/A try: 7481692SN/A value = param.convert(value) 7491587SN/A except Exception, e: 7501692SN/A msg = "%s\nError setting param %s.%s to %s\n" % \ 7511692SN/A (e, self.__class__.__name__, attr, value) 7521605SN/A e.args = (msg, ) 7531605SN/A raise 7547528Ssteve.reinhardt@amd.com self._values[attr] = value 7558321Ssteve.reinhardt@amd.com # implicitly parent unparented objects assigned as params 7568321Ssteve.reinhardt@amd.com if isSimObjectOrVector(value) and not value.has_parent(): 7578321Ssteve.reinhardt@amd.com self.add_child(attr, value) 7583105Sstever@eecs.umich.edu return 7591310SN/A 7607528Ssteve.reinhardt@amd.com # if RHS is a SimObject, it's an implicit child assignment 7613105Sstever@eecs.umich.edu if isSimObjectOrSequence(value): 7627528Ssteve.reinhardt@amd.com self.add_child(attr, value) 7633105Sstever@eecs.umich.edu return 7641693SN/A 7653105Sstever@eecs.umich.edu # no valid assignment... raise exception 7663105Sstever@eecs.umich.edu raise AttributeError, "Class %s has no parameter %s" \ 7673105Sstever@eecs.umich.edu % (self.__class__.__name__, attr) 7681310SN/A 7691310SN/A 7701692SN/A # this hack allows tacking a '[0]' onto parameters that may or may 7711692SN/A # not be vectors, and always getting the first element (e.g. cpus) 7721692SN/A def __getitem__(self, key): 7731692SN/A if key == 0: 7741692SN/A return self 7751692SN/A raise TypeError, "Non-zero index '%s' to SimObject" % key 7761310SN/A 7777528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7787528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 7797528Ssteve.reinhardt@amd.com assert self._parent is old_parent 7807528Ssteve.reinhardt@amd.com self._parent = None 7817528Ssteve.reinhardt@amd.com 7827528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7837528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 7847528Ssteve.reinhardt@amd.com self._parent = parent 7857528Ssteve.reinhardt@amd.com self._name = name 7867528Ssteve.reinhardt@amd.com 7879953Sgeoffrey.blake@arm.com # Return parent object of this SimObject, not implemented by SimObjectVector 7889953Sgeoffrey.blake@arm.com # because the elements in a SimObjectVector may not share the same parent 7899953Sgeoffrey.blake@arm.com def get_parent(self): 7909953Sgeoffrey.blake@arm.com return self._parent 7919953Sgeoffrey.blake@arm.com 7927528Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7937528Ssteve.reinhardt@amd.com def get_name(self): 7947528Ssteve.reinhardt@amd.com return self._name 7957528Ssteve.reinhardt@amd.com 7968321Ssteve.reinhardt@amd.com # Also implemented by SimObjectVector 7978321Ssteve.reinhardt@amd.com def has_parent(self): 7988321Ssteve.reinhardt@amd.com return self._parent is not None 7997528Ssteve.reinhardt@amd.com 8007742Sgblack@eecs.umich.edu # clear out child with given name. This code is not likely to be exercised. 8017742Sgblack@eecs.umich.edu # See comment in add_child. 8021693SN/A def clear_child(self, name): 8031693SN/A child = self._children[name] 8047528Ssteve.reinhardt@amd.com child.clear_parent(self) 8051693SN/A del self._children[name] 8061693SN/A 8077528Ssteve.reinhardt@amd.com # Add a new child to this object. 8087528Ssteve.reinhardt@amd.com def add_child(self, name, child): 8097528Ssteve.reinhardt@amd.com child = coerceSimObjectOrVector(child) 8108321Ssteve.reinhardt@amd.com if child.has_parent(): 8119528Ssascha.bischoff@arm.com warn("add_child('%s'): child '%s' already has parent", name, 8129528Ssascha.bischoff@arm.com child.get_name()) 8137528Ssteve.reinhardt@amd.com if self._children.has_key(name): 8147742Sgblack@eecs.umich.edu # This code path had an undiscovered bug that would make it fail 8157742Sgblack@eecs.umich.edu # at runtime. It had been here for a long time and was only 8167742Sgblack@eecs.umich.edu # exposed by a buggy script. Changes here will probably not be 8177742Sgblack@eecs.umich.edu # exercised without specialized testing. 8187738Sgblack@eecs.umich.edu self.clear_child(name) 8197528Ssteve.reinhardt@amd.com child.set_parent(self, name) 8207528Ssteve.reinhardt@amd.com self._children[name] = child 8211310SN/A 8227528Ssteve.reinhardt@amd.com # Take SimObject-valued parameters that haven't been explicitly 8237528Ssteve.reinhardt@amd.com # assigned as children and make them children of the object that 8247528Ssteve.reinhardt@amd.com # they were assigned to as a parameter value. This guarantees 8257528Ssteve.reinhardt@amd.com # that when we instantiate all the parameter objects we're still 8267528Ssteve.reinhardt@amd.com # inside the configuration hierarchy. 8277528Ssteve.reinhardt@amd.com def adoptOrphanParams(self): 8287528Ssteve.reinhardt@amd.com for key,val in self._values.iteritems(): 8297528Ssteve.reinhardt@amd.com if not isSimObjectVector(val) and isSimObjectSequence(val): 8307528Ssteve.reinhardt@amd.com # need to convert raw SimObject sequences to 8318321Ssteve.reinhardt@amd.com # SimObjectVector class so we can call has_parent() 8327528Ssteve.reinhardt@amd.com val = SimObjectVector(val) 8337528Ssteve.reinhardt@amd.com self._values[key] = val 8348321Ssteve.reinhardt@amd.com if isSimObjectOrVector(val) and not val.has_parent(): 8359528Ssascha.bischoff@arm.com warn("%s adopting orphan SimObject param '%s'", self, key) 8367528Ssteve.reinhardt@amd.com self.add_child(key, val) 8373105Sstever@eecs.umich.edu 8381692SN/A def path(self): 8392740SN/A if not self._parent: 8408321Ssteve.reinhardt@amd.com return '<orphan %s>' % self.__class__ 8411692SN/A ppath = self._parent.path() 8421692SN/A if ppath == 'root': 8431692SN/A return self._name 8441692SN/A return ppath + "." + self._name 8451310SN/A 8461692SN/A def __str__(self): 8471692SN/A return self.path() 8481310SN/A 8491692SN/A def ini_str(self): 8501692SN/A return self.path() 8511310SN/A 8521692SN/A def find_any(self, ptype): 8531692SN/A if isinstance(self, ptype): 8541692SN/A return self, True 8551310SN/A 8561692SN/A found_obj = None 8571692SN/A for child in self._children.itervalues(): 8581692SN/A if isinstance(child, ptype): 8591692SN/A if found_obj != None and child != found_obj: 8601692SN/A raise AttributeError, \ 8611692SN/A 'parent.any matched more than one: %s %s' % \ 8621814SN/A (found_obj.path, child.path) 8631692SN/A found_obj = child 8641692SN/A # search param space 8651692SN/A for pname,pdesc in self._params.iteritems(): 8661692SN/A if issubclass(pdesc.ptype, ptype): 8671692SN/A match_obj = self._values[pname] 8681692SN/A if found_obj != None and found_obj != match_obj: 8691692SN/A raise AttributeError, \ 8705952Ssaidi@eecs.umich.edu 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 8711692SN/A found_obj = match_obj 8721692SN/A return found_obj, found_obj != None 8731692SN/A 8748459SAli.Saidi@ARM.com def find_all(self, ptype): 8758459SAli.Saidi@ARM.com all = {} 8768459SAli.Saidi@ARM.com # search children 8778459SAli.Saidi@ARM.com for child in self._children.itervalues(): 8789410Sandreas.hansson@arm.com # a child could be a list, so ensure we visit each item 8799410Sandreas.hansson@arm.com if isinstance(child, list): 8809410Sandreas.hansson@arm.com children = child 8819410Sandreas.hansson@arm.com else: 8829410Sandreas.hansson@arm.com children = [child] 8839410Sandreas.hansson@arm.com 8849410Sandreas.hansson@arm.com for child in children: 8859410Sandreas.hansson@arm.com if isinstance(child, ptype) and not isproxy(child) and \ 8869410Sandreas.hansson@arm.com not isNullPointer(child): 8879410Sandreas.hansson@arm.com all[child] = True 8889410Sandreas.hansson@arm.com if isSimObject(child): 8899410Sandreas.hansson@arm.com # also add results from the child itself 8909410Sandreas.hansson@arm.com child_all, done = child.find_all(ptype) 8919410Sandreas.hansson@arm.com all.update(dict(zip(child_all, [done] * len(child_all)))) 8928459SAli.Saidi@ARM.com # search param space 8938459SAli.Saidi@ARM.com for pname,pdesc in self._params.iteritems(): 8948459SAli.Saidi@ARM.com if issubclass(pdesc.ptype, ptype): 8958459SAli.Saidi@ARM.com match_obj = self._values[pname] 8968459SAli.Saidi@ARM.com if not isproxy(match_obj) and not isNullPointer(match_obj): 8978459SAli.Saidi@ARM.com all[match_obj] = True 8988459SAli.Saidi@ARM.com return all.keys(), True 8998459SAli.Saidi@ARM.com 9001815SN/A def unproxy(self, base): 9011815SN/A return self 9021815SN/A 9037527Ssteve.reinhardt@amd.com def unproxyParams(self): 9043105Sstever@eecs.umich.edu for param in self._params.iterkeys(): 9053105Sstever@eecs.umich.edu value = self._values.get(param) 9066654Snate@binkert.org if value != None and isproxy(value): 9073105Sstever@eecs.umich.edu try: 9083105Sstever@eecs.umich.edu value = value.unproxy(self) 9093105Sstever@eecs.umich.edu except: 9103105Sstever@eecs.umich.edu print "Error in unproxying param '%s' of %s" % \ 9113105Sstever@eecs.umich.edu (param, self.path()) 9123105Sstever@eecs.umich.edu raise 9133105Sstever@eecs.umich.edu setattr(self, param, value) 9143105Sstever@eecs.umich.edu 9153107Sstever@eecs.umich.edu # Unproxy ports in sorted order so that 'append' operations on 9163107Sstever@eecs.umich.edu # vector ports are done in a deterministic fashion. 9173107Sstever@eecs.umich.edu port_names = self._ports.keys() 9183107Sstever@eecs.umich.edu port_names.sort() 9193107Sstever@eecs.umich.edu for port_name in port_names: 9203105Sstever@eecs.umich.edu port = self._port_refs.get(port_name) 9213105Sstever@eecs.umich.edu if port != None: 9223105Sstever@eecs.umich.edu port.unproxy(self) 9233105Sstever@eecs.umich.edu 9245037Smilesck@eecs.umich.edu def print_ini(self, ini_file): 9255543Ssaidi@eecs.umich.edu print >>ini_file, '[' + self.path() + ']' # .ini section header 9261692SN/A 9272738SN/A instanceDict[self.path()] = self 9282738SN/A 9294081Sbinkertn@umich.edu if hasattr(self, 'type'): 9305037Smilesck@eecs.umich.edu print >>ini_file, 'type=%s' % self.type 9311692SN/A 9328664SAli.Saidi@ARM.com if len(self._children.keys()): 9337528Ssteve.reinhardt@amd.com print >>ini_file, 'children=%s' % \ 9348664SAli.Saidi@ARM.com ' '.join(self._children[n].get_name() \ 9358664SAli.Saidi@ARM.com for n in sorted(self._children.keys())) 9361692SN/A 9378664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 9383105Sstever@eecs.umich.edu value = self._values.get(param) 9391692SN/A if value != None: 9405037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (param, 9415037Smilesck@eecs.umich.edu self._values[param].ini_str()) 9421692SN/A 9438664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 9443105Sstever@eecs.umich.edu port = self._port_refs.get(port_name, None) 9453105Sstever@eecs.umich.edu if port != None: 9465037Smilesck@eecs.umich.edu print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 9473103Sstever@eecs.umich.edu 9485543Ssaidi@eecs.umich.edu print >>ini_file # blank line between objects 9491692SN/A 9508664SAli.Saidi@ARM.com # generate a tree of dictionaries expressing all the parameters in the 9518664SAli.Saidi@ARM.com # instantiated system for use by scripts that want to do power, thermal 9528664SAli.Saidi@ARM.com # visualization, and other similar tasks 9538664SAli.Saidi@ARM.com def get_config_as_dict(self): 9548664SAli.Saidi@ARM.com d = attrdict() 9558664SAli.Saidi@ARM.com if hasattr(self, 'type'): 9568664SAli.Saidi@ARM.com d.type = self.type 9578664SAli.Saidi@ARM.com if hasattr(self, 'cxx_class'): 9588664SAli.Saidi@ARM.com d.cxx_class = self.cxx_class 9599017Sandreas.hansson@arm.com # Add the name and path of this object to be able to link to 9609017Sandreas.hansson@arm.com # the stats 9619017Sandreas.hansson@arm.com d.name = self.get_name() 9629017Sandreas.hansson@arm.com d.path = self.path() 9638664SAli.Saidi@ARM.com 9648664SAli.Saidi@ARM.com for param in sorted(self._params.keys()): 9658664SAli.Saidi@ARM.com value = self._values.get(param) 9668848Ssteve.reinhardt@amd.com if value != None: 9678848Ssteve.reinhardt@amd.com try: 9688848Ssteve.reinhardt@amd.com # Use native type for those supported by JSON and 9698848Ssteve.reinhardt@amd.com # strings for everything else. skipkeys=True seems 9708848Ssteve.reinhardt@amd.com # to not work as well as one would hope 9718848Ssteve.reinhardt@amd.com if type(self._values[param].value) in \ 9728848Ssteve.reinhardt@amd.com [str, unicode, int, long, float, bool, None]: 9738848Ssteve.reinhardt@amd.com d[param] = self._values[param].value 9748848Ssteve.reinhardt@amd.com else: 9758848Ssteve.reinhardt@amd.com d[param] = str(self._values[param]) 9768669Ssaidi@eecs.umich.edu 9778848Ssteve.reinhardt@amd.com except AttributeError: 9788848Ssteve.reinhardt@amd.com pass 9798664SAli.Saidi@ARM.com 9808664SAli.Saidi@ARM.com for n in sorted(self._children.keys()): 9819017Sandreas.hansson@arm.com child = self._children[n] 9829017Sandreas.hansson@arm.com # Use the name of the attribute (and not get_name()) as 9839017Sandreas.hansson@arm.com # the key in the JSON dictionary to capture the hierarchy 9849017Sandreas.hansson@arm.com # in the Python code that assembled this system 9859017Sandreas.hansson@arm.com d[n] = child.get_config_as_dict() 9868664SAli.Saidi@ARM.com 9878664SAli.Saidi@ARM.com for port_name in sorted(self._ports.keys()): 9888664SAli.Saidi@ARM.com port = self._port_refs.get(port_name, None) 9898664SAli.Saidi@ARM.com if port != None: 9909017Sandreas.hansson@arm.com # Represent each port with a dictionary containing the 9919017Sandreas.hansson@arm.com # prominent attributes 9929017Sandreas.hansson@arm.com d[port_name] = port.get_config_as_dict() 9938664SAli.Saidi@ARM.com 9948664SAli.Saidi@ARM.com return d 9958664SAli.Saidi@ARM.com 9964762Snate@binkert.org def getCCParams(self): 9974762Snate@binkert.org if self._ccParams: 9984762Snate@binkert.org return self._ccParams 9994762Snate@binkert.org 10007677Snate@binkert.org cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 10014762Snate@binkert.org cc_params = cc_params_struct() 10025488Snate@binkert.org cc_params.pyobj = self 10034762Snate@binkert.org cc_params.name = str(self) 10044762Snate@binkert.org 10054762Snate@binkert.org param_names = self._params.keys() 10064762Snate@binkert.org param_names.sort() 10074762Snate@binkert.org for param in param_names: 10084762Snate@binkert.org value = self._values.get(param) 10094762Snate@binkert.org if value is None: 10106654Snate@binkert.org fatal("%s.%s without default or user set value", 10116654Snate@binkert.org self.path(), param) 10124762Snate@binkert.org 10134762Snate@binkert.org value = value.getValue() 10144762Snate@binkert.org if isinstance(self._params[param], VectorParamDesc): 10154762Snate@binkert.org assert isinstance(value, list) 10164762Snate@binkert.org vec = getattr(cc_params, param) 10174762Snate@binkert.org assert not len(vec) 10184762Snate@binkert.org for v in value: 10194762Snate@binkert.org vec.append(v) 10204762Snate@binkert.org else: 10214762Snate@binkert.org setattr(cc_params, param, value) 10224762Snate@binkert.org 10234762Snate@binkert.org port_names = self._ports.keys() 10244762Snate@binkert.org port_names.sort() 10254762Snate@binkert.org for port_name in port_names: 10264762Snate@binkert.org port = self._port_refs.get(port_name, None) 10278912Sandreas.hansson@arm.com if port != None: 10288912Sandreas.hansson@arm.com port_count = len(port) 10298912Sandreas.hansson@arm.com else: 10308912Sandreas.hansson@arm.com port_count = 0 10318900Sandreas.hansson@arm.com setattr(cc_params, 'port_' + port_name + '_connection_count', 10328912Sandreas.hansson@arm.com port_count) 10334762Snate@binkert.org self._ccParams = cc_params 10344762Snate@binkert.org return self._ccParams 10352738SN/A 10362740SN/A # Get C++ object corresponding to this object, calling C++ if 10372740SN/A # necessary to construct it. Does *not* recursively create 10382740SN/A # children. 10392740SN/A def getCCObject(self): 10402740SN/A if not self._ccObject: 10417526Ssteve.reinhardt@amd.com # Make sure this object is in the configuration hierarchy 10427526Ssteve.reinhardt@amd.com if not self._parent and not isRoot(self): 10437526Ssteve.reinhardt@amd.com raise RuntimeError, "Attempt to instantiate orphan node" 10447526Ssteve.reinhardt@amd.com # Cycles in the configuration hierarchy are not supported. This 10455244Sgblack@eecs.umich.edu # will catch the resulting recursion and stop. 10465244Sgblack@eecs.umich.edu self._ccObject = -1 10475244Sgblack@eecs.umich.edu params = self.getCCParams() 10484762Snate@binkert.org self._ccObject = params.create() 10492740SN/A elif self._ccObject == -1: 10507526Ssteve.reinhardt@amd.com raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 10512740SN/A % self.path() 10522740SN/A return self._ccObject 10532740SN/A 10547527Ssteve.reinhardt@amd.com def descendants(self): 10557527Ssteve.reinhardt@amd.com yield self 10567527Ssteve.reinhardt@amd.com for child in self._children.itervalues(): 10577527Ssteve.reinhardt@amd.com for obj in child.descendants(): 10587527Ssteve.reinhardt@amd.com yield obj 10597527Ssteve.reinhardt@amd.com 10607527Ssteve.reinhardt@amd.com # Call C++ to create C++ object corresponding to this object 10614762Snate@binkert.org def createCCObject(self): 10624762Snate@binkert.org self.getCCParams() 10634762Snate@binkert.org self.getCCObject() # force creation 10644762Snate@binkert.org 10654762Snate@binkert.org def getValue(self): 10664762Snate@binkert.org return self.getCCObject() 10674762Snate@binkert.org 10682738SN/A # Create C++ port connections corresponding to the connections in 10697527Ssteve.reinhardt@amd.com # _port_refs 10702738SN/A def connectPorts(self): 10713105Sstever@eecs.umich.edu for portRef in self._port_refs.itervalues(): 10723105Sstever@eecs.umich.edu portRef.ccConnect() 10732797SN/A 10743101Sstever@eecs.umich.edu# Function to provide to C++ so it can look up instances based on paths 10753101Sstever@eecs.umich.edudef resolveSimObject(name): 10763101Sstever@eecs.umich.edu obj = instanceDict[name] 10773101Sstever@eecs.umich.edu return obj.getCCObject() 1078679SN/A 10796654Snate@binkert.orgdef isSimObject(value): 10806654Snate@binkert.org return isinstance(value, SimObject) 10816654Snate@binkert.org 10826654Snate@binkert.orgdef isSimObjectClass(value): 10836654Snate@binkert.org return issubclass(value, SimObject) 10846654Snate@binkert.org 10857528Ssteve.reinhardt@amd.comdef isSimObjectVector(value): 10867528Ssteve.reinhardt@amd.com return isinstance(value, SimObjectVector) 10877528Ssteve.reinhardt@amd.com 10886654Snate@binkert.orgdef isSimObjectSequence(value): 10896654Snate@binkert.org if not isinstance(value, (list, tuple)) or len(value) == 0: 10906654Snate@binkert.org return False 10916654Snate@binkert.org 10926654Snate@binkert.org for val in value: 10936654Snate@binkert.org if not isNullPointer(val) and not isSimObject(val): 10946654Snate@binkert.org return False 10956654Snate@binkert.org 10966654Snate@binkert.org return True 10976654Snate@binkert.org 10986654Snate@binkert.orgdef isSimObjectOrSequence(value): 10996654Snate@binkert.org return isSimObject(value) or isSimObjectSequence(value) 11006654Snate@binkert.org 11017526Ssteve.reinhardt@amd.comdef isRoot(obj): 11027526Ssteve.reinhardt@amd.com from m5.objects import Root 11037526Ssteve.reinhardt@amd.com return obj and obj is Root.getInstance() 11047526Ssteve.reinhardt@amd.com 11057528Ssteve.reinhardt@amd.comdef isSimObjectOrVector(value): 11067528Ssteve.reinhardt@amd.com return isSimObject(value) or isSimObjectVector(value) 11077528Ssteve.reinhardt@amd.com 11087528Ssteve.reinhardt@amd.comdef tryAsSimObjectOrVector(value): 11097528Ssteve.reinhardt@amd.com if isSimObjectOrVector(value): 11107528Ssteve.reinhardt@amd.com return value 11117528Ssteve.reinhardt@amd.com if isSimObjectSequence(value): 11127528Ssteve.reinhardt@amd.com return SimObjectVector(value) 11137528Ssteve.reinhardt@amd.com return None 11147528Ssteve.reinhardt@amd.com 11157528Ssteve.reinhardt@amd.comdef coerceSimObjectOrVector(value): 11167528Ssteve.reinhardt@amd.com value = tryAsSimObjectOrVector(value) 11177528Ssteve.reinhardt@amd.com if value is None: 11187528Ssteve.reinhardt@amd.com raise TypeError, "SimObject or SimObjectVector expected" 11197528Ssteve.reinhardt@amd.com return value 11207528Ssteve.reinhardt@amd.com 11216654Snate@binkert.orgbaseClasses = allClasses.copy() 11226654Snate@binkert.orgbaseInstances = instanceDict.copy() 11236654Snate@binkert.org 11246654Snate@binkert.orgdef clear(): 11259338SAndreas.Sandberg@arm.com global allClasses, instanceDict, noCxxHeader 11266654Snate@binkert.org 11276654Snate@binkert.org allClasses = baseClasses.copy() 11286654Snate@binkert.org instanceDict = baseInstances.copy() 11299338SAndreas.Sandberg@arm.com noCxxHeader = False 11306654Snate@binkert.org 11311528SN/A# __all__ defines the list of symbols that get exported when 11321528SN/A# 'from config import *' is invoked. Try to keep this reasonably 11331528SN/A# short to avoid polluting other namespaces. 11344762Snate@binkert.org__all__ = [ 'SimObject' ] 1135