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