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
47try:
48 import pydot
49except:
50 pydot = False
51
52import m5
53from m5.util import *
54
55# Have to import params up top since Param is referenced on initial
56# load (when SimObject class references Param to create a class
57# variable, the 'name' param)...
58from m5.params import *
59# There are a few things we need that aren't in params.__all__ since
60# normal users don't need them
61from m5.params import ParamDesc, VectorParamDesc, \
62 isNullPointer, SimObjectVector, Port
63
64from m5.proxy import *
65from m5.proxy import isproxy
66
67#####################################################################
68#
69# M5 Python Configuration Utility
70#
71# The basic idea is to write simple Python programs that build Python
72# objects corresponding to M5 SimObjects for the desired simulation
73# configuration. For now, the Python emits a .ini file that can be
74# parsed by M5. In the future, some tighter integration between M5
75# and the Python interpreter may allow bypassing the .ini file.
76#
77# Each SimObject class in M5 is represented by a Python class with the
78# same name. The Python inheritance tree mirrors the M5 C++ tree
79# (e.g., SimpleCPU derives from BaseCPU in both cases, and all
80# SimObjects inherit from a single SimObject base class). To specify
81# an instance of an M5 SimObject in a configuration, the user simply
82# instantiates the corresponding Python object. The parameters for
83# that SimObject are given by assigning to attributes of the Python
84# object, either using keyword assignment in the constructor or in
85# separate assignment statements. For example:
86#
87# cache = BaseCache(size='64KB')
88# cache.hit_latency = 3
89# cache.assoc = 8
90#
91# The magic lies in the mapping of the Python attributes for SimObject
92# classes to the actual SimObject parameter specifications. This
93# allows parameter validity checking in the Python code. Continuing
94# the example above, the statements "cache.blurfl=3" or
95# "cache.assoc='hello'" would both result in runtime errors in Python,
96# since the BaseCache object has no 'blurfl' parameter and the 'assoc'
97# parameter requires an integer, respectively. This magic is done
98# primarily by overriding the special __setattr__ method that controls
99# assignment to object attributes.
100#
101# Once a set of Python objects have been instantiated in a hierarchy,
102# calling 'instantiate(obj)' (where obj is the root of the hierarchy)
103# will generate a .ini file.
104#
105#####################################################################
106
107# list of all SimObject classes
108allClasses = {}
109
110# dict to look up SimObjects based on path
111instanceDict = {}
112
113def public_value(key, value):
114 return key.startswith('_') or \
115 isinstance(value, (FunctionType, MethodType, ModuleType,
116 classmethod, type))
117
118# The metaclass for SimObject. This class controls how new classes
119# that derive from SimObject are instantiated, and provides inherited
120# class behavior (just like a class controls how instances of that
121# class are instantiated, and provides inherited instance behavior).
122class MetaSimObject(type):
123 # Attributes that can be set only at initialization time
124 init_keywords = { 'abstract' : bool,
125 'cxx_class' : str,
126 'cxx_type' : str,
127 'type' : str }
128 # Attributes that can be set any time
129 keywords = { 'check' : FunctionType }
130
131 # __new__ is called before __init__, and is where the statements
132 # in the body of the class definition get loaded into the class's
133 # __dict__. We intercept this to filter out parameter & port assignments
134 # and only allow "private" attributes to be passed to the base
135 # __new__ (starting with underscore).
136 def __new__(mcls, name, bases, dict):
137 assert name not in allClasses, "SimObject %s already present" % name
138
139 # Copy "private" attributes, functions, and classes to the
140 # official dict. Everything else goes in _init_dict to be
141 # filtered in __init__.
142 cls_dict = {}
143 value_dict = {}
144 for key,val in dict.items():
145 if public_value(key, val):
146 cls_dict[key] = val
147 else:
148 # must be a param/port setting
149 value_dict[key] = val
150 if 'abstract' not in value_dict:
151 value_dict['abstract'] = False
152 cls_dict['_value_dict'] = value_dict
153 cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict)
154 if 'type' in value_dict:
155 allClasses[name] = cls
156 return cls
157
158 # subclass initialization
159 def __init__(cls, name, bases, dict):
160 # calls type.__init__()... I think that's a no-op, but leave
161 # it here just in case it's not.
162 super(MetaSimObject, cls).__init__(name, bases, dict)
163
164 # initialize required attributes
165
166 # class-only attributes
167 cls._params = multidict() # param descriptions
168 cls._ports = multidict() # port descriptions
169
170 # class or instance attributes
171 cls._values = multidict() # param values
172 cls._children = multidict() # SimObject children
173 cls._port_refs = multidict() # port ref objects
174 cls._instantiated = False # really instantiated, cloned, or subclassed
175
176 # We don't support multiple inheritance. If you want to, you
177 # must fix multidict to deal with it properly.
178 if len(bases) > 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 code()
413
414 for param in params:
415 param.swig_predecls(code)
416 cls.export_method_swig_predecls(code)
417
418 code()
419 if cls._base:
420 code('%import "python/m5/internal/param_${{cls._base}}.i"')
421 code()
422
423 for ns in namespaces:
424 code('namespace $ns {')
425
426 if namespaces:
427 code('// avoid name conflicts')
428 sep_string = '_COLONS_'
429 flat_name = sep_string.join(class_path)
430 code('%rename($flat_name) $classname;')
431
432 code()
433 code('// stop swig from creating/wrapping default ctor/dtor')
434 code('%nodefault $classname;')
435 code('class $classname')
436 if cls._base:
437 code(' : public ${{cls._base.cxx_class}}')
438 code('{')
439 code(' public:')
440 cls.export_methods(code)
441 code('};')
442
443 for ns in reversed(namespaces):
444 code('} // namespace $ns')
445
446 code()
447 code('%include "params/$cls.hh"')
448
449
450 # Generate the C++ declaration (.hh file) for this SimObject's
451 # param struct. Called from src/SConscript.
452 def cxx_param_decl(cls, code):
453 # The 'local' attribute restricts us to the params declared in
454 # the object itself, not including inherited params (which
455 # will also be inherited from the base class's param struct
456 # here).
457 params = cls._params.local.values()
458 ports = cls._ports.local
459 try:
460 ptypes = [p.ptype for p in params]
461 except:
462 print cls, p, p.ptype_str
463 print params
464 raise
465
466 class_path = cls._value_dict['cxx_class'].split('::')
467
468 code('''\
469#ifndef __PARAMS__${cls}__
470#define __PARAMS__${cls}__
471
472''')
473
474 # A forward class declaration is sufficient since we are just
475 # declaring a pointer.
476 for ns in class_path[:-1]:
477 code('namespace $ns {')
478 code('class $0;', class_path[-1])
479 for ns in reversed(class_path[:-1]):
480 code('} // namespace $ns')
481 code()
482
483 # The base SimObject has a couple of params that get
484 # automatically set from Python without being declared through
485 # the normal Param mechanism; we slip them in here (needed
486 # predecls now, actual declarations below)
487 if cls == SimObject:
488 code('''
489#ifndef PY_VERSION
490struct PyObject;
491#endif
492
493#include <string>
494
495class EventQueue;
496''')
497 for param in params:
498 param.cxx_predecls(code)
499 for port in ports.itervalues():
500 port.cxx_predecls(code)
501 code()
502
503 if cls._base:
504 code('#include "params/${{cls._base.type}}.hh"')
505 code()
506
507 for ptype in ptypes:
508 if issubclass(ptype, Enum):
509 code('#include "enums/${{ptype.__name__}}.hh"')
510 code()
511
512 # now generate the actual param struct
513 code("struct ${cls}Params")
514 if cls._base:
515 code(" : public ${{cls._base.type}}Params")
516 code("{")
517 if not hasattr(cls, 'abstract') or not cls.abstract:
518 if 'type' in cls.__dict__:
519 code(" ${{cls.cxx_type}} create();")
520
521 code.indent()
522 if cls == SimObject:
523 code('''
524 SimObjectParams()
525 {
526 extern EventQueue mainEventQueue;
527 eventq = &mainEventQueue;
528 }
529 virtual ~SimObjectParams() {}
530
531 std::string name;
532 PyObject *pyobj;
533 EventQueue *eventq;
534 ''')
535 for param in params:
536 param.cxx_decl(code)
537 for port in ports.itervalues():
538 port.cxx_decl(code)
539
540 code.dedent()
541 code('};')
542
543 code()
544 code('#endif // __PARAMS__${cls}__')
545 return code
546
547
548
549# The SimObject class is the root of the special hierarchy. Most of
550# the code in this class deals with the configuration hierarchy itself
551# (parent/child node relationships).
552class SimObject(object):
553 # Specify metaclass. Any class inheriting from SimObject will
554 # get this metaclass.
555 __metaclass__ = MetaSimObject
556 type = 'SimObject'
557 abstract = True
558
559 @classmethod
560 def export_method_cxx_predecls(cls, code):
561 code('''
562#include <Python.h>
563
564#include "sim/serialize.hh"
565#include "sim/sim_object.hh"
566''')
567
568 @classmethod
569 def export_method_swig_predecls(cls, code):
570 code('''
571%include <std_string.i>
572''')
573
574 @classmethod
575 def export_methods(cls, code):
576 code('''
577 enum State {
578 Running,
579 Draining,
580 Drained
581 };
582
583 void init();
584 void loadState(Checkpoint *cp);
585 void initState();
586 void regStats();
587 void regFormulas();
588 void resetStats();
589 void startup();
590
591 unsigned int drain(Event *drain_event);
592 void resume();
593 void switchOut();
594 void takeOverFrom(BaseCPU *cpu);
595''')
596
597 # Initialize new instance. For objects with SimObject-valued
598 # children, we need to recursively clone the classes represented
599 # by those param values as well in a consistent "deep copy"-style
600 # fashion. That is, we want to make sure that each instance is
601 # cloned only once, and that if there are multiple references to
602 # the same original object, we end up with the corresponding
603 # cloned references all pointing to the same cloned instance.
604 def __init__(self, **kwargs):
605 ancestor = kwargs.get('_ancestor')
606 memo_dict = kwargs.get('_memo')
607 if memo_dict is None:
608 # prepare to memoize any recursively instantiated objects
609 memo_dict = {}
610 elif ancestor:
611 # memoize me now to avoid problems with recursive calls
612 memo_dict[ancestor] = self
613
614 if not ancestor:
615 ancestor = self.__class__
616 ancestor._instantiated = True
617
618 # initialize required attributes
619 self._parent = None
620 self._name = None
621 self._ccObject = None # pointer to C++ object
622 self._ccParams = None
623 self._instantiated = False # really "cloned"
624
625 # Clone children specified at class level. No need for a
626 # multidict here since we will be cloning everything.
627 # Do children before parameter values so that children that
628 # are also param values get cloned properly.
629 self._children = {}
630 for key,val in ancestor._children.iteritems():
631 self.add_child(key, val(_memo=memo_dict))
632
633 # Inherit parameter values from class using multidict so
634 # individual value settings can be overridden but we still
635 # inherit late changes to non-overridden class values.
636 self._values = multidict(ancestor._values)
637 # clone SimObject-valued parameters
638 for key,val in ancestor._values.iteritems():
639 val = tryAsSimObjectOrVector(val)
640 if val is not None:
641 self._values[key] = val(_memo=memo_dict)
642
643 # clone port references. no need to use a multidict here
644 # since we will be creating new references for all ports.
645 self._port_refs = {}
646 for key,val in ancestor._port_refs.iteritems():
647 self._port_refs[key] = val.clone(self, memo_dict)
648 # apply attribute assignments from keyword args, if any
649 for key,val in kwargs.iteritems():
650 setattr(self, key, val)
651
652 # "Clone" the current instance by creating another instance of
653 # this instance's class, but that inherits its parameter values
654 # and port mappings from the current instance. If we're in a
655 # "deep copy" recursive clone, check the _memo dict to see if
656 # we've already cloned this instance.
657 def __call__(self, **kwargs):
658 memo_dict = kwargs.get('_memo')
659 if memo_dict is None:
660 # no memo_dict: must be top-level clone operation.
661 # this is only allowed at the root of a hierarchy
662 if self._parent:
663 raise RuntimeError, "attempt to clone object %s " \
664 "not at the root of a tree (parent = %s)" \
665 % (self, self._parent)
666 # create a new dict and use that.
667 memo_dict = {}
668 kwargs['_memo'] = memo_dict
669 elif memo_dict.has_key(self):
670 # clone already done & memoized
671 return memo_dict[self]
672 return self.__class__(_ancestor = self, **kwargs)
673
674 def _get_port_ref(self, attr):
675 # Return reference that can be assigned to another port
676 # via __setattr__. There is only ever one reference
677 # object per port, but we create them lazily here.
678 ref = self._port_refs.get(attr)
679 if not ref:
680 ref = self._ports[attr].makeRef(self)
681 self._port_refs[attr] = ref
682 return ref
683
684 def __getattr__(self, attr):
685 if self._ports.has_key(attr):
686 return self._get_port_ref(attr)
687
688 if self._values.has_key(attr):
689 return self._values[attr]
690
691 if self._children.has_key(attr):
692 return self._children[attr]
693
694 # If the attribute exists on the C++ object, transparently
695 # forward the reference there. This is typically used for
696 # SWIG-wrapped methods such as init(), regStats(),
697 # regFormulas(), resetStats(), startup(), drain(), and
698 # resume().
699 if self._ccObject and hasattr(self._ccObject, attr):
700 return getattr(self._ccObject, attr)
701
702 raise AttributeError, "object '%s' has no attribute '%s'" \
703 % (self.__class__.__name__, attr)
704
705 # Set attribute (called on foo.attr = value when foo is an
706 # instance of class cls).
707 def __setattr__(self, attr, value):
708 # normal processing for private attributes
709 if attr.startswith('_'):
710 object.__setattr__(self, attr, value)
711 return
712
713 if self._ports.has_key(attr):
714 # set up port connection
715 self._get_port_ref(attr).connect(value)
716 return
717
718 if isSimObjectOrSequence(value) and self._instantiated:
719 raise RuntimeError, \
720 "cannot set SimObject parameter '%s' after\n" \
721 " instance been cloned %s" % (attr, `self`)
722
723 param = self._params.get(attr)
724 if param:
725 try:
726 value = param.convert(value)
727 except Exception, e:
728 msg = "%s\nError setting param %s.%s to %s\n" % \
729 (e, self.__class__.__name__, attr, value)
730 e.args = (msg, )
731 raise
732 self._values[attr] = value
733 # implicitly parent unparented objects assigned as params
734 if isSimObjectOrVector(value) and not value.has_parent():
735 self.add_child(attr, value)
736 return
737
738 # if RHS is a SimObject, it's an implicit child assignment
739 if isSimObjectOrSequence(value):
740 self.add_child(attr, value)
741 return
742
743 # no valid assignment... raise exception
744 raise AttributeError, "Class %s has no parameter %s" \
745 % (self.__class__.__name__, attr)
746
747
748 # this hack allows tacking a '[0]' onto parameters that may or may
749 # not be vectors, and always getting the first element (e.g. cpus)
750 def __getitem__(self, key):
751 if key == 0:
752 return self
753 raise TypeError, "Non-zero index '%s' to SimObject" % key
754
755 # Also implemented by SimObjectVector
756 def clear_parent(self, old_parent):
757 assert self._parent is old_parent
758 self._parent = None
759
760 # Also implemented by SimObjectVector
761 def set_parent(self, parent, name):
762 self._parent = parent
763 self._name = name
764
765 # Also implemented by SimObjectVector
766 def get_name(self):
767 return self._name
768
769 # Also implemented by SimObjectVector
770 def has_parent(self):
771 return self._parent is not None
772
773 # clear out child with given name. This code is not likely to be exercised.
774 # See comment in add_child.
775 def clear_child(self, name):
776 child = self._children[name]
777 child.clear_parent(self)
778 del self._children[name]
779
780 # Add a new child to this object.
781 def add_child(self, name, child):
782 child = coerceSimObjectOrVector(child)
783 if child.has_parent():
784 print "warning: add_child('%s'): child '%s' already has parent" % \
785 (name, child.get_name())
786 if self._children.has_key(name):
787 # This code path had an undiscovered bug that would make it fail
788 # at runtime. It had been here for a long time and was only
789 # exposed by a buggy script. Changes here will probably not be
790 # exercised without specialized testing.
791 self.clear_child(name)
792 child.set_parent(self, name)
793 self._children[name] = child
794
795 # Take SimObject-valued parameters that haven't been explicitly
796 # assigned as children and make them children of the object that
797 # they were assigned to as a parameter value. This guarantees
798 # that when we instantiate all the parameter objects we're still
799 # inside the configuration hierarchy.
800 def adoptOrphanParams(self):
801 for key,val in self._values.iteritems():
802 if not isSimObjectVector(val) and isSimObjectSequence(val):
803 # need to convert raw SimObject sequences to
804 # SimObjectVector class so we can call has_parent()
805 val = SimObjectVector(val)
806 self._values[key] = val
807 if isSimObjectOrVector(val) and not val.has_parent():
808 print "warning: %s adopting orphan SimObject param '%s'" \
809 % (self, key)
810 self.add_child(key, val)
811
812 def path(self):
813 if not self._parent:
814 return '<orphan %s>' % self.__class__
815 ppath = self._parent.path()
816 if ppath == 'root':
817 return self._name
818 return ppath + "." + self._name
819
820 def __str__(self):
821 return self.path()
822
823 def ini_str(self):
824 return self.path()
825
826 def find_any(self, ptype):
827 if isinstance(self, ptype):
828 return self, True
829
830 found_obj = None
831 for child in self._children.itervalues():
832 if isinstance(child, ptype):
833 if found_obj != None and child != found_obj:
834 raise AttributeError, \
835 'parent.any matched more than one: %s %s' % \
836 (found_obj.path, child.path)
837 found_obj = child
838 # search param space
839 for pname,pdesc in self._params.iteritems():
840 if issubclass(pdesc.ptype, ptype):
841 match_obj = self._values[pname]
842 if found_obj != None and found_obj != match_obj:
843 raise AttributeError, \
844 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path)
845 found_obj = match_obj
846 return found_obj, found_obj != None
847
848 def find_all(self, ptype):
849 all = {}
850 # search children
851 for child in self._children.itervalues():
852 if isinstance(child, ptype) and not isproxy(child) and \
853 not isNullPointer(child):
854 all[child] = True
855 # search param space
856 for pname,pdesc in self._params.iteritems():
857 if issubclass(pdesc.ptype, ptype):
858 match_obj = self._values[pname]
859 if not isproxy(match_obj) and not isNullPointer(match_obj):
860 all[match_obj] = True
861 return all.keys(), True
862
863 def unproxy(self, base):
864 return self
865
866 def unproxyParams(self):
867 for param in self._params.iterkeys():
868 value = self._values.get(param)
869 if value != None and isproxy(value):
870 try:
871 value = value.unproxy(self)
872 except:
873 print "Error in unproxying param '%s' of %s" % \
874 (param, self.path())
875 raise
876 setattr(self, param, value)
877
878 # Unproxy ports in sorted order so that 'append' operations on
879 # vector ports are done in a deterministic fashion.
880 port_names = self._ports.keys()
881 port_names.sort()
882 for port_name in port_names:
883 port = self._port_refs.get(port_name)
884 if port != None:
885 port.unproxy(self)
886
887 def print_ini(self, ini_file):
888 print >>ini_file, '[' + self.path() + ']' # .ini section header
889
890 instanceDict[self.path()] = self
891
892 if hasattr(self, 'type'):
893 print >>ini_file, 'type=%s' % self.type
894
895 if len(self._children.keys()):
896 print >>ini_file, 'children=%s' % \
897 ' '.join(self._children[n].get_name() \
898 for n in sorted(self._children.keys()))
899
900 for param in sorted(self._params.keys()):
901 value = self._values.get(param)
902 if value != None:
903 print >>ini_file, '%s=%s' % (param,
904 self._values[param].ini_str())
905
906 for port_name in sorted(self._ports.keys()):
907 port = self._port_refs.get(port_name, None)
908 if port != None:
909 print >>ini_file, '%s=%s' % (port_name, port.ini_str())
910
911 print >>ini_file # blank line between objects
912
913 # generate a tree of dictionaries expressing all the parameters in the
914 # instantiated system for use by scripts that want to do power, thermal
915 # visualization, and other similar tasks
916 def get_config_as_dict(self):
917 d = attrdict()
918 if hasattr(self, 'type'):
919 d.type = self.type
920 if hasattr(self, 'cxx_class'):
921 d.cxx_class = self.cxx_class
922
923 for param in sorted(self._params.keys()):
924 value = self._values.get(param)
| 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
47try:
48 import pydot
49except:
50 pydot = False
51
52import m5
53from m5.util import *
54
55# Have to import params up top since Param is referenced on initial
56# load (when SimObject class references Param to create a class
57# variable, the 'name' param)...
58from m5.params import *
59# There are a few things we need that aren't in params.__all__ since
60# normal users don't need them
61from m5.params import ParamDesc, VectorParamDesc, \
62 isNullPointer, SimObjectVector, Port
63
64from m5.proxy import *
65from m5.proxy import isproxy
66
67#####################################################################
68#
69# M5 Python Configuration Utility
70#
71# The basic idea is to write simple Python programs that build Python
72# objects corresponding to M5 SimObjects for the desired simulation
73# configuration. For now, the Python emits a .ini file that can be
74# parsed by M5. In the future, some tighter integration between M5
75# and the Python interpreter may allow bypassing the .ini file.
76#
77# Each SimObject class in M5 is represented by a Python class with the
78# same name. The Python inheritance tree mirrors the M5 C++ tree
79# (e.g., SimpleCPU derives from BaseCPU in both cases, and all
80# SimObjects inherit from a single SimObject base class). To specify
81# an instance of an M5 SimObject in a configuration, the user simply
82# instantiates the corresponding Python object. The parameters for
83# that SimObject are given by assigning to attributes of the Python
84# object, either using keyword assignment in the constructor or in
85# separate assignment statements. For example:
86#
87# cache = BaseCache(size='64KB')
88# cache.hit_latency = 3
89# cache.assoc = 8
90#
91# The magic lies in the mapping of the Python attributes for SimObject
92# classes to the actual SimObject parameter specifications. This
93# allows parameter validity checking in the Python code. Continuing
94# the example above, the statements "cache.blurfl=3" or
95# "cache.assoc='hello'" would both result in runtime errors in Python,
96# since the BaseCache object has no 'blurfl' parameter and the 'assoc'
97# parameter requires an integer, respectively. This magic is done
98# primarily by overriding the special __setattr__ method that controls
99# assignment to object attributes.
100#
101# Once a set of Python objects have been instantiated in a hierarchy,
102# calling 'instantiate(obj)' (where obj is the root of the hierarchy)
103# will generate a .ini file.
104#
105#####################################################################
106
107# list of all SimObject classes
108allClasses = {}
109
110# dict to look up SimObjects based on path
111instanceDict = {}
112
113def public_value(key, value):
114 return key.startswith('_') or \
115 isinstance(value, (FunctionType, MethodType, ModuleType,
116 classmethod, type))
117
118# The metaclass for SimObject. This class controls how new classes
119# that derive from SimObject are instantiated, and provides inherited
120# class behavior (just like a class controls how instances of that
121# class are instantiated, and provides inherited instance behavior).
122class MetaSimObject(type):
123 # Attributes that can be set only at initialization time
124 init_keywords = { 'abstract' : bool,
125 'cxx_class' : str,
126 'cxx_type' : str,
127 'type' : str }
128 # Attributes that can be set any time
129 keywords = { 'check' : FunctionType }
130
131 # __new__ is called before __init__, and is where the statements
132 # in the body of the class definition get loaded into the class's
133 # __dict__. We intercept this to filter out parameter & port assignments
134 # and only allow "private" attributes to be passed to the base
135 # __new__ (starting with underscore).
136 def __new__(mcls, name, bases, dict):
137 assert name not in allClasses, "SimObject %s already present" % name
138
139 # Copy "private" attributes, functions, and classes to the
140 # official dict. Everything else goes in _init_dict to be
141 # filtered in __init__.
142 cls_dict = {}
143 value_dict = {}
144 for key,val in dict.items():
145 if public_value(key, val):
146 cls_dict[key] = val
147 else:
148 # must be a param/port setting
149 value_dict[key] = val
150 if 'abstract' not in value_dict:
151 value_dict['abstract'] = False
152 cls_dict['_value_dict'] = value_dict
153 cls = super(MetaSimObject, mcls).__new__(mcls, name, bases, cls_dict)
154 if 'type' in value_dict:
155 allClasses[name] = cls
156 return cls
157
158 # subclass initialization
159 def __init__(cls, name, bases, dict):
160 # calls type.__init__()... I think that's a no-op, but leave
161 # it here just in case it's not.
162 super(MetaSimObject, cls).__init__(name, bases, dict)
163
164 # initialize required attributes
165
166 # class-only attributes
167 cls._params = multidict() # param descriptions
168 cls._ports = multidict() # port descriptions
169
170 # class or instance attributes
171 cls._values = multidict() # param values
172 cls._children = multidict() # SimObject children
173 cls._port_refs = multidict() # port ref objects
174 cls._instantiated = False # really instantiated, cloned, or subclassed
175
176 # We don't support multiple inheritance. If you want to, you
177 # must fix multidict to deal with it properly.
178 if len(bases) > 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 code()
413
414 for param in params:
415 param.swig_predecls(code)
416 cls.export_method_swig_predecls(code)
417
418 code()
419 if cls._base:
420 code('%import "python/m5/internal/param_${{cls._base}}.i"')
421 code()
422
423 for ns in namespaces:
424 code('namespace $ns {')
425
426 if namespaces:
427 code('// avoid name conflicts')
428 sep_string = '_COLONS_'
429 flat_name = sep_string.join(class_path)
430 code('%rename($flat_name) $classname;')
431
432 code()
433 code('// stop swig from creating/wrapping default ctor/dtor')
434 code('%nodefault $classname;')
435 code('class $classname')
436 if cls._base:
437 code(' : public ${{cls._base.cxx_class}}')
438 code('{')
439 code(' public:')
440 cls.export_methods(code)
441 code('};')
442
443 for ns in reversed(namespaces):
444 code('} // namespace $ns')
445
446 code()
447 code('%include "params/$cls.hh"')
448
449
450 # Generate the C++ declaration (.hh file) for this SimObject's
451 # param struct. Called from src/SConscript.
452 def cxx_param_decl(cls, code):
453 # The 'local' attribute restricts us to the params declared in
454 # the object itself, not including inherited params (which
455 # will also be inherited from the base class's param struct
456 # here).
457 params = cls._params.local.values()
458 ports = cls._ports.local
459 try:
460 ptypes = [p.ptype for p in params]
461 except:
462 print cls, p, p.ptype_str
463 print params
464 raise
465
466 class_path = cls._value_dict['cxx_class'].split('::')
467
468 code('''\
469#ifndef __PARAMS__${cls}__
470#define __PARAMS__${cls}__
471
472''')
473
474 # A forward class declaration is sufficient since we are just
475 # declaring a pointer.
476 for ns in class_path[:-1]:
477 code('namespace $ns {')
478 code('class $0;', class_path[-1])
479 for ns in reversed(class_path[:-1]):
480 code('} // namespace $ns')
481 code()
482
483 # The base SimObject has a couple of params that get
484 # automatically set from Python without being declared through
485 # the normal Param mechanism; we slip them in here (needed
486 # predecls now, actual declarations below)
487 if cls == SimObject:
488 code('''
489#ifndef PY_VERSION
490struct PyObject;
491#endif
492
493#include <string>
494
495class EventQueue;
496''')
497 for param in params:
498 param.cxx_predecls(code)
499 for port in ports.itervalues():
500 port.cxx_predecls(code)
501 code()
502
503 if cls._base:
504 code('#include "params/${{cls._base.type}}.hh"')
505 code()
506
507 for ptype in ptypes:
508 if issubclass(ptype, Enum):
509 code('#include "enums/${{ptype.__name__}}.hh"')
510 code()
511
512 # now generate the actual param struct
513 code("struct ${cls}Params")
514 if cls._base:
515 code(" : public ${{cls._base.type}}Params")
516 code("{")
517 if not hasattr(cls, 'abstract') or not cls.abstract:
518 if 'type' in cls.__dict__:
519 code(" ${{cls.cxx_type}} create();")
520
521 code.indent()
522 if cls == SimObject:
523 code('''
524 SimObjectParams()
525 {
526 extern EventQueue mainEventQueue;
527 eventq = &mainEventQueue;
528 }
529 virtual ~SimObjectParams() {}
530
531 std::string name;
532 PyObject *pyobj;
533 EventQueue *eventq;
534 ''')
535 for param in params:
536 param.cxx_decl(code)
537 for port in ports.itervalues():
538 port.cxx_decl(code)
539
540 code.dedent()
541 code('};')
542
543 code()
544 code('#endif // __PARAMS__${cls}__')
545 return code
546
547
548
549# The SimObject class is the root of the special hierarchy. Most of
550# the code in this class deals with the configuration hierarchy itself
551# (parent/child node relationships).
552class SimObject(object):
553 # Specify metaclass. Any class inheriting from SimObject will
554 # get this metaclass.
555 __metaclass__ = MetaSimObject
556 type = 'SimObject'
557 abstract = True
558
559 @classmethod
560 def export_method_cxx_predecls(cls, code):
561 code('''
562#include <Python.h>
563
564#include "sim/serialize.hh"
565#include "sim/sim_object.hh"
566''')
567
568 @classmethod
569 def export_method_swig_predecls(cls, code):
570 code('''
571%include <std_string.i>
572''')
573
574 @classmethod
575 def export_methods(cls, code):
576 code('''
577 enum State {
578 Running,
579 Draining,
580 Drained
581 };
582
583 void init();
584 void loadState(Checkpoint *cp);
585 void initState();
586 void regStats();
587 void regFormulas();
588 void resetStats();
589 void startup();
590
591 unsigned int drain(Event *drain_event);
592 void resume();
593 void switchOut();
594 void takeOverFrom(BaseCPU *cpu);
595''')
596
597 # Initialize new instance. For objects with SimObject-valued
598 # children, we need to recursively clone the classes represented
599 # by those param values as well in a consistent "deep copy"-style
600 # fashion. That is, we want to make sure that each instance is
601 # cloned only once, and that if there are multiple references to
602 # the same original object, we end up with the corresponding
603 # cloned references all pointing to the same cloned instance.
604 def __init__(self, **kwargs):
605 ancestor = kwargs.get('_ancestor')
606 memo_dict = kwargs.get('_memo')
607 if memo_dict is None:
608 # prepare to memoize any recursively instantiated objects
609 memo_dict = {}
610 elif ancestor:
611 # memoize me now to avoid problems with recursive calls
612 memo_dict[ancestor] = self
613
614 if not ancestor:
615 ancestor = self.__class__
616 ancestor._instantiated = True
617
618 # initialize required attributes
619 self._parent = None
620 self._name = None
621 self._ccObject = None # pointer to C++ object
622 self._ccParams = None
623 self._instantiated = False # really "cloned"
624
625 # Clone children specified at class level. No need for a
626 # multidict here since we will be cloning everything.
627 # Do children before parameter values so that children that
628 # are also param values get cloned properly.
629 self._children = {}
630 for key,val in ancestor._children.iteritems():
631 self.add_child(key, val(_memo=memo_dict))
632
633 # Inherit parameter values from class using multidict so
634 # individual value settings can be overridden but we still
635 # inherit late changes to non-overridden class values.
636 self._values = multidict(ancestor._values)
637 # clone SimObject-valued parameters
638 for key,val in ancestor._values.iteritems():
639 val = tryAsSimObjectOrVector(val)
640 if val is not None:
641 self._values[key] = val(_memo=memo_dict)
642
643 # clone port references. no need to use a multidict here
644 # since we will be creating new references for all ports.
645 self._port_refs = {}
646 for key,val in ancestor._port_refs.iteritems():
647 self._port_refs[key] = val.clone(self, memo_dict)
648 # apply attribute assignments from keyword args, if any
649 for key,val in kwargs.iteritems():
650 setattr(self, key, val)
651
652 # "Clone" the current instance by creating another instance of
653 # this instance's class, but that inherits its parameter values
654 # and port mappings from the current instance. If we're in a
655 # "deep copy" recursive clone, check the _memo dict to see if
656 # we've already cloned this instance.
657 def __call__(self, **kwargs):
658 memo_dict = kwargs.get('_memo')
659 if memo_dict is None:
660 # no memo_dict: must be top-level clone operation.
661 # this is only allowed at the root of a hierarchy
662 if self._parent:
663 raise RuntimeError, "attempt to clone object %s " \
664 "not at the root of a tree (parent = %s)" \
665 % (self, self._parent)
666 # create a new dict and use that.
667 memo_dict = {}
668 kwargs['_memo'] = memo_dict
669 elif memo_dict.has_key(self):
670 # clone already done & memoized
671 return memo_dict[self]
672 return self.__class__(_ancestor = self, **kwargs)
673
674 def _get_port_ref(self, attr):
675 # Return reference that can be assigned to another port
676 # via __setattr__. There is only ever one reference
677 # object per port, but we create them lazily here.
678 ref = self._port_refs.get(attr)
679 if not ref:
680 ref = self._ports[attr].makeRef(self)
681 self._port_refs[attr] = ref
682 return ref
683
684 def __getattr__(self, attr):
685 if self._ports.has_key(attr):
686 return self._get_port_ref(attr)
687
688 if self._values.has_key(attr):
689 return self._values[attr]
690
691 if self._children.has_key(attr):
692 return self._children[attr]
693
694 # If the attribute exists on the C++ object, transparently
695 # forward the reference there. This is typically used for
696 # SWIG-wrapped methods such as init(), regStats(),
697 # regFormulas(), resetStats(), startup(), drain(), and
698 # resume().
699 if self._ccObject and hasattr(self._ccObject, attr):
700 return getattr(self._ccObject, attr)
701
702 raise AttributeError, "object '%s' has no attribute '%s'" \
703 % (self.__class__.__name__, attr)
704
705 # Set attribute (called on foo.attr = value when foo is an
706 # instance of class cls).
707 def __setattr__(self, attr, value):
708 # normal processing for private attributes
709 if attr.startswith('_'):
710 object.__setattr__(self, attr, value)
711 return
712
713 if self._ports.has_key(attr):
714 # set up port connection
715 self._get_port_ref(attr).connect(value)
716 return
717
718 if isSimObjectOrSequence(value) and self._instantiated:
719 raise RuntimeError, \
720 "cannot set SimObject parameter '%s' after\n" \
721 " instance been cloned %s" % (attr, `self`)
722
723 param = self._params.get(attr)
724 if param:
725 try:
726 value = param.convert(value)
727 except Exception, e:
728 msg = "%s\nError setting param %s.%s to %s\n" % \
729 (e, self.__class__.__name__, attr, value)
730 e.args = (msg, )
731 raise
732 self._values[attr] = value
733 # implicitly parent unparented objects assigned as params
734 if isSimObjectOrVector(value) and not value.has_parent():
735 self.add_child(attr, value)
736 return
737
738 # if RHS is a SimObject, it's an implicit child assignment
739 if isSimObjectOrSequence(value):
740 self.add_child(attr, value)
741 return
742
743 # no valid assignment... raise exception
744 raise AttributeError, "Class %s has no parameter %s" \
745 % (self.__class__.__name__, attr)
746
747
748 # this hack allows tacking a '[0]' onto parameters that may or may
749 # not be vectors, and always getting the first element (e.g. cpus)
750 def __getitem__(self, key):
751 if key == 0:
752 return self
753 raise TypeError, "Non-zero index '%s' to SimObject" % key
754
755 # Also implemented by SimObjectVector
756 def clear_parent(self, old_parent):
757 assert self._parent is old_parent
758 self._parent = None
759
760 # Also implemented by SimObjectVector
761 def set_parent(self, parent, name):
762 self._parent = parent
763 self._name = name
764
765 # Also implemented by SimObjectVector
766 def get_name(self):
767 return self._name
768
769 # Also implemented by SimObjectVector
770 def has_parent(self):
771 return self._parent is not None
772
773 # clear out child with given name. This code is not likely to be exercised.
774 # See comment in add_child.
775 def clear_child(self, name):
776 child = self._children[name]
777 child.clear_parent(self)
778 del self._children[name]
779
780 # Add a new child to this object.
781 def add_child(self, name, child):
782 child = coerceSimObjectOrVector(child)
783 if child.has_parent():
784 print "warning: add_child('%s'): child '%s' already has parent" % \
785 (name, child.get_name())
786 if self._children.has_key(name):
787 # This code path had an undiscovered bug that would make it fail
788 # at runtime. It had been here for a long time and was only
789 # exposed by a buggy script. Changes here will probably not be
790 # exercised without specialized testing.
791 self.clear_child(name)
792 child.set_parent(self, name)
793 self._children[name] = child
794
795 # Take SimObject-valued parameters that haven't been explicitly
796 # assigned as children and make them children of the object that
797 # they were assigned to as a parameter value. This guarantees
798 # that when we instantiate all the parameter objects we're still
799 # inside the configuration hierarchy.
800 def adoptOrphanParams(self):
801 for key,val in self._values.iteritems():
802 if not isSimObjectVector(val) and isSimObjectSequence(val):
803 # need to convert raw SimObject sequences to
804 # SimObjectVector class so we can call has_parent()
805 val = SimObjectVector(val)
806 self._values[key] = val
807 if isSimObjectOrVector(val) and not val.has_parent():
808 print "warning: %s adopting orphan SimObject param '%s'" \
809 % (self, key)
810 self.add_child(key, val)
811
812 def path(self):
813 if not self._parent:
814 return '<orphan %s>' % self.__class__
815 ppath = self._parent.path()
816 if ppath == 'root':
817 return self._name
818 return ppath + "." + self._name
819
820 def __str__(self):
821 return self.path()
822
823 def ini_str(self):
824 return self.path()
825
826 def find_any(self, ptype):
827 if isinstance(self, ptype):
828 return self, True
829
830 found_obj = None
831 for child in self._children.itervalues():
832 if isinstance(child, ptype):
833 if found_obj != None and child != found_obj:
834 raise AttributeError, \
835 'parent.any matched more than one: %s %s' % \
836 (found_obj.path, child.path)
837 found_obj = child
838 # search param space
839 for pname,pdesc in self._params.iteritems():
840 if issubclass(pdesc.ptype, ptype):
841 match_obj = self._values[pname]
842 if found_obj != None and found_obj != match_obj:
843 raise AttributeError, \
844 'parent.any matched more than one: %s and %s' % (found_obj.path, match_obj.path)
845 found_obj = match_obj
846 return found_obj, found_obj != None
847
848 def find_all(self, ptype):
849 all = {}
850 # search children
851 for child in self._children.itervalues():
852 if isinstance(child, ptype) and not isproxy(child) and \
853 not isNullPointer(child):
854 all[child] = True
855 # search param space
856 for pname,pdesc in self._params.iteritems():
857 if issubclass(pdesc.ptype, ptype):
858 match_obj = self._values[pname]
859 if not isproxy(match_obj) and not isNullPointer(match_obj):
860 all[match_obj] = True
861 return all.keys(), True
862
863 def unproxy(self, base):
864 return self
865
866 def unproxyParams(self):
867 for param in self._params.iterkeys():
868 value = self._values.get(param)
869 if value != None and isproxy(value):
870 try:
871 value = value.unproxy(self)
872 except:
873 print "Error in unproxying param '%s' of %s" % \
874 (param, self.path())
875 raise
876 setattr(self, param, value)
877
878 # Unproxy ports in sorted order so that 'append' operations on
879 # vector ports are done in a deterministic fashion.
880 port_names = self._ports.keys()
881 port_names.sort()
882 for port_name in port_names:
883 port = self._port_refs.get(port_name)
884 if port != None:
885 port.unproxy(self)
886
887 def print_ini(self, ini_file):
888 print >>ini_file, '[' + self.path() + ']' # .ini section header
889
890 instanceDict[self.path()] = self
891
892 if hasattr(self, 'type'):
893 print >>ini_file, 'type=%s' % self.type
894
895 if len(self._children.keys()):
896 print >>ini_file, 'children=%s' % \
897 ' '.join(self._children[n].get_name() \
898 for n in sorted(self._children.keys()))
899
900 for param in sorted(self._params.keys()):
901 value = self._values.get(param)
902 if value != None:
903 print >>ini_file, '%s=%s' % (param,
904 self._values[param].ini_str())
905
906 for port_name in sorted(self._ports.keys()):
907 port = self._port_refs.get(port_name, None)
908 if port != None:
909 print >>ini_file, '%s=%s' % (port_name, port.ini_str())
910
911 print >>ini_file # blank line between objects
912
913 # generate a tree of dictionaries expressing all the parameters in the
914 # instantiated system for use by scripts that want to do power, thermal
915 # visualization, and other similar tasks
916 def get_config_as_dict(self):
917 d = attrdict()
918 if hasattr(self, 'type'):
919 d.type = self.type
920 if hasattr(self, 'cxx_class'):
921 d.cxx_class = self.cxx_class
922
923 for param in sorted(self._params.keys()):
924 value = self._values.get(param)
|