9729fd30fe4243e7668870cda76b587424864389
1 # Copyright (c) 2004-2006 The Regents of The University of Michigan
2 # Copyright (c) 2010 Advanced Micro Devices, Inc.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are
7 # met: redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer;
9 # redistributions in binary form must reproduce the above copyright
10 # notice, this list of conditions and the following disclaimer in the
11 # documentation and/or other materials provided with the distribution;
12 # neither the name of the copyright holders nor the names of its
13 # contributors may be used to endorse or promote products derived from
14 # this software without specific prior written permission.
16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 # Authors: Steve Reinhardt
32 from types
import FunctionType
, MethodType
, ModuleType
42 # Have to import params up top since Param is referenced on initial
43 # load (when SimObject class references Param to create a class
44 # variable, the 'name' param)...
45 from m5
.params
import *
46 # There are a few things we need that aren't in params.__all__ since
47 # normal users don't need them
48 from m5
.params
import ParamDesc
, VectorParamDesc
, \
49 isNullPointer
, SimObjectVector
51 from m5
.proxy
import *
52 from m5
.proxy
import isproxy
54 #####################################################################
56 # M5 Python Configuration Utility
58 # The basic idea is to write simple Python programs that build Python
59 # objects corresponding to M5 SimObjects for the desired simulation
60 # configuration. For now, the Python emits a .ini file that can be
61 # parsed by M5. In the future, some tighter integration between M5
62 # and the Python interpreter may allow bypassing the .ini file.
64 # Each SimObject class in M5 is represented by a Python class with the
65 # same name. The Python inheritance tree mirrors the M5 C++ tree
66 # (e.g., SimpleCPU derives from BaseCPU in both cases, and all
67 # SimObjects inherit from a single SimObject base class). To specify
68 # an instance of an M5 SimObject in a configuration, the user simply
69 # instantiates the corresponding Python object. The parameters for
70 # that SimObject are given by assigning to attributes of the Python
71 # object, either using keyword assignment in the constructor or in
72 # separate assignment statements. For example:
74 # cache = BaseCache(size='64KB')
75 # cache.hit_latency = 3
78 # The magic lies in the mapping of the Python attributes for SimObject
79 # classes to the actual SimObject parameter specifications. This
80 # allows parameter validity checking in the Python code. Continuing
81 # the example above, the statements "cache.blurfl=3" or
82 # "cache.assoc='hello'" would both result in runtime errors in Python,
83 # since the BaseCache object has no 'blurfl' parameter and the 'assoc'
84 # parameter requires an integer, respectively. This magic is done
85 # primarily by overriding the special __setattr__ method that controls
86 # assignment to object attributes.
88 # Once a set of Python objects have been instantiated in a hierarchy,
89 # calling 'instantiate(obj)' (where obj is the root of the hierarchy)
90 # will generate a .ini file.
92 #####################################################################
94 # list of all SimObject classes
97 # dict to look up SimObjects based on path
100 def default_cxx_predecls(cls
, code
):
101 code('#include "params/$cls.hh"')
103 def default_swig_predecls(cls
, code
):
104 code('%import "python/m5/internal/param_$cls.i"')
106 def default_swig_objdecls(cls
, code
):
107 class_path
= cls
.cxx_class
.split('::')
108 classname
= class_path
[-1]
109 namespaces
= class_path
[:-1]
111 for ns
in namespaces
:
112 code('namespace $ns {')
115 code('// avoid name conflicts')
116 sep_string
= '_COLONS_'
117 flat_name
= sep_string
.join(class_path
)
118 code('%rename($flat_name) $classname;')
121 code('// stop swig from creating/wrapping default ctor/dtor')
122 code('%nodefault $classname;')
123 code('class $classname')
125 code(' : public ${{cls._base.cxx_class}}')
128 for ns
in reversed(namespaces
):
129 code('} // namespace $ns')
131 def public_value(key
, value
):
132 return key
.startswith('_') or \
133 isinstance(value
, (FunctionType
, MethodType
, ModuleType
,
136 # The metaclass for SimObject. This class controls how new classes
137 # that derive from SimObject are instantiated, and provides inherited
138 # class behavior (just like a class controls how instances of that
139 # class are instantiated, and provides inherited instance behavior).
140 class MetaSimObject(type):
141 # Attributes that can be set only at initialization time
142 init_keywords
= { 'abstract' : bool,
145 'cxx_predecls' : MethodType
,
146 'swig_objdecls' : MethodType
,
147 'swig_predecls' : MethodType
,
149 # Attributes that can be set any time
150 keywords
= { 'check' : FunctionType
}
152 # __new__ is called before __init__, and is where the statements
153 # in the body of the class definition get loaded into the class's
154 # __dict__. We intercept this to filter out parameter & port assignments
155 # and only allow "private" attributes to be passed to the base
156 # __new__ (starting with underscore).
157 def __new__(mcls
, name
, bases
, dict):
158 assert name
not in allClasses
, "SimObject %s already present" % name
160 # Copy "private" attributes, functions, and classes to the
161 # official dict. Everything else goes in _init_dict to be
162 # filtered in __init__.
165 for key
,val
in dict.items():
166 if public_value(key
, val
):
169 # must be a param/port setting
170 value_dict
[key
] = val
171 if 'abstract' not in value_dict
:
172 value_dict
['abstract'] = False
173 cls_dict
['_value_dict'] = value_dict
174 cls
= super(MetaSimObject
, mcls
).__new
__(mcls
, name
, bases
, cls_dict
)
175 if 'type' in value_dict
:
176 allClasses
[name
] = cls
179 # subclass initialization
180 def __init__(cls
, name
, bases
, dict):
181 # calls type.__init__()... I think that's a no-op, but leave
182 # it here just in case it's not.
183 super(MetaSimObject
, cls
).__init
__(name
, bases
, dict)
185 # initialize required attributes
187 # class-only attributes
188 cls
._params
= multidict() # param descriptions
189 cls
._ports
= multidict() # port descriptions
191 # class or instance attributes
192 cls
._values
= multidict() # param values
193 cls
._children
= multidict() # SimObject children
194 cls
._port
_refs
= multidict() # port ref objects
195 cls
._instantiated
= False # really instantiated, cloned, or subclassed
197 # We don't support multiple inheritance. If you want to, you
198 # must fix multidict to deal with it properly.
200 raise TypeError, "SimObjects do not support multiple inheritance"
204 # Set up general inheritance via multidicts. A subclass will
205 # inherit all its settings from the base class. The only time
206 # the following is not true is when we define the SimObject
207 # class itself (in which case the multidicts have no parent).
208 if isinstance(base
, MetaSimObject
):
210 cls
._params
.parent
= base
._params
211 cls
._ports
.parent
= base
._ports
212 cls
._values
.parent
= base
._values
213 cls
._children
.parent
= base
._children
214 cls
._port
_refs
.parent
= base
._port
_refs
215 # mark base as having been subclassed
216 base
._instantiated
= True
220 # default keyword values
221 if 'type' in cls
._value
_dict
:
222 if 'cxx_class' not in cls
._value
_dict
:
223 cls
._value
_dict
['cxx_class'] = cls
._value
_dict
['type']
225 cls
._value
_dict
['cxx_type'] = '%s *' % cls
._value
_dict
['cxx_class']
227 if 'cxx_predecls' not in cls
.__dict
__:
228 m
= MethodType(default_cxx_predecls
, cls
, MetaSimObject
)
229 setattr(cls
, 'cxx_predecls', m
)
231 if 'swig_predecls' not in cls
.__dict
__:
232 m
= MethodType(default_swig_predecls
, cls
, MetaSimObject
)
233 setattr(cls
, 'swig_predecls', m
)
235 if 'swig_objdecls' not in cls
.__dict
__:
236 m
= MethodType(default_swig_objdecls
, cls
, MetaSimObject
)
237 setattr(cls
, 'swig_objdecls', m
)
239 # Now process the _value_dict items. They could be defining
240 # new (or overriding existing) parameters or ports, setting
241 # class keywords (e.g., 'abstract'), or setting parameter
242 # values or port bindings. The first 3 can only be set when
243 # the class is defined, so we handle them here. The others
244 # can be set later too, so just emulate that by calling
246 for key
,val
in cls
._value
_dict
.items():
248 if isinstance(val
, ParamDesc
):
249 cls
._new
_param
(key
, val
)
252 elif isinstance(val
, Port
):
253 cls
._new
_port
(key
, val
)
255 # init-time-only keywords
256 elif cls
.init_keywords
.has_key(key
):
257 cls
._set
_keyword
(key
, val
, cls
.init_keywords
[key
])
259 # default: use normal path (ends up in __setattr__)
261 setattr(cls
, key
, val
)
263 def _set_keyword(cls
, keyword
, val
, kwtype
):
264 if not isinstance(val
, kwtype
):
265 raise TypeError, 'keyword %s has bad type %s (expecting %s)' % \
266 (keyword
, type(val
), kwtype
)
267 if isinstance(val
, FunctionType
):
268 val
= classmethod(val
)
269 type.__setattr
__(cls
, keyword
, val
)
271 def _new_param(cls
, name
, pdesc
):
272 # each param desc should be uniquely assigned to one variable
273 assert(not hasattr(pdesc
, 'name'))
275 cls
._params
[name
] = pdesc
276 if hasattr(pdesc
, 'default'):
277 cls
._set
_param
(name
, pdesc
.default
, pdesc
)
279 def _set_param(cls
, name
, value
, param
):
280 assert(param
.name
== name
)
282 value
= param
.convert(value
)
284 msg
= "%s\nError setting param %s.%s to %s\n" % \
285 (e
, cls
.__name
__, name
, value
)
288 cls
._values
[name
] = value
289 # if param value is a SimObject, make it a child too, so that
290 # it gets cloned properly when the class is instantiated
291 if isSimObjectOrVector(value
) and not value
.has_parent():
292 cls
._add
_cls
_child
(name
, value
)
294 def _add_cls_child(cls
, name
, child
):
295 # It's a little funky to have a class as a parent, but these
296 # objects should never be instantiated (only cloned, which
297 # clears the parent pointer), and this makes it clear that the
298 # object is not an orphan and can provide better error
300 child
.set_parent(cls
, name
)
301 cls
._children
[name
] = child
303 def _new_port(cls
, name
, port
):
304 # each port should be uniquely assigned to one variable
305 assert(not hasattr(port
, 'name'))
307 cls
._ports
[name
] = port
308 if hasattr(port
, 'default'):
309 cls
._cls
_get
_port
_ref
(name
).connect(port
.default
)
311 # same as _get_port_ref, effectively, but for classes
312 def _cls_get_port_ref(cls
, attr
):
313 # Return reference that can be assigned to another port
314 # via __setattr__. There is only ever one reference
315 # object per port, but we create them lazily here.
316 ref
= cls
._port
_refs
.get(attr
)
318 ref
= cls
._ports
[attr
].makeRef(cls
)
319 cls
._port
_refs
[attr
] = ref
322 # Set attribute (called on foo.attr = value when foo is an
323 # instance of class cls).
324 def __setattr__(cls
, attr
, value
):
325 # normal processing for private attributes
326 if public_value(attr
, value
):
327 type.__setattr
__(cls
, attr
, value
)
330 if cls
.keywords
.has_key(attr
):
331 cls
._set
_keyword
(attr
, value
, cls
.keywords
[attr
])
334 if cls
._ports
.has_key(attr
):
335 cls
._cls
_get
_port
_ref
(attr
).connect(value
)
338 if isSimObjectOrSequence(value
) and cls
._instantiated
:
339 raise RuntimeError, \
340 "cannot set SimObject parameter '%s' after\n" \
341 " class %s has been instantiated or subclassed" \
342 % (attr
, cls
.__name
__)
345 param
= cls
._params
.get(attr
)
347 cls
._set
_param
(attr
, value
, param
)
350 if isSimObjectOrSequence(value
):
351 # If RHS is a SimObject, it's an implicit child assignment.
352 cls
._add
_cls
_child
(attr
, coerceSimObjectOrVector(value
))
355 # no valid assignment... raise exception
356 raise AttributeError, \
357 "Class %s has no parameter \'%s\'" % (cls
.__name
__, attr
)
359 def __getattr__(cls
, attr
):
360 if attr
== 'cxx_class_path':
361 return cls
.cxx_class
.split('::')
363 if attr
== 'cxx_class_name':
364 return cls
.cxx_class_path
[-1]
366 if attr
== 'cxx_namespaces':
367 return cls
.cxx_class_path
[:-1]
369 if cls
._values
.has_key(attr
):
370 return cls
._values
[attr
]
372 if cls
._children
.has_key(attr
):
373 return cls
._children
[attr
]
375 raise AttributeError, \
376 "object '%s' has no attribute '%s'" % (cls
.__name
__, attr
)
381 def cxx_decl(cls
, code
):
382 # The 'dict' attribute restricts us to the params declared in
383 # the object itself, not including inherited params (which
384 # will also be inherited from the base class's param struct
386 params
= cls
._params
.local
.values()
388 ptypes
= [p
.ptype
for p
in params
]
390 print cls
, p
, p
.ptype_str
394 class_path
= cls
._value
_dict
['cxx_class'].split('::')
397 #ifndef __PARAMS__${cls}__
398 #define __PARAMS__${cls}__
402 # A forward class declaration is sufficient since we are just
403 # declaring a pointer.
404 for ns
in class_path
[:-1]:
405 code('namespace $ns {')
406 code('class $0;', class_path
[-1])
407 for ns
in reversed(class_path
[:-1]):
408 code('} // namespace $ns')
412 param
.cxx_predecls(code
)
416 code('#include "params/${{cls._base.type}}.hh"')
420 if issubclass(ptype
, Enum
):
421 code('#include "enums/${{ptype.__name__}}.hh"')
424 cls
.cxx_struct(code
, cls
._base
, params
)
427 code('#endif // __PARAMS__${cls}__')
430 def cxx_struct(cls
, code
, base
, params
):
432 code('#include "sim/sim_object_params.hh"')
435 # now generate the actual param struct
436 code("struct ${cls}Params")
438 code(" : public ${{base.type}}Params")
440 if not hasattr(cls
, 'abstract') or not cls
.abstract
:
441 if 'type' in cls
.__dict
__:
442 code(" ${{cls.cxx_type}} create();")
450 def swig_decl(cls
, code
):
455 #include "params/$cls.hh"
460 # The 'dict' attribute restricts us to the params declared in
461 # the object itself, not including inherited params (which
462 # will also be inherited from the base class's param struct
464 params
= cls
._params
.local
.values()
465 ptypes
= [p
.ptype
for p
in params
]
467 # get all predeclarations
469 param
.swig_predecls(code
)
473 code('%import "python/m5/internal/param_${{cls._base.type}}.i"')
477 if issubclass(ptype
, Enum
):
478 code('%import "enums/${{ptype.__name__}}.hh"')
481 code('%import "params/${cls}_type.hh"')
482 code('%include "params/${cls}.hh"')
484 # The SimObject class is the root of the special hierarchy. Most of
485 # the code in this class deals with the configuration hierarchy itself
486 # (parent/child node relationships).
487 class SimObject(object):
488 # Specify metaclass. Any class inheriting from SimObject will
489 # get this metaclass.
490 __metaclass__
= MetaSimObject
495 def swig_objdecls(cls
, code
):
496 code('%include "python/swig/sim_object.i"')
498 # Initialize new instance. For objects with SimObject-valued
499 # children, we need to recursively clone the classes represented
500 # by those param values as well in a consistent "deep copy"-style
501 # fashion. That is, we want to make sure that each instance is
502 # cloned only once, and that if there are multiple references to
503 # the same original object, we end up with the corresponding
504 # cloned references all pointing to the same cloned instance.
505 def __init__(self
, **kwargs
):
506 ancestor
= kwargs
.get('_ancestor')
507 memo_dict
= kwargs
.get('_memo')
508 if memo_dict
is None:
509 # prepare to memoize any recursively instantiated objects
512 # memoize me now to avoid problems with recursive calls
513 memo_dict
[ancestor
] = self
516 ancestor
= self
.__class
__
517 ancestor
._instantiated
= True
519 # initialize required attributes
522 self
._ccObject
= None # pointer to C++ object
523 self
._ccParams
= None
524 self
._instantiated
= False # really "cloned"
526 # Clone children specified at class level. No need for a
527 # multidict here since we will be cloning everything.
528 # Do children before parameter values so that children that
529 # are also param values get cloned properly.
531 for key
,val
in ancestor
._children
.iteritems():
532 self
.add_child(key
, val(_memo
=memo_dict
))
534 # Inherit parameter values from class using multidict so
535 # individual value settings can be overridden but we still
536 # inherit late changes to non-overridden class values.
537 self
._values
= multidict(ancestor
._values
)
538 # clone SimObject-valued parameters
539 for key
,val
in ancestor
._values
.iteritems():
540 val
= tryAsSimObjectOrVector(val
)
542 self
._values
[key
] = val(_memo
=memo_dict
)
544 # clone port references. no need to use a multidict here
545 # since we will be creating new references for all ports.
547 for key
,val
in ancestor
._port
_refs
.iteritems():
548 self
._port
_refs
[key
] = val
.clone(self
, memo_dict
)
549 # apply attribute assignments from keyword args, if any
550 for key
,val
in kwargs
.iteritems():
551 setattr(self
, key
, val
)
553 # "Clone" the current instance by creating another instance of
554 # this instance's class, but that inherits its parameter values
555 # and port mappings from the current instance. If we're in a
556 # "deep copy" recursive clone, check the _memo dict to see if
557 # we've already cloned this instance.
558 def __call__(self
, **kwargs
):
559 memo_dict
= kwargs
.get('_memo')
560 if memo_dict
is None:
561 # no memo_dict: must be top-level clone operation.
562 # this is only allowed at the root of a hierarchy
564 raise RuntimeError, "attempt to clone object %s " \
565 "not at the root of a tree (parent = %s)" \
566 % (self
, self
._parent
)
567 # create a new dict and use that.
569 kwargs
['_memo'] = memo_dict
570 elif memo_dict
.has_key(self
):
571 # clone already done & memoized
572 return memo_dict
[self
]
573 return self
.__class
__(_ancestor
= self
, **kwargs
)
575 def _get_port_ref(self
, attr
):
576 # Return reference that can be assigned to another port
577 # via __setattr__. There is only ever one reference
578 # object per port, but we create them lazily here.
579 ref
= self
._port
_refs
.get(attr
)
581 ref
= self
._ports
[attr
].makeRef(self
)
582 self
._port
_refs
[attr
] = ref
585 def __getattr__(self
, attr
):
586 if self
._ports
.has_key(attr
):
587 return self
._get
_port
_ref
(attr
)
589 if self
._values
.has_key(attr
):
590 return self
._values
[attr
]
592 if self
._children
.has_key(attr
):
593 return self
._children
[attr
]
595 # If the attribute exists on the C++ object, transparently
596 # forward the reference there. This is typically used for
597 # SWIG-wrapped methods such as init(), regStats(),
598 # regFormulas(), resetStats(), startup(), drain(), and
600 if self
._ccObject
and hasattr(self
._ccObject
, attr
):
601 return getattr(self
._ccObject
, attr
)
603 raise AttributeError, "object '%s' has no attribute '%s'" \
604 % (self
.__class
__.__name
__, attr
)
606 # Set attribute (called on foo.attr = value when foo is an
607 # instance of class cls).
608 def __setattr__(self
, attr
, value
):
609 # normal processing for private attributes
610 if attr
.startswith('_'):
611 object.__setattr
__(self
, attr
, value
)
614 if self
._ports
.has_key(attr
):
615 # set up port connection
616 self
._get
_port
_ref
(attr
).connect(value
)
619 if isSimObjectOrSequence(value
) and self
._instantiated
:
620 raise RuntimeError, \
621 "cannot set SimObject parameter '%s' after\n" \
622 " instance been cloned %s" % (attr
, `self`
)
624 param
= self
._params
.get(attr
)
627 value
= param
.convert(value
)
629 msg
= "%s\nError setting param %s.%s to %s\n" % \
630 (e
, self
.__class
__.__name
__, attr
, value
)
633 self
._values
[attr
] = value
634 # implicitly parent unparented objects assigned as params
635 if isSimObjectOrVector(value
) and not value
.has_parent():
636 self
.add_child(attr
, value
)
639 # if RHS is a SimObject, it's an implicit child assignment
640 if isSimObjectOrSequence(value
):
641 self
.add_child(attr
, value
)
644 # no valid assignment... raise exception
645 raise AttributeError, "Class %s has no parameter %s" \
646 % (self
.__class
__.__name
__, attr
)
649 # this hack allows tacking a '[0]' onto parameters that may or may
650 # not be vectors, and always getting the first element (e.g. cpus)
651 def __getitem__(self
, key
):
654 raise TypeError, "Non-zero index '%s' to SimObject" % key
656 # Also implemented by SimObjectVector
657 def clear_parent(self
, old_parent
):
658 assert self
._parent
is old_parent
661 # Also implemented by SimObjectVector
662 def set_parent(self
, parent
, name
):
663 self
._parent
= parent
666 # Also implemented by SimObjectVector
670 # Also implemented by SimObjectVector
671 def has_parent(self
):
672 return self
._parent
is not None
674 # clear out child with given name. This code is not likely to be exercised.
675 # See comment in add_child.
676 def clear_child(self
, name
):
677 child
= self
._children
[name
]
678 child
.clear_parent(self
)
679 del self
._children
[name
]
681 # Add a new child to this object.
682 def add_child(self
, name
, child
):
683 child
= coerceSimObjectOrVector(child
)
684 if child
.has_parent():
685 print "warning: add_child('%s'): child '%s' already has parent" % \
686 (name
, child
.get_name())
687 if self
._children
.has_key(name
):
688 # This code path had an undiscovered bug that would make it fail
689 # at runtime. It had been here for a long time and was only
690 # exposed by a buggy script. Changes here will probably not be
691 # exercised without specialized testing.
692 self
.clear_child(name
)
693 child
.set_parent(self
, name
)
694 self
._children
[name
] = child
696 # Take SimObject-valued parameters that haven't been explicitly
697 # assigned as children and make them children of the object that
698 # they were assigned to as a parameter value. This guarantees
699 # that when we instantiate all the parameter objects we're still
700 # inside the configuration hierarchy.
701 def adoptOrphanParams(self
):
702 for key
,val
in self
._values
.iteritems():
703 if not isSimObjectVector(val
) and isSimObjectSequence(val
):
704 # need to convert raw SimObject sequences to
705 # SimObjectVector class so we can call has_parent()
706 val
= SimObjectVector(val
)
707 self
._values
[key
] = val
708 if isSimObjectOrVector(val
) and not val
.has_parent():
709 print "warning: %s adopting orphan SimObject param '%s'" \
711 self
.add_child(key
, val
)
715 return '<orphan %s>' % self
.__class
__
716 ppath
= self
._parent
.path()
719 return ppath
+ "." + self
._name
727 def find_any(self
, ptype
):
728 if isinstance(self
, ptype
):
732 for child
in self
._children
.itervalues():
733 if isinstance(child
, ptype
):
734 if found_obj
!= None and child
!= found_obj
:
735 raise AttributeError, \
736 'parent.any matched more than one: %s %s' % \
737 (found_obj
.path
, child
.path
)
740 for pname
,pdesc
in self
._params
.iteritems():
741 if issubclass(pdesc
.ptype
, ptype
):
742 match_obj
= self
._values
[pname
]
743 if found_obj
!= None and found_obj
!= match_obj
:
744 raise AttributeError, \
745 'parent.any matched more than one: %s and %s' % (found_obj
.path
, match_obj
.path
)
746 found_obj
= match_obj
747 return found_obj
, found_obj
!= None
749 def find_all(self
, ptype
):
752 for child
in self
._children
.itervalues():
753 if isinstance(child
, ptype
) and not isproxy(child
) and \
754 not isNullPointer(child
):
757 for pname
,pdesc
in self
._params
.iteritems():
758 if issubclass(pdesc
.ptype
, ptype
):
759 match_obj
= self
._values
[pname
]
760 if not isproxy(match_obj
) and not isNullPointer(match_obj
):
761 all
[match_obj
] = True
762 return all
.keys(), True
764 def unproxy(self
, base
):
767 def unproxyParams(self
):
768 for param
in self
._params
.iterkeys():
769 value
= self
._values
.get(param
)
770 if value
!= None and isproxy(value
):
772 value
= value
.unproxy(self
)
774 print "Error in unproxying param '%s' of %s" % \
777 setattr(self
, param
, value
)
779 # Unproxy ports in sorted order so that 'append' operations on
780 # vector ports are done in a deterministic fashion.
781 port_names
= self
._ports
.keys()
783 for port_name
in port_names
:
784 port
= self
._port
_refs
.get(port_name
)
788 def print_ini(self
, ini_file
):
789 print >>ini_file
, '[' + self
.path() + ']' # .ini section header
791 instanceDict
[self
.path()] = self
793 if hasattr(self
, 'type'):
794 print >>ini_file
, 'type=%s' % self
.type
796 child_names
= self
._children
.keys()
799 print >>ini_file
, 'children=%s' % \
800 ' '.join(self
._children
[n
].get_name() for n
in child_names
)
802 param_names
= self
._params
.keys()
804 for param
in param_names
:
805 value
= self
._values
.get(param
)
807 print >>ini_file
, '%s=%s' % (param
,
808 self
._values
[param
].ini_str())
810 port_names
= self
._ports
.keys()
812 for port_name
in port_names
:
813 port
= self
._port
_refs
.get(port_name
, None)
815 print >>ini_file
, '%s=%s' % (port_name
, port
.ini_str())
817 print >>ini_file
# blank line between objects
819 def getCCParams(self
):
821 return self
._ccParams
823 cc_params_struct
= getattr(m5
.internal
.params
, '%sParams' % self
.type)
824 cc_params
= cc_params_struct()
825 cc_params
.pyobj
= self
826 cc_params
.name
= str(self
)
828 param_names
= self
._params
.keys()
830 for param
in param_names
:
831 value
= self
._values
.get(param
)
833 fatal("%s.%s without default or user set value",
836 value
= value
.getValue()
837 if isinstance(self
._params
[param
], VectorParamDesc
):
838 assert isinstance(value
, list)
839 vec
= getattr(cc_params
, param
)
844 setattr(cc_params
, param
, value
)
846 port_names
= self
._ports
.keys()
848 for port_name
in port_names
:
849 port
= self
._port
_refs
.get(port_name
, None)
851 setattr(cc_params
, port_name
, port
)
852 self
._ccParams
= cc_params
853 return self
._ccParams
855 # Get C++ object corresponding to this object, calling C++ if
856 # necessary to construct it. Does *not* recursively create
858 def getCCObject(self
):
859 if not self
._ccObject
:
860 # Make sure this object is in the configuration hierarchy
861 if not self
._parent
and not isRoot(self
):
862 raise RuntimeError, "Attempt to instantiate orphan node"
863 # Cycles in the configuration hierarchy are not supported. This
864 # will catch the resulting recursion and stop.
866 params
= self
.getCCParams()
867 self
._ccObject
= params
.create()
868 elif self
._ccObject
== -1:
869 raise RuntimeError, "%s: Cycle found in configuration hierarchy." \
871 return self
._ccObject
873 def descendants(self
):
875 for child
in self
._children
.itervalues():
876 for obj
in child
.descendants():
879 # Call C++ to create C++ object corresponding to this object
880 def createCCObject(self
):
882 self
.getCCObject() # force creation
885 return self
.getCCObject()
887 # Create C++ port connections corresponding to the connections in
889 def connectPorts(self
):
890 for portRef
in self
._port
_refs
.itervalues():
893 def getMemoryMode(self
):
894 if not isinstance(self
, m5
.objects
.System
):
897 return self
._ccObject
.getMemoryMode()
899 def changeTiming(self
, mode
):
900 if isinstance(self
, m5
.objects
.System
):
901 # i don't know if there's a better way to do this - calling
902 # setMemoryMode directly from self._ccObject results in calling
903 # SimObject::setMemoryMode, not the System::setMemoryMode
904 self
._ccObject
.setMemoryMode(mode
)
906 def takeOverFrom(self
, old_cpu
):
907 self
._ccObject
.takeOverFrom(old_cpu
._ccObject
)
909 # generate output file for 'dot' to display as a pretty graph.
910 # this code is currently broken.
911 def outputDot(self
, dot
):
912 label
= "{%s|" % self
.path
913 if isSimObject(self
.realtype
):
914 label
+= '%s|' % self
.type
917 # instantiate children in same order they were added for
918 # backward compatibility (else we can end up with cpu1
920 for c
in self
.children
:
921 dot
.add_edge(pydot
.Edge(self
.path
,c
.path
, style
="bold"))
924 for param
in self
.params
:
926 if param
.value
is None:
927 raise AttributeError, 'Parameter with no value'
930 string
= param
.string(value
)
932 msg
= 'exception in %s:%s\n%s' % (self
.name
, param
.name
, e
)
936 if isSimObject(param
.ptype
) and string
!= "Null":
937 simobjs
.append(string
)
939 label
+= '%s = %s\\n' % (param
.name
, string
)
942 label
+= "|<%s> %s" % (so
, so
)
943 dot
.add_edge(pydot
.Edge("%s:%s" % (self
.path
, so
), so
,
946 dot
.add_node(pydot
.Node(self
.path
,shape
="Mrecord",label
=label
))
948 # recursively dump out children
949 for c
in self
.children
:
952 # Function to provide to C++ so it can look up instances based on paths
953 def resolveSimObject(name
):
954 obj
= instanceDict
[name
]
955 return obj
.getCCObject()
957 def isSimObject(value
):
958 return isinstance(value
, SimObject
)
960 def isSimObjectClass(value
):
961 return issubclass(value
, SimObject
)
963 def isSimObjectVector(value
):
964 return isinstance(value
, SimObjectVector
)
966 def isSimObjectSequence(value
):
967 if not isinstance(value
, (list, tuple)) or len(value
) == 0:
971 if not isNullPointer(val
) and not isSimObject(val
):
976 def isSimObjectOrSequence(value
):
977 return isSimObject(value
) or isSimObjectSequence(value
)
980 from m5
.objects
import Root
981 return obj
and obj
is Root
.getInstance()
983 def isSimObjectOrVector(value
):
984 return isSimObject(value
) or isSimObjectVector(value
)
986 def tryAsSimObjectOrVector(value
):
987 if isSimObjectOrVector(value
):
989 if isSimObjectSequence(value
):
990 return SimObjectVector(value
)
993 def coerceSimObjectOrVector(value
):
994 value
= tryAsSimObjectOrVector(value
)
996 raise TypeError, "SimObject or SimObjectVector expected"
999 baseClasses
= allClasses
.copy()
1000 baseInstances
= instanceDict
.copy()
1003 global allClasses
, instanceDict
1005 allClasses
= baseClasses
.copy()
1006 instanceDict
= baseInstances
.copy()
1008 # __all__ defines the list of symbols that get exported when
1009 # 'from config import *' is invoked. Try to keep this reasonably
1010 # short to avoid polluting other namespaces.
1011 __all__
= [ 'SimObject' ]