src/python/m5/SimObject.py

   1 # Copyright (c) 2012 ARM Limited
   2 # All rights reserved.
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Copyright (c) 2004-2006 The Regents of The University of Michigan
  14 # Copyright (c) 2010 Advanced Micro Devices, Inc.
  15 # All rights reserved.
  16 #
  17 # Redistribution and use in source and binary forms, with or without
  18 # modification, are permitted provided that the following conditions are
  19 # met: redistributions of source code must retain the above copyright
  20 # notice, this list of conditions and the following disclaimer;
  21 # redistributions in binary form must reproduce the above copyright
  22 # notice, this list of conditions and the following disclaimer in the
  23 # documentation and/or other materials provided with the distribution;
  24 # neither the name of the copyright holders nor the names of its
  25 # contributors may be used to endorse or promote products derived from
  26 # this software without specific prior written permission.
  27 #
  28 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39 #
  40 # Authors: Steve Reinhardt
  41 #          Nathan Binkert
  42 #          Andreas Hansson
  43
  44 import sys
  45 from types import FunctionType, MethodType, ModuleType
  46
  47 import m5
  48 from m5.util import *
  49
  50 # Have to import params up top since Param is referenced on initial
  51 # load (when SimObject class references Param to create a class
  52 # variable, the 'name' param)...
  53 from m5.params import *
  54 # There are a few things we need that aren't in params.__all__ since
  55 # normal users don't need them
  56 from m5.params import ParamDesc, VectorParamDesc, \
  57      isNullPointer, SimObjectVector, Port
  58
  59 from m5.proxy import *
  60 from m5.proxy import isproxy
  61
  62 #####################################################################
  63 #
  64 # M5 Python Configuration Utility
  65 #
  66 # The basic idea is to write simple Python programs that build Python
  67 # objects corresponding to M5 SimObjects for the desired simulation
  68 # configuration.  For now, the Python emits a .ini file that can be
  69 # parsed by M5.  In the future, some tighter integration between M5
  70 # and the Python interpreter may allow bypassing the .ini file.
  71 #
  72 # Each SimObject class in M5 is represented by a Python class with the
  73 # same name.  The Python inheritance tree mirrors the M5 C++ tree
  74 # (e.g., SimpleCPU derives from BaseCPU in both cases, and all
  75 # SimObjects inherit from a single SimObject base class).  To specify
  76 # an instance of an M5 SimObject in a configuration, the user simply
  77 # instantiates the corresponding Python object.  The parameters for
  78 # that SimObject are given by assigning to attributes of the Python
  79 # object, either using keyword assignment in the constructor or in
  80 # separate assignment statements.  For example:
  81 #
  82 # cache = BaseCache(size='64KB')
  83 # cache.hit_latency = 3
  84 # cache.assoc = 8
  85 #
  86 # The magic lies in the mapping of the Python attributes for SimObject
  87 # classes to the actual SimObject parameter specifications.  This
  88 # allows parameter validity checking in the Python code.  Continuing
  89 # the example above, the statements "cache.blurfl=3" or
  90 # "cache.assoc='hello'" would both result in runtime errors in Python,
  91 # since the BaseCache object has no 'blurfl' parameter and the 'assoc'
  92 # parameter requires an integer, respectively.  This magic is done
  93 # primarily by overriding the special __setattr__ method that controls
  94 # assignment to object attributes.
  95 #
  96 # Once a set of Python objects have been instantiated in a hierarchy,
  97 # calling 'instantiate(obj)' (where obj is the root of the hierarchy)
  98 # will generate a .ini file.
  99 #
 100 #####################################################################
 101
 102 # list of all SimObject classes
 103 allClasses = {}
 104
 105 # dict to look up SimObjects based on path
 106 instanceDict = {}
 107
 108 def public_value(key, value):
 109     return key.startswith('_') or \
 110                isinstance(value, (FunctionType, MethodType, ModuleType,
 111                                   classmethod, type))
 112
 113 # The metaclass for SimObject.  This class controls how new classes
 114 # that derive from SimObject are instantiated, and provides inherited
 115 # class behavior (just like a class controls how instances of that
 116 # class are instantiated, and provides inherited instance behavior).
 117 class MetaSimObject(type):
 118     # Attributes that can be set only at initialization time
 119     init_keywords = { 'abstract' : bool,
 120                       'cxx_class' : str,
 121                       'cxx_type' : str,
 122                       'type' : str }
 123     # Attributes that can be set any time
 124     keywords = { 'check' : FunctionType }
 125
 126     # __new__ is called before __init__, and is where the statements
 127     # in the body of the class definition get loaded into the class's
 128     # __dict__.  We intercept this to filter out parameter & port assignments
 129     # and only allow "private" attributes to be passed to the base
 130     # __new__ (starting with underscore).
 131     def __new__(mcls, name, bases, dict):
 132         assert name not in allClasses, "SimObject %s already present" % name
 133
 134         # Copy "private" attributes, functions, and classes to the
 135         # official dict.  Everything else goes in _init_dict to be
 136         # filtered in __init__.
 137         cls_dict = {}
 138         value_dict = {}
 139         for key,val in dict.items():
 140             if public_value(key, val):
 141                 cls_dict[key] = val
 142             else:
 143                 # must be a param/port setting
 144                 value_dict[key] = val
 145         if 'abstract' not in value_dict:
 146             value_dict['abstract'] = False
 147         cls_dict['_value_dict'] = value_dict
 148         cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict)
 149         if 'type' in value_dict:
 150             allClasses[name] = cls
 151         return cls
 152
 153     # subclass initialization
 154     def __init__(cls, name, bases, dict):
 155         # calls type.__init__()... I think that's a no-op, but leave
 156         # it here just in case it's not.
 157         super(MetaSimObject, cls).__init__(name, bases, dict)
 158
 159         # initialize required attributes
 160
 161         # class-only attributes
 162         cls._params = multidict() # param descriptions
 163         cls._ports = multidict()  # port descriptions
 164
 165         # class or instance attributes
 166         cls._values = multidict()   # param values
 167         cls._children = multidict() # SimObject children
 168         cls._port_refs = multidict() # port ref objects
 169         cls._instantiated = False # really instantiated, cloned, or subclassed
 170
 171         # We don't support multiple inheritance of sim objects.  If you want
 172         # to, you must fix multidict to deal with it properly. Non sim-objects
 173         # are ok, though
 174         bTotal = 0
 175         for c in bases:
 176             if isinstance(c, MetaSimObject):
 177                 bTotal += 1
 178             if bTotal > 1:
 179                 raise TypeError, "SimObjects do not support multiple inheritance"
 180
 181         base = bases[0]
 182
 183         # Set up general inheritance via multidicts.  A subclass will
 184         # inherit all its settings from the base class.  The only time
 185         # the following is not true is when we define the SimObject
 186         # class itself (in which case the multidicts have no parent).
 187         if isinstance(base, MetaSimObject):
 188             cls._base = base
 189             cls._params.parent = base._params
 190             cls._ports.parent = base._ports
 191             cls._values.parent = base._values
 192             cls._children.parent = base._children
 193             cls._port_refs.parent = base._port_refs
 194             # mark base as having been subclassed
 195             base._instantiated = True
 196         else:
 197             cls._base = None
 198
 199         # default keyword values
 200         if 'type' in cls._value_dict:
 201             if 'cxx_class' not in cls._value_dict:
 202                 cls._value_dict['cxx_class'] = cls._value_dict['type']
 203
 204             cls._value_dict['cxx_type'] = '%s *' % cls._value_dict['cxx_class']
 205
 206         # Export methods are automatically inherited via C++, so we
 207         # don't want the method declarations to get inherited on the
 208         # python side (and thus end up getting repeated in the wrapped
 209         # versions of derived classes).  The code below basicallly
 210         # suppresses inheritance by substituting in the base (null)
 211         # versions of these methods unless a different version is
 212         # explicitly supplied.
 213         for method_name in ('export_methods', 'export_method_cxx_predecls',
 214                             'export_method_swig_predecls'):
 215             if method_name not in cls.__dict__:
 216                 base_method = getattr(MetaSimObject, method_name)
 217                 m = MethodType(base_method, cls, MetaSimObject)
 218                 setattr(cls, method_name, m)
 219
 220         # Now process the _value_dict items.  They could be defining
 221         # new (or overriding existing) parameters or ports, setting
 222         # class keywords (e.g., 'abstract'), or setting parameter
 223         # values or port bindings.  The first 3 can only be set when
 224         # the class is defined, so we handle them here.  The others
 225         # can be set later too, so just emulate that by calling
 226         # setattr().
 227         for key,val in cls._value_dict.items():
 228             # param descriptions
 229             if isinstance(val, ParamDesc):
 230                 cls._new_param(key, val)
 231
 232             # port objects
 233             elif isinstance(val, Port):
 234                 cls._new_port(key, val)
 235
 236             # init-time-only keywords
 237             elif cls.init_keywords.has_key(key):
 238                 cls._set_keyword(key, val, cls.init_keywords[key])
 239
 240             # default: use normal path (ends up in __setattr__)
 241             else:
 242                 setattr(cls, key, val)
 243
 244     def _set_keyword(cls, keyword, val, kwtype):
 245         if not isinstance(val, kwtype):
 246             raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \
 247                   (keyword, type(val), kwtype)
 248         if isinstance(val, FunctionType):
 249             val = classmethod(val)
 250         type.__setattr__(cls, keyword, val)
 251
 252     def _new_param(cls, name, pdesc):
 253         # each param desc should be uniquely assigned to one variable
 254         assert(not hasattr(pdesc, 'name'))
 255         pdesc.name = name
 256         cls._params[name] = pdesc
 257         if hasattr(pdesc, 'default'):
 258             cls._set_param(name, pdesc.default, pdesc)
 259
 260     def _set_param(cls, name, value, param):
 261         assert(param.name == name)
 262         try:
 263             value = param.convert(value)
 264         except Exception, e:
 265             msg = "%s\nError setting param %s.%s to %s\n" % \
 266                   (e, cls.__name__, name, value)
 267             e.args = (msg, )
 268             raise
 269         cls._values[name] = value
 270         # if param value is a SimObject, make it a child too, so that
 271         # it gets cloned properly when the class is instantiated
 272         if isSimObjectOrVector(value) and not value.has_parent():
 273             cls._add_cls_child(name, value)
 274
 275     def _add_cls_child(cls, name, child):
 276         # It's a little funky to have a class as a parent, but these
 277         # objects should never be instantiated (only cloned, which
 278         # clears the parent pointer), and this makes it clear that the
 279         # object is not an orphan and can provide better error
 280         # messages.
 281         child.set_parent(cls, name)
 282         cls._children[name] = child
 283
 284     def _new_port(cls, name, port):
 285         # each port should be uniquely assigned to one variable
 286         assert(not hasattr(port, 'name'))
 287         port.name = name
 288         cls._ports[name] = port
 289
 290     # same as _get_port_ref, effectively, but for classes
 291     def _cls_get_port_ref(cls, attr):
 292         # Return reference that can be assigned to another port
 293         # via __setattr__.  There is only ever one reference
 294         # object per port, but we create them lazily here.
 295         ref = cls._port_refs.get(attr)
 296         if not ref:
 297             ref = cls._ports[attr].makeRef(cls)
 298             cls._port_refs[attr] = ref
 299         return ref
 300
 301     # Set attribute (called on foo.attr = value when foo is an
 302     # instance of class cls).
 303     def __setattr__(cls, attr, value):
 304         # normal processing for private attributes
 305         if public_value(attr, value):
 306             type.__setattr__(cls, attr, value)
 307             return
 308
 309         if cls.keywords.has_key(attr):
 310             cls._set_keyword(attr, value, cls.keywords[attr])
 311             return
 312
 313         if cls._ports.has_key(attr):
 314             cls._cls_get_port_ref(attr).connect(value)
 315             return
 316
 317         if isSimObjectOrSequence(value) and cls._instantiated:
 318             raise RuntimeError, \
 319                   "cannot set SimObject parameter '%s' after\n" \
 320                   "    class %s has been instantiated or subclassed" \
 321                   % (attr, cls.__name__)
 322
 323         # check for param
 324         param = cls._params.get(attr)
 325         if param:
 326             cls._set_param(attr, value, param)
 327             return
 328
 329         if isSimObjectOrSequence(value):
 330             # If RHS is a SimObject, it's an implicit child assignment.
 331             cls._add_cls_child(attr, coerceSimObjectOrVector(value))
 332             return
 333
 334         # no valid assignment... raise exception
 335         raise AttributeError, \
 336               "Class %s has no parameter \'%s\'" % (cls.__name__, attr)
 337
 338     def __getattr__(cls, attr):
 339         if attr == 'cxx_class_path':
 340             return cls.cxx_class.split('::')
 341
 342         if attr == 'cxx_class_name':
 343             return cls.cxx_class_path[-1]
 344
 345         if attr == 'cxx_namespaces':
 346             return cls.cxx_class_path[:-1]
 347
 348         if cls._values.has_key(attr):
 349             return cls._values[attr]
 350
 351         if cls._children.has_key(attr):
 352             return cls._children[attr]
 353
 354         raise AttributeError, \
 355               "object '%s' has no attribute '%s'" % (cls.__name__, attr)
 356
 357     def __str__(cls):
 358         return cls.__name__
 359
 360     # See ParamValue.cxx_predecls for description.
 361     def cxx_predecls(cls, code):
 362         code('#include "params/$cls.hh"')
 363
 364     # See ParamValue.swig_predecls for description.
 365     def swig_predecls(cls, code):
 366         code('%import "python/m5/internal/param_$cls.i"')
 367
 368     # Hook for exporting additional C++ methods to Python via SWIG.
 369     # Default is none, override using @classmethod in class definition.
 370     def export_methods(cls, code):
 371         pass
 372
 373     # Generate the code needed as a prerequisite for the C++ methods
 374     # exported via export_methods() to be compiled in the _wrap.cc
 375     # file.  Typically generates one or more #include statements.  If
 376     # any methods are exported, typically at least the C++ header
 377     # declaring the relevant SimObject class must be included.
 378     def export_method_cxx_predecls(cls, code):
 379         pass
 380
 381     # Generate the code needed as a prerequisite for the C++ methods
 382     # exported via export_methods() to be processed by SWIG.
 383     # Typically generates one or more %include or %import statements.
 384     # If any methods are exported, typically at least the C++ header
 385     # declaring the relevant SimObject class must be included.
 386     def export_method_swig_predecls(cls, code):
 387         pass
 388
 389     # Generate the declaration for this object for wrapping with SWIG.
 390     # Generates code that goes into a SWIG .i file.  Called from
 391     # src/SConscript.
 392     def swig_decl(cls, code):
 393         class_path = cls.cxx_class.split('::')
 394         classname = class_path[-1]
 395         namespaces = class_path[:-1]
 396
 397         # The 'local' attribute restricts us to the params declared in
 398         # the object itself, not including inherited params (which
 399         # will also be inherited from the base class's param struct
 400         # here).
 401         params = cls._params.local.values()
 402         ports = cls._ports.local
 403
 404         code('%module(package="m5.internal") param_$cls')
 405         code()
 406         code('%{')
 407         code('#include "params/$cls.hh"')
 408         for param in params:
 409             param.cxx_predecls(code)
 410         cls.export_method_cxx_predecls(code)
 411         code('''\
 412 /**
 413   * This is a workaround for bug in swig. Prior to gcc 4.6.1 the STL
 414   * headers like vector, string, etc. used to automatically pull in
 415   * the cstddef header but starting with gcc 4.6.1 they no longer do.
 416   * This leads to swig generated a file that does not compile so we
 417   * explicitly include cstddef. Additionally, including version 2.0.4,
 418   * swig uses ptrdiff_t without the std:: namespace prefix which is
 419   * required with gcc 4.6.1. We explicitly provide access to it.
 420   */
 421 #include <cstddef>
 422 using std::ptrdiff_t;
 423 ''')
 424         code('%}')
 425         code()
 426
 427         for param in params:
 428             param.swig_predecls(code)
 429         cls.export_method_swig_predecls(code)
 430
 431         code()
 432         if cls._base:
 433             code('%import "python/m5/internal/param_${{cls._base}}.i"')
 434         code()
 435
 436         for ns in namespaces:
 437             code('namespace $ns {')
 438
 439         if namespaces:
 440             code('// avoid name conflicts')
 441             sep_string = '_COLONS_'
 442             flat_name = sep_string.join(class_path)
 443             code('%rename($flat_name) $classname;')
 444
 445         code()
 446         code('// stop swig from creating/wrapping default ctor/dtor')
 447         code('%nodefault $classname;')
 448         code('class $classname')
 449         if cls._base:
 450             code('    : public ${{cls._base.cxx_class}}')
 451         code('{')
 452         code('  public:')
 453         cls.export_methods(code)
 454         code('};')
 455
 456         for ns in reversed(namespaces):
 457             code('} // namespace $ns')
 458
 459         code()
 460         code('%include "params/$cls.hh"')
 461
 462
 463     # Generate the C++ declaration (.hh file) for this SimObject's
 464     # param struct.  Called from src/SConscript.
 465     def cxx_param_decl(cls, code):
 466         # The 'local' attribute restricts us to the params declared in
 467         # the object itself, not including inherited params (which
 468         # will also be inherited from the base class's param struct
 469         # here).
 470         params = cls._params.local.values()
 471         ports = cls._ports.local
 472         try:
 473             ptypes = [p.ptype for p in params]
 474         except:
 475             print cls, p, p.ptype_str
 476             print params
 477             raise
 478
 479         class_path = cls._value_dict['cxx_class'].split('::')
 480
 481         code('''\
 482 #ifndef __PARAMS__${cls}__
 483 #define __PARAMS__${cls}__
 484
 485 ''')
 486
 487         # A forward class declaration is sufficient since we are just
 488         # declaring a pointer.
 489         for ns in class_path[:-1]:
 490             code('namespace $ns {')
 491         code('class $0;', class_path[-1])
 492         for ns in reversed(class_path[:-1]):
 493             code('} // namespace $ns')
 494         code()
 495
 496         # The base SimObject has a couple of params that get
 497         # automatically set from Python without being declared through
 498         # the normal Param mechanism; we slip them in here (needed
 499         # predecls now, actual declarations below)
 500         if cls == SimObject:
 501             code('''
 502 #ifndef PY_VERSION
 503 struct PyObject;
 504 #endif
 505
 506 #include <string>
 507
 508 class EventQueue;
 509 ''')
 510         for param in params:
 511             param.cxx_predecls(code)
 512         for port in ports.itervalues():
 513             port.cxx_predecls(code)
 514         code()
 515
 516         if cls._base:
 517             code('#include "params/${{cls._base.type}}.hh"')
 518             code()
 519
 520         for ptype in ptypes:
 521             if issubclass(ptype, Enum):
 522                 code('#include "enums/${{ptype.__name__}}.hh"')
 523                 code()
 524
 525         # now generate the actual param struct
 526         code("struct ${cls}Params")
 527         if cls._base:
 528             code("    : public ${{cls._base.type}}Params")
 529         code("{")
 530         if not hasattr(cls, 'abstract') or not cls.abstract:
 531             if 'type' in cls.__dict__:
 532                 code("    ${{cls.cxx_type}} create();")
 533
 534         code.indent()
 535         if cls == SimObject:
 536             code('''
 537     SimObjectParams()
 538     {
 539         extern EventQueue mainEventQueue;
 540         eventq = &mainEventQueue;
 541     }
 542     virtual ~SimObjectParams() {}
 543
 544     std::string name;
 545     PyObject *pyobj;
 546     EventQueue *eventq;
 547             ''')
 548         for param in params:
 549             param.cxx_decl(code)
 550         for port in ports.itervalues():
 551             port.cxx_decl(code)
 552
 553         code.dedent()
 554         code('};')
 555
 556         code()
 557         code('#endif // __PARAMS__${cls}__')
 558         return code
 559
 560
 561
 562 # The SimObject class is the root of the special hierarchy.  Most of
 563 # the code in this class deals with the configuration hierarchy itself
 564 # (parent/child node relationships).
 565 class SimObject(object):
 566     # Specify metaclass.  Any class inheriting from SimObject will
 567     # get this metaclass.
 568     __metaclass__ = MetaSimObject
 569     type = 'SimObject'
 570     abstract = True
 571
 572     @classmethod
 573     def export_method_cxx_predecls(cls, code):
 574         code('''
 575 #include <Python.h>
 576
 577 #include "sim/serialize.hh"
 578 #include "sim/sim_object.hh"
 579 ''')
 580
 581     @classmethod
 582     def export_method_swig_predecls(cls, code):
 583         code('''
 584 %include <std_string.i>
 585 ''')
 586
 587     @classmethod
 588     def export_methods(cls, code):
 589         code('''
 590     enum State {
 591       Running,
 592       Draining,
 593       Drained
 594     };
 595
 596     void init();
 597     void loadState(Checkpoint *cp);
 598     void initState();
 599     void regStats();
 600     void resetStats();
 601     void startup();
 602
 603     unsigned int drain(Event *drain_event);
 604     void resume();
 605 ''')
 606
 607     # Initialize new instance.  For objects with SimObject-valued
 608     # children, we need to recursively clone the classes represented
 609     # by those param values as well in a consistent "deep copy"-style
 610     # fashion.  That is, we want to make sure that each instance is
 611     # cloned only once, and that if there are multiple references to
 612     # the same original object, we end up with the corresponding
 613     # cloned references all pointing to the same cloned instance.
 614     def __init__(self, **kwargs):
 615         ancestor = kwargs.get('_ancestor')
 616         memo_dict = kwargs.get('_memo')
 617         if memo_dict is None:
 618             # prepare to memoize any recursively instantiated objects
 619             memo_dict = {}
 620         elif ancestor:
 621             # memoize me now to avoid problems with recursive calls
 622             memo_dict[ancestor] = self
 623
 624         if not ancestor:
 625             ancestor = self.__class__
 626         ancestor._instantiated = True
 627
 628         # initialize required attributes
 629         self._parent = None
 630         self._name = None
 631         self._ccObject = None  # pointer to C++ object
 632         self._ccParams = None
 633         self._instantiated = False # really "cloned"
 634
 635         # Clone children specified at class level.  No need for a
 636         # multidict here since we will be cloning everything.
 637         # Do children before parameter values so that children that
 638         # are also param values get cloned properly.
 639         self._children = {}
 640         for key,val in ancestor._children.iteritems():
 641             self.add_child(key, val(_memo=memo_dict))
 642
 643         # Inherit parameter values from class using multidict so
 644         # individual value settings can be overridden but we still
 645         # inherit late changes to non-overridden class values.
 646         self._values = multidict(ancestor._values)
 647         # clone SimObject-valued parameters
 648         for key,val in ancestor._values.iteritems():
 649             val = tryAsSimObjectOrVector(val)
 650             if val is not None:
 651                 self._values[key] = val(_memo=memo_dict)
 652
 653         # clone port references.  no need to use a multidict here
 654         # since we will be creating new references for all ports.
 655         self._port_refs = {}
 656         for key,val in ancestor._port_refs.iteritems():
 657             self._port_refs[key] = val.clone(self, memo_dict)
 658         # apply attribute assignments from keyword args, if any
 659         for key,val in kwargs.iteritems():
 660             setattr(self, key, val)
 661
 662     # "Clone" the current instance by creating another instance of
 663     # this instance's class, but that inherits its parameter values
 664     # and port mappings from the current instance.  If we're in a
 665     # "deep copy" recursive clone, check the _memo dict to see if
 666     # we've already cloned this instance.
 667     def __call__(self, **kwargs):
 668         memo_dict = kwargs.get('_memo')
 669         if memo_dict is None:
 670             # no memo_dict: must be top-level clone operation.
 671             # this is only allowed at the root of a hierarchy
 672             if self._parent:
 673                 raise RuntimeError, "attempt to clone object %s " \
 674                       "not at the root of a tree (parent = %s)" \
 675                       % (self, self._parent)
 676             # create a new dict and use that.
 677             memo_dict = {}
 678             kwargs['_memo'] = memo_dict
 679         elif memo_dict.has_key(self):
 680             # clone already done & memoized
 681             return memo_dict[self]
 682         return self.__class__(_ancestor = self, **kwargs)
 683
 684     def _get_port_ref(self, attr):
 685         # Return reference that can be assigned to another port
 686         # via __setattr__.  There is only ever one reference
 687         # object per port, but we create them lazily here.
 688         ref = self._port_refs.get(attr)
 689         if not ref:
 690             ref = self._ports[attr].makeRef(self)
 691             self._port_refs[attr] = ref
 692         return ref
 693
 694     def __getattr__(self, attr):
 695         if self._ports.has_key(attr):
 696             return self._get_port_ref(attr)
 697
 698         if self._values.has_key(attr):
 699             return self._values[attr]
 700
 701         if self._children.has_key(attr):
 702             return self._children[attr]
 703
 704         # If the attribute exists on the C++ object, transparently
 705         # forward the reference there.  This is typically used for
 706         # SWIG-wrapped methods such as init(), regStats(),
 707         # resetStats(), startup(), drain(), and
 708         # resume().
 709         if self._ccObject and hasattr(self._ccObject, attr):
 710             return getattr(self._ccObject, attr)
 711
 712         raise AttributeError, "object '%s' has no attribute '%s'" \
 713               % (self.__class__.__name__, attr)
 714
 715     # Set attribute (called on foo.attr = value when foo is an
 716     # instance of class cls).
 717     def __setattr__(self, attr, value):
 718         # normal processing for private attributes
 719         if attr.startswith('_'):
 720             object.__setattr__(self, attr, value)
 721             return
 722
 723         if self._ports.has_key(attr):
 724             # set up port connection
 725             self._get_port_ref(attr).connect(value)
 726             return
 727
 728         if isSimObjectOrSequence(value) and self._instantiated:
 729             raise RuntimeError, \
 730                   "cannot set SimObject parameter '%s' after\n" \
 731                   "    instance been cloned %s" % (attr, `self`)
 732
 733         param = self._params.get(attr)
 734         if param:
 735             try:
 736                 value = param.convert(value)
 737             except Exception, e:
 738                 msg = "%s\nError setting param %s.%s to %s\n" % \
 739                       (e, self.__class__.__name__, attr, value)
 740                 e.args = (msg, )
 741                 raise
 742             self._values[attr] = value
 743             # implicitly parent unparented objects assigned as params
 744             if isSimObjectOrVector(value) and not value.has_parent():
 745                 self.add_child(attr, value)
 746             return
 747
 748         # if RHS is a SimObject, it's an implicit child assignment
 749         if isSimObjectOrSequence(value):
 750             self.add_child(attr, value)
 751             return
 752
 753         # no valid assignment... raise exception
 754         raise AttributeError, "Class %s has no parameter %s" \
 755               % (self.__class__.__name__, attr)
 756
 757
 758     # this hack allows tacking a '[0]' onto parameters that may or may
 759     # not be vectors, and always getting the first element (e.g. cpus)
 760     def __getitem__(self, key):
 761         if key == 0:
 762             return self
 763         raise TypeError, "Non-zero index '%s' to SimObject" % key
 764
 765     # Also implemented by SimObjectVector
 766     def clear_parent(self, old_parent):
 767         assert self._parent is old_parent
 768         self._parent = None
 769
 770     # Also implemented by SimObjectVector
 771     def set_parent(self, parent, name):
 772         self._parent = parent
 773         self._name = name
 774
 775     # Also implemented by SimObjectVector
 776     def get_name(self):
 777         return self._name
 778
 779     # Also implemented by SimObjectVector
 780     def has_parent(self):
 781         return self._parent is not None
 782
 783     # clear out child with given name. This code is not likely to be exercised.
 784     # See comment in add_child.
 785     def clear_child(self, name):
 786         child = self._children[name]
 787         child.clear_parent(self)
 788         del self._children[name]
 789
 790     # Add a new child to this object.
 791     def add_child(self, name, child):
 792         child = coerceSimObjectOrVector(child)
 793         if child.has_parent():
 794             print "warning: add_child('%s'): child '%s' already has parent" % \
 795                   (name, child.get_name())
 796         if self._children.has_key(name):
 797             # This code path had an undiscovered bug that would make it fail
 798             # at runtime. It had been here for a long time and was only
 799             # exposed by a buggy script. Changes here will probably not be
 800             # exercised without specialized testing.
 801             self.clear_child(name)
 802         child.set_parent(self, name)
 803         self._children[name] = child
 804
 805     # Take SimObject-valued parameters that haven't been explicitly
 806     # assigned as children and make them children of the object that
 807     # they were assigned to as a parameter value.  This guarantees
 808     # that when we instantiate all the parameter objects we're still
 809     # inside the configuration hierarchy.
 810     def adoptOrphanParams(self):
 811         for key,val in self._values.iteritems():
 812             if not isSimObjectVector(val) and isSimObjectSequence(val):
 813                 # need to convert raw SimObject sequences to
 814                 # SimObjectVector class so we can call has_parent()
 815                 val = SimObjectVector(val)
 816                 self._values[key] = val
 817             if isSimObjectOrVector(val) and not val.has_parent():
 818                 print "warning: %s adopting orphan SimObject param '%s'" \
 819                       % (self, key)
 820                 self.add_child(key, val)
 821
 822     def path(self):
 823         if not self._parent:
 824             return '<orphan %s>' % self.__class__
 825         ppath = self._parent.path()
 826         if ppath == 'root':
 827             return self._name
 828         return ppath + "." + self._name
 829
 830     def __str__(self):
 831         return self.path()
 832
 833     def ini_str(self):
 834         return self.path()
 835
 836     def find_any(self, ptype):
 837         if isinstance(self, ptype):
 838             return self, True
 839
 840         found_obj = None
 841         for child in self._children.itervalues():
 842             if isinstance(child, ptype):
 843                 if found_obj != None and child != found_obj:
 844                     raise AttributeError, \
 845                           'parent.any matched more than one: %s %s' % \
 846                           (found_obj.path, child.path)
 847                 found_obj = child
 848         # search param space
 849         for pname,pdesc in self._params.iteritems():
 850             if issubclass(pdesc.ptype, ptype):
 851                 match_obj = self._values[pname]
 852                 if found_obj != None and found_obj != match_obj:
 853                     raise AttributeError, \
 854                           'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path)
 855                 found_obj = match_obj
 856         return found_obj, found_obj != None
 857
 858     def find_all(self, ptype):
 859         all = {}
 860         # search children
 861         for child in self._children.itervalues():
 862             if isinstance(child, ptype) and not isproxy(child) and \
 863                not isNullPointer(child):
 864                 all[child] = True
 865             if isSimObject(child):
 866                 # also add results from the child itself
 867                 child_all, done = child.find_all(ptype)
 868                 all.update(dict(zip(child_all, [done] * len(child_all))))
 869         # search param space
 870         for pname,pdesc in self._params.iteritems():
 871             if issubclass(pdesc.ptype, ptype):
 872                 match_obj = self._values[pname]
 873                 if not isproxy(match_obj) and not isNullPointer(match_obj):
 874                     all[match_obj] = True
 875         return all.keys(), True
 876
 877     def unproxy(self, base):
 878         return self
 879
 880     def unproxyParams(self):
 881         for param in self._params.iterkeys():
 882             value = self._values.get(param)
 883             if value != None and isproxy(value):
 884                 try:
 885                     value = value.unproxy(self)
 886                 except:
 887                     print "Error in unproxying param '%s' of %s" % \
 888                           (param, self.path())
 889                     raise
 890                 setattr(self, param, value)
 891
 892         # Unproxy ports in sorted order so that 'append' operations on
 893         # vector ports are done in a deterministic fashion.
 894         port_names = self._ports.keys()
 895         port_names.sort()
 896         for port_name in port_names:
 897             port = self._port_refs.get(port_name)
 898             if port != None:
 899                 port.unproxy(self)
 900
 901     def print_ini(self, ini_file):
 902         print >>ini_file, '[' + self.path() + ']'       # .ini section header
 903
 904         instanceDict[self.path()] = self
 905
 906         if hasattr(self, 'type'):
 907             print >>ini_file, 'type=%s' % self.type
 908
 909         if len(self._children.keys()):
 910             print >>ini_file, 'children=%s' % \
 911                   ' '.join(self._children[n].get_name() \
 912                   for n in sorted(self._children.keys()))
 913
 914         for param in sorted(self._params.keys()):
 915             value = self._values.get(param)
 916             if value != None:
 917                 print >>ini_file, '%s=%s' % (param,
 918                                              self._values[param].ini_str())
 919
 920         for port_name in sorted(self._ports.keys()):
 921             port = self._port_refs.get(port_name, None)
 922             if port != None:
 923                 print >>ini_file, '%s=%s' % (port_name, port.ini_str())
 924
 925         print >>ini_file        # blank line between objects
 926
 927     # generate a tree of dictionaries expressing all the parameters in the
 928     # instantiated system for use by scripts that want to do power, thermal
 929     # visualization, and other similar tasks
 930     def get_config_as_dict(self):
 931         d = attrdict()
 932         if hasattr(self, 'type'):
 933             d.type = self.type
 934         if hasattr(self, 'cxx_class'):
 935             d.cxx_class = self.cxx_class
 936         # Add the name and path of this object to be able to link to
 937         # the stats
 938         d.name = self.get_name()
 939         d.path = self.path()
 940
 941         for param in sorted(self._params.keys()):
 942             value = self._values.get(param)
 943             if value != None:
 944                 try:
 945                     # Use native type for those supported by JSON and
 946                     # strings for everything else. skipkeys=True seems
 947                     # to not work as well as one would hope
 948                     if type(self._values[param].value) in \
 949                             [str, unicode, int, long, float, bool, None]:
 950                         d[param] = self._values[param].value
 951                     else:
 952                         d[param] = str(self._values[param])
 953
 954                 except AttributeError:
 955                     pass
 956
 957         for n in sorted(self._children.keys()):
 958             child = self._children[n]
 959             # Use the name of the attribute (and not get_name()) as
 960             # the key in the JSON dictionary to capture the hierarchy
 961             # in the Python code that assembled this system
 962             d[n] = child.get_config_as_dict()
 963
 964         for port_name in sorted(self._ports.keys()):
 965             port = self._port_refs.get(port_name, None)
 966             if port != None:
 967                 # Represent each port with a dictionary containing the
 968                 # prominent attributes
 969                 d[port_name] = port.get_config_as_dict()
 970
 971         return d
 972
 973     def getCCParams(self):
 974         if self._ccParams:
 975             return self._ccParams
 976
 977         cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type)
 978         cc_params = cc_params_struct()
 979         cc_params.pyobj = self
 980         cc_params.name = str(self)
 981
 982         param_names = self._params.keys()
 983         param_names.sort()
 984         for param in param_names:
 985             value = self._values.get(param)
 986             if value is None:
 987                 fatal("%s.%s without default or user set value",
 988                       self.path(), param)
 989
 990             value = value.getValue()
 991             if isinstance(self._params[param], VectorParamDesc):
 992                 assert isinstance(value, list)
 993                 vec = getattr(cc_params, param)
 994                 assert not len(vec)
 995                 for v in value:
 996                     vec.append(v)
 997             else:
 998                 setattr(cc_params, param, value)
 999
1000         port_names = self._ports.keys()
1001         port_names.sort()
1002         for port_name in port_names:
1003             port = self._port_refs.get(port_name, None)
1004             if port != None:
1005                 port_count = len(port)
1006             else:
1007                 port_count = 0
1008             setattr(cc_params, 'port_' + port_name + '_connection_count',
1009                     port_count)
1010         self._ccParams = cc_params
1011         return self._ccParams
1012
1013     # Get C++ object corresponding to this object, calling C++ if
1014     # necessary to construct it.  Does *not* recursively create
1015     # children.
1016     def getCCObject(self):
1017         if not self._ccObject:
1018             # Make sure this object is in the configuration hierarchy
1019             if not self._parent and not isRoot(self):
1020                 raise RuntimeError, "Attempt to instantiate orphan node"
1021             # Cycles in the configuration hierarchy are not supported. This
1022             # will catch the resulting recursion and stop.
1023             self._ccObject = -1
1024             params = self.getCCParams()
1025             self._ccObject = params.create()
1026         elif self._ccObject == -1:
1027             raise RuntimeError, "%s: Cycle found in configuration hierarchy." \
1028                   % self.path()
1029         return self._ccObject
1030
1031     def descendants(self):
1032         yield self
1033         for child in self._children.itervalues():
1034             for obj in child.descendants():
1035                 yield obj
1036
1037     # Call C++ to create C++ object corresponding to this object
1038     def createCCObject(self):
1039         self.getCCParams()
1040         self.getCCObject() # force creation
1041
1042     def getValue(self):
1043         return self.getCCObject()
1044
1045     # Create C++ port connections corresponding to the connections in
1046     # _port_refs
1047     def connectPorts(self):
1048         for portRef in self._port_refs.itervalues():
1049             portRef.ccConnect()
1050
1051 # Function to provide to C++ so it can look up instances based on paths
1052 def resolveSimObject(name):
1053     obj = instanceDict[name]
1054     return obj.getCCObject()
1055
1056 def isSimObject(value):
1057     return isinstance(value, SimObject)
1058
1059 def isSimObjectClass(value):
1060     return issubclass(value, SimObject)
1061
1062 def isSimObjectVector(value):
1063     return isinstance(value, SimObjectVector)
1064
1065 def isSimObjectSequence(value):
1066     if not isinstance(value, (list, tuple)) or len(value) == 0:
1067         return False
1068
1069     for val in value:
1070         if not isNullPointer(val) and not isSimObject(val):
1071             return False
1072
1073     return True
1074
1075 def isSimObjectOrSequence(value):
1076     return isSimObject(value) or isSimObjectSequence(value)
1077
1078 def isRoot(obj):
1079     from m5.objects import Root
1080     return obj and obj is Root.getInstance()
1081
1082 def isSimObjectOrVector(value):
1083     return isSimObject(value) or isSimObjectVector(value)
1084
1085 def tryAsSimObjectOrVector(value):
1086     if isSimObjectOrVector(value):
1087         return value
1088     if isSimObjectSequence(value):
1089         return SimObjectVector(value)
1090     return None
1091
1092 def coerceSimObjectOrVector(value):
1093     value = tryAsSimObjectOrVector(value)
1094     if value is None:
1095         raise TypeError, "SimObject or SimObjectVector expected"
1096     return value
1097
1098 baseClasses = allClasses.copy()
1099 baseInstances = instanceDict.copy()
1100
1101 def clear():
1102     global allClasses, instanceDict
1103
1104     allClasses = baseClasses.copy()
1105     instanceDict = baseInstances.copy()
1106
1107 # __all__ defines the list of symbols that get exported when
1108 # 'from config import *' is invoked.  Try to keep this reasonably
1109 # short to avoid polluting other namespaces.
1110 __all__ = [ 'SimObject' ]