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