SimObject.py revision 9100:3caf131d7a95
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 44import sys 45from types import FunctionType, MethodType, ModuleType 46 47import m5 48from 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)... 53from 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 56from m5.params import ParamDesc, VectorParamDesc, \ 57 isNullPointer, SimObjectVector, Port 58 59from m5.proxy import * 60from 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 103allClasses = {} 104 105# dict to look up SimObjects based on path 106instanceDict = {} 107 108def 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). 117class 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> 422using 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 503struct PyObject; 504#endif 505 506#include <string> 507 508class 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). 565class 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 regFormulas(); 601 void resetStats(); 602 void startup(); 603 604 unsigned int drain(Event *drain_event); 605 void resume(); 606 void switchOut(); 607 void takeOverFrom(BaseCPU *cpu); 608''') 609 610 # Initialize new instance. For objects with SimObject-valued 611 # children, we need to recursively clone the classes represented 612 # by those param values as well in a consistent "deep copy"-style 613 # fashion. That is, we want to make sure that each instance is 614 # cloned only once, and that if there are multiple references to 615 # the same original object, we end up with the corresponding 616 # cloned references all pointing to the same cloned instance. 617 def __init__(self, **kwargs): 618 ancestor = kwargs.get('_ancestor') 619 memo_dict = kwargs.get('_memo') 620 if memo_dict is None: 621 # prepare to memoize any recursively instantiated objects 622 memo_dict = {} 623 elif ancestor: 624 # memoize me now to avoid problems with recursive calls 625 memo_dict[ancestor] = self 626 627 if not ancestor: 628 ancestor = self.__class__ 629 ancestor._instantiated = True 630 631 # initialize required attributes 632 self._parent = None 633 self._name = None 634 self._ccObject = None # pointer to C++ object 635 self._ccParams = None 636 self._instantiated = False # really "cloned" 637 638 # Clone children specified at class level. No need for a 639 # multidict here since we will be cloning everything. 640 # Do children before parameter values so that children that 641 # are also param values get cloned properly. 642 self._children = {} 643 for key,val in ancestor._children.iteritems(): 644 self.add_child(key, val(_memo=memo_dict)) 645 646 # Inherit parameter values from class using multidict so 647 # individual value settings can be overridden but we still 648 # inherit late changes to non-overridden class values. 649 self._values = multidict(ancestor._values) 650 # clone SimObject-valued parameters 651 for key,val in ancestor._values.iteritems(): 652 val = tryAsSimObjectOrVector(val) 653 if val is not None: 654 self._values[key] = val(_memo=memo_dict) 655 656 # clone port references. no need to use a multidict here 657 # since we will be creating new references for all ports. 658 self._port_refs = {} 659 for key,val in ancestor._port_refs.iteritems(): 660 self._port_refs[key] = val.clone(self, memo_dict) 661 # apply attribute assignments from keyword args, if any 662 for key,val in kwargs.iteritems(): 663 setattr(self, key, val) 664 665 # "Clone" the current instance by creating another instance of 666 # this instance's class, but that inherits its parameter values 667 # and port mappings from the current instance. If we're in a 668 # "deep copy" recursive clone, check the _memo dict to see if 669 # we've already cloned this instance. 670 def __call__(self, **kwargs): 671 memo_dict = kwargs.get('_memo') 672 if memo_dict is None: 673 # no memo_dict: must be top-level clone operation. 674 # this is only allowed at the root of a hierarchy 675 if self._parent: 676 raise RuntimeError, "attempt to clone object %s " \ 677 "not at the root of a tree (parent = %s)" \ 678 % (self, self._parent) 679 # create a new dict and use that. 680 memo_dict = {} 681 kwargs['_memo'] = memo_dict 682 elif memo_dict.has_key(self): 683 # clone already done & memoized 684 return memo_dict[self] 685 return self.__class__(_ancestor = self, **kwargs) 686 687 def _get_port_ref(self, attr): 688 # Return reference that can be assigned to another port 689 # via __setattr__. There is only ever one reference 690 # object per port, but we create them lazily here. 691 ref = self._port_refs.get(attr) 692 if not ref: 693 ref = self._ports[attr].makeRef(self) 694 self._port_refs[attr] = ref 695 return ref 696 697 def __getattr__(self, attr): 698 if self._ports.has_key(attr): 699 return self._get_port_ref(attr) 700 701 if self._values.has_key(attr): 702 return self._values[attr] 703 704 if self._children.has_key(attr): 705 return self._children[attr] 706 707 # If the attribute exists on the C++ object, transparently 708 # forward the reference there. This is typically used for 709 # SWIG-wrapped methods such as init(), regStats(), 710 # regFormulas(), resetStats(), startup(), drain(), and 711 # resume(). 712 if self._ccObject and hasattr(self._ccObject, attr): 713 return getattr(self._ccObject, attr) 714 715 raise AttributeError, "object '%s' has no attribute '%s'" \ 716 % (self.__class__.__name__, attr) 717 718 # Set attribute (called on foo.attr = value when foo is an 719 # instance of class cls). 720 def __setattr__(self, attr, value): 721 # normal processing for private attributes 722 if attr.startswith('_'): 723 object.__setattr__(self, attr, value) 724 return 725 726 if self._ports.has_key(attr): 727 # set up port connection 728 self._get_port_ref(attr).connect(value) 729 return 730 731 if isSimObjectOrSequence(value) and self._instantiated: 732 raise RuntimeError, \ 733 "cannot set SimObject parameter '%s' after\n" \ 734 " instance been cloned %s" % (attr, `self`) 735 736 param = self._params.get(attr) 737 if param: 738 try: 739 value = param.convert(value) 740 except Exception, e: 741 msg = "%s\nError setting param %s.%s to %s\n" % \ 742 (e, self.__class__.__name__, attr, value) 743 e.args = (msg, ) 744 raise 745 self._values[attr] = value 746 # implicitly parent unparented objects assigned as params 747 if isSimObjectOrVector(value) and not value.has_parent(): 748 self.add_child(attr, value) 749 return 750 751 # if RHS is a SimObject, it's an implicit child assignment 752 if isSimObjectOrSequence(value): 753 self.add_child(attr, value) 754 return 755 756 # no valid assignment... raise exception 757 raise AttributeError, "Class %s has no parameter %s" \ 758 % (self.__class__.__name__, attr) 759 760 761 # this hack allows tacking a '[0]' onto parameters that may or may 762 # not be vectors, and always getting the first element (e.g. cpus) 763 def __getitem__(self, key): 764 if key == 0: 765 return self 766 raise TypeError, "Non-zero index '%s' to SimObject" % key 767 768 # Also implemented by SimObjectVector 769 def clear_parent(self, old_parent): 770 assert self._parent is old_parent 771 self._parent = None 772 773 # Also implemented by SimObjectVector 774 def set_parent(self, parent, name): 775 self._parent = parent 776 self._name = name 777 778 # Also implemented by SimObjectVector 779 def get_name(self): 780 return self._name 781 782 # Also implemented by SimObjectVector 783 def has_parent(self): 784 return self._parent is not None 785 786 # clear out child with given name. This code is not likely to be exercised. 787 # See comment in add_child. 788 def clear_child(self, name): 789 child = self._children[name] 790 child.clear_parent(self) 791 del self._children[name] 792 793 # Add a new child to this object. 794 def add_child(self, name, child): 795 child = coerceSimObjectOrVector(child) 796 if child.has_parent(): 797 print "warning: add_child('%s'): child '%s' already has parent" % \ 798 (name, child.get_name()) 799 if self._children.has_key(name): 800 # This code path had an undiscovered bug that would make it fail 801 # at runtime. It had been here for a long time and was only 802 # exposed by a buggy script. Changes here will probably not be 803 # exercised without specialized testing. 804 self.clear_child(name) 805 child.set_parent(self, name) 806 self._children[name] = child 807 808 # Take SimObject-valued parameters that haven't been explicitly 809 # assigned as children and make them children of the object that 810 # they were assigned to as a parameter value. This guarantees 811 # that when we instantiate all the parameter objects we're still 812 # inside the configuration hierarchy. 813 def adoptOrphanParams(self): 814 for key,val in self._values.iteritems(): 815 if not isSimObjectVector(val) and isSimObjectSequence(val): 816 # need to convert raw SimObject sequences to 817 # SimObjectVector class so we can call has_parent() 818 val = SimObjectVector(val) 819 self._values[key] = val 820 if isSimObjectOrVector(val) and not val.has_parent(): 821 print "warning: %s adopting orphan SimObject param '%s'" \ 822 % (self, key) 823 self.add_child(key, val) 824 825 def path(self): 826 if not self._parent: 827 return '<orphan %s>' % self.__class__ 828 ppath = self._parent.path() 829 if ppath == 'root': 830 return self._name 831 return ppath + "." + self._name 832 833 def __str__(self): 834 return self.path() 835 836 def ini_str(self): 837 return self.path() 838 839 def find_any(self, ptype): 840 if isinstance(self, ptype): 841 return self, True 842 843 found_obj = None 844 for child in self._children.itervalues(): 845 if isinstance(child, ptype): 846 if found_obj != None and child != found_obj: 847 raise AttributeError, \ 848 'parent.any matched more than one: %s %s' % \ 849 (found_obj.path, child.path) 850 found_obj = child 851 # search param space 852 for pname,pdesc in self._params.iteritems(): 853 if issubclass(pdesc.ptype, ptype): 854 match_obj = self._values[pname] 855 if found_obj != None and found_obj != match_obj: 856 raise AttributeError, \ 857 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path) 858 found_obj = match_obj 859 return found_obj, found_obj != None 860 861 def find_all(self, ptype): 862 all = {} 863 # search children 864 for child in self._children.itervalues(): 865 if isinstance(child, ptype) and not isproxy(child) and \ 866 not isNullPointer(child): 867 all[child] = True 868 if isSimObject(child): 869 # also add results from the child itself 870 child_all, done = child.find_all(ptype) 871 all.update(dict(zip(child_all, [done] * len(child_all)))) 872 # search param space 873 for pname,pdesc in self._params.iteritems(): 874 if issubclass(pdesc.ptype, ptype): 875 match_obj = self._values[pname] 876 if not isproxy(match_obj) and not isNullPointer(match_obj): 877 all[match_obj] = True 878 return all.keys(), True 879 880 def unproxy(self, base): 881 return self 882 883 def unproxyParams(self): 884 for param in self._params.iterkeys(): 885 value = self._values.get(param) 886 if value != None and isproxy(value): 887 try: 888 value = value.unproxy(self) 889 except: 890 print "Error in unproxying param '%s' of %s" % \ 891 (param, self.path()) 892 raise 893 setattr(self, param, value) 894 895 # Unproxy ports in sorted order so that 'append' operations on 896 # vector ports are done in a deterministic fashion. 897 port_names = self._ports.keys() 898 port_names.sort() 899 for port_name in port_names: 900 port = self._port_refs.get(port_name) 901 if port != None: 902 port.unproxy(self) 903 904 def print_ini(self, ini_file): 905 print >>ini_file, '[' + self.path() + ']' # .ini section header 906 907 instanceDict[self.path()] = self 908 909 if hasattr(self, 'type'): 910 print >>ini_file, 'type=%s' % self.type 911 912 if len(self._children.keys()): 913 print >>ini_file, 'children=%s' % \ 914 ' '.join(self._children[n].get_name() \ 915 for n in sorted(self._children.keys())) 916 917 for param in sorted(self._params.keys()): 918 value = self._values.get(param) 919 if value != None: 920 print >>ini_file, '%s=%s' % (param, 921 self._values[param].ini_str()) 922 923 for port_name in sorted(self._ports.keys()): 924 port = self._port_refs.get(port_name, None) 925 if port != None: 926 print >>ini_file, '%s=%s' % (port_name, port.ini_str()) 927 928 print >>ini_file # blank line between objects 929 930 # generate a tree of dictionaries expressing all the parameters in the 931 # instantiated system for use by scripts that want to do power, thermal 932 # visualization, and other similar tasks 933 def get_config_as_dict(self): 934 d = attrdict() 935 if hasattr(self, 'type'): 936 d.type = self.type 937 if hasattr(self, 'cxx_class'): 938 d.cxx_class = self.cxx_class 939 # Add the name and path of this object to be able to link to 940 # the stats 941 d.name = self.get_name() 942 d.path = self.path() 943 944 for param in sorted(self._params.keys()): 945 value = self._values.get(param) 946 if value != None: 947 try: 948 # Use native type for those supported by JSON and 949 # strings for everything else. skipkeys=True seems 950 # to not work as well as one would hope 951 if type(self._values[param].value) in \ 952 [str, unicode, int, long, float, bool, None]: 953 d[param] = self._values[param].value 954 else: 955 d[param] = str(self._values[param]) 956 957 except AttributeError: 958 pass 959 960 for n in sorted(self._children.keys()): 961 child = self._children[n] 962 # Use the name of the attribute (and not get_name()) as 963 # the key in the JSON dictionary to capture the hierarchy 964 # in the Python code that assembled this system 965 d[n] = child.get_config_as_dict() 966 967 for port_name in sorted(self._ports.keys()): 968 port = self._port_refs.get(port_name, None) 969 if port != None: 970 # Represent each port with a dictionary containing the 971 # prominent attributes 972 d[port_name] = port.get_config_as_dict() 973 974 return d 975 976 def getCCParams(self): 977 if self._ccParams: 978 return self._ccParams 979 980 cc_params_struct = getattr(m5.internal.params, '%sParams' % self.type) 981 cc_params = cc_params_struct() 982 cc_params.pyobj = self 983 cc_params.name = str(self) 984 985 param_names = self._params.keys() 986 param_names.sort() 987 for param in param_names: 988 value = self._values.get(param) 989 if value is None: 990 fatal("%s.%s without default or user set value", 991 self.path(), param) 992 993 value = value.getValue() 994 if isinstance(self._params[param], VectorParamDesc): 995 assert isinstance(value, list) 996 vec = getattr(cc_params, param) 997 assert not len(vec) 998 for v in value: 999 vec.append(v) 1000 else: 1001 setattr(cc_params, param, value) 1002 1003 port_names = self._ports.keys() 1004 port_names.sort() 1005 for port_name in port_names: 1006 port = self._port_refs.get(port_name, None) 1007 if port != None: 1008 port_count = len(port) 1009 else: 1010 port_count = 0 1011 setattr(cc_params, 'port_' + port_name + '_connection_count', 1012 port_count) 1013 self._ccParams = cc_params 1014 return self._ccParams 1015 1016 # Get C++ object corresponding to this object, calling C++ if 1017 # necessary to construct it. Does *not* recursively create 1018 # children. 1019 def getCCObject(self): 1020 if not self._ccObject: 1021 # Make sure this object is in the configuration hierarchy 1022 if not self._parent and not isRoot(self): 1023 raise RuntimeError, "Attempt to instantiate orphan node" 1024 # Cycles in the configuration hierarchy are not supported. This 1025 # will catch the resulting recursion and stop. 1026 self._ccObject = -1 1027 params = self.getCCParams() 1028 self._ccObject = params.create() 1029 elif self._ccObject == -1: 1030 raise RuntimeError, "%s: Cycle found in configuration hierarchy." \ 1031 % self.path() 1032 return self._ccObject 1033 1034 def descendants(self): 1035 yield self 1036 for child in self._children.itervalues(): 1037 for obj in child.descendants(): 1038 yield obj 1039 1040 # Call C++ to create C++ object corresponding to this object 1041 def createCCObject(self): 1042 self.getCCParams() 1043 self.getCCObject() # force creation 1044 1045 def getValue(self): 1046 return self.getCCObject() 1047 1048 # Create C++ port connections corresponding to the connections in 1049 # _port_refs 1050 def connectPorts(self): 1051 for portRef in self._port_refs.itervalues(): 1052 portRef.ccConnect() 1053 1054 def getMemoryMode(self): 1055 if not isinstance(self, m5.objects.System): 1056 return None 1057 1058 return self._ccObject.getMemoryMode() 1059 1060 def changeTiming(self, mode): 1061 if isinstance(self, m5.objects.System): 1062 # i don't know if there's a better way to do this - calling 1063 # setMemoryMode directly from self._ccObject results in calling 1064 # SimObject::setMemoryMode, not the System::setMemoryMode 1065 self._ccObject.setMemoryMode(mode) 1066 1067 def takeOverFrom(self, old_cpu): 1068 self._ccObject.takeOverFrom(old_cpu._ccObject) 1069 1070# Function to provide to C++ so it can look up instances based on paths 1071def resolveSimObject(name): 1072 obj = instanceDict[name] 1073 return obj.getCCObject() 1074 1075def isSimObject(value): 1076 return isinstance(value, SimObject) 1077 1078def isSimObjectClass(value): 1079 return issubclass(value, SimObject) 1080 1081def isSimObjectVector(value): 1082 return isinstance(value, SimObjectVector) 1083 1084def isSimObjectSequence(value): 1085 if not isinstance(value, (list, tuple)) or len(value) == 0: 1086 return False 1087 1088 for val in value: 1089 if not isNullPointer(val) and not isSimObject(val): 1090 return False 1091 1092 return True 1093 1094def isSimObjectOrSequence(value): 1095 return isSimObject(value) or isSimObjectSequence(value) 1096 1097def isRoot(obj): 1098 from m5.objects import Root 1099 return obj and obj is Root.getInstance() 1100 1101def isSimObjectOrVector(value): 1102 return isSimObject(value) or isSimObjectVector(value) 1103 1104def tryAsSimObjectOrVector(value): 1105 if isSimObjectOrVector(value): 1106 return value 1107 if isSimObjectSequence(value): 1108 return SimObjectVector(value) 1109 return None 1110 1111def coerceSimObjectOrVector(value): 1112 value = tryAsSimObjectOrVector(value) 1113 if value is None: 1114 raise TypeError, "SimObject or SimObjectVector expected" 1115 return value 1116 1117baseClasses = allClasses.copy() 1118baseInstances = instanceDict.copy() 1119 1120def clear(): 1121 global allClasses, instanceDict 1122 1123 allClasses = baseClasses.copy() 1124 instanceDict = baseInstances.copy() 1125 1126# __all__ defines the list of symbols that get exported when 1127# 'from config import *' is invoked. Try to keep this reasonably 1128# short to avoid polluting other namespaces. 1129__all__ = [ 'SimObject' ] 1130