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