-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Expand file tree
/
Copy pathSimObject.py
More file actions
1461 lines (1252 loc) · 53.9 KB
/
SimObject.py
File metadata and controls
1461 lines (1252 loc) · 53.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2017-2020, 2025 Arm Limited
# All rights reserved.
#
# The license below extends only to copyright in the software and shall
# not be construed as granting a license to any other intellectual
# property including but not limited to intellectual property relating
# to a hardware implementation of the functionality of the software
# licensed hereunder. You may use the software subject to the license
# terms below provided that you ensure that this notice is replicated
# unmodified and in its entirety in all distributions of the software,
# modified or unmodified, in source code or in binary form.
#
# Copyright (c) 2004-2006 The Regents of The University of Michigan
# Copyright (c) 2010-20013 Advanced Micro Devices, Inc.
# Copyright (c) 2013 Mark D. Hill and David A. Wood
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
import importlib
import inspect
from functools import wraps
from types import (
FunctionType,
MethodType,
ModuleType,
)
import m5
from m5.citations import gem5_citations
# There are a few things we need that aren't in params.__all__ since
# normal users don't need them
# Have to import params up top since Param is referenced on initial
# load (when SimObject class references Param to create a class
# variable, the 'name' param)...
from m5.params import *
from m5.params import (
DictParamDesc,
ParamDesc,
Port,
SimObjectVector,
VectorParamDesc,
isNullPointer,
)
from m5.proxy import *
from m5.proxy import isproxy
from m5.util import *
from m5.util.pybind import *
#####################################################################
#
# M5 Python Configuration Utility
#
# The basic idea is to write simple Python programs that build Python
# objects corresponding to M5 SimObjects for the desired simulation
# configuration. For now, the Python emits a .ini file that can be
# parsed by M5. In the future, some tighter integration between M5
# and the Python interpreter may allow bypassing the .ini file.
#
# Each SimObject class in M5 is represented by a Python class with the
# same name. The Python inheritance tree mirrors the M5 C++ tree
# (e.g., SimpleCPU derives from BaseCPU in both cases, and all
# SimObjects inherit from a single SimObject base class). To specify
# an instance of an M5 SimObject in a configuration, the user simply
# instantiates the corresponding Python object. The parameters for
# that SimObject are given by assigning to attributes of the Python
# object, either using keyword assignment in the constructor or in
# separate assignment statements. For example:
#
# cache = BaseCache(size='64KiB')
# cache.hit_latency = 3
# cache.assoc = 8
#
# The magic lies in the mapping of the Python attributes for SimObject
# classes to the actual SimObject parameter specifications. This
# allows parameter validity checking in the Python code. Continuing
# the example above, the statements "cache.blurfl=3" or
# "cache.assoc='hello'" would both result in runtime errors in Python,
# since the BaseCache object has no 'blurfl' parameter and the 'assoc'
# parameter requires an integer, respectively. This magic is done
# primarily by overriding the special __setattr__ method that controls
# assignment to object attributes.
#
# Once a set of Python objects have been instantiated in a hierarchy,
# calling 'instantiate(obj)' (where obj is the root of the hierarchy)
# will generate a .ini file.
#
#####################################################################
# list of all SimObject classes
allClasses = {}
# dict to look up SimObjects based on path
instanceDict = {}
# Did any of the SimObjects lack a header file?
noCxxHeader = False
def public_value(key, value):
return key.startswith("_") or isinstance(
value, (FunctionType, MethodType, ModuleType, classmethod, type)
)
# The metaclass for SimObject. This class controls how new classes
# that derive from SimObject are instantiated, and provides inherited
# class behavior (just like a class controls how instances of that
# class are instantiated, and provides inherited instance behavior).
class MetaSimObject(type):
# Attributes that can be set only at initialization time
init_keywords = {
"abstract": bool,
"cxx_class": str,
"cxx_type": str,
"cxx_header": str,
"type": str,
"cxx_base": (str, type(None)),
"cxx_extra_bases": list,
"cxx_exports": list,
"cxx_param_exports": list,
"cxx_template_params": list,
"override_create": bool, # True if overrides the default create()
}
# Attributes that can be set any time
keywords = {"check": FunctionType}
# __new__ is called before __init__, and is where the statements
# in the body of the class definition get loaded into the class's
# __dict__. We intercept this to filter out parameter & port assignments
# and only allow "private" attributes to be passed to the base
# __new__ (starting with underscore).
def __new__(mcls, name, bases, dict):
assert name not in allClasses, f"SimObject {name} already present"
# Copy "private" attributes, functions, and classes to the
# official dict. Everything else goes in _init_dict to be
# filtered in __init__.
cls_dict = {}
value_dict = {}
cxx_exports = []
for key, val in dict.items():
try:
cxx_exports.append(getattr(val, "__pybind"))
except AttributeError:
pass
if public_value(key, val):
cls_dict[key] = val
else:
# must be a param/port setting
value_dict[key] = val
if "abstract" not in value_dict:
value_dict["abstract"] = False
if "cxx_extra_bases" not in value_dict:
value_dict["cxx_extra_bases"] = []
if "cxx_exports" not in value_dict:
value_dict["cxx_exports"] = cxx_exports
else:
value_dict["cxx_exports"] += cxx_exports
if "cxx_param_exports" not in value_dict:
value_dict["cxx_param_exports"] = []
if "cxx_template_params" not in value_dict:
value_dict["cxx_template_params"] = []
if "override_create" not in value_dict:
value_dict["override_create"] = False
cls_dict["_value_dict"] = value_dict
cls = super().__new__(mcls, name, bases, cls_dict)
if "type" in value_dict:
allClasses[name] = cls
return cls
# subclass initialization
def __init__(cls, name, bases, dict):
# calls type.__init__()... I think that's a no-op, but leave
# it here just in case it's not.
super().__init__(name, bases, dict)
# initialize required attributes
# class-only attributes
cls._params = multidict() # param descriptions
cls._ports = multidict() # port descriptions
# Parameter names that are deprecated. Dict[str, DeprecatedParam]
# The key is the "old_name" so that when the old_name is used in
# python config files, we will use the DeprecatedParam object to
# translate to the new type.
cls._deprecated_params = multidict()
# class or instance attributes
cls._values = multidict() # param values
cls._hr_values = multidict() # human readable param values
cls._children = multidict() # SimObject children
cls._port_refs = multidict() # port ref objects
cls._instantiated = False # really instantiated, cloned, or subclassed
cls._init_called = False # Used to check if __init__ overridden
cls._citations = gem5_citations # Default to gem5's citations
# We don't support multiple inheritance of sim objects. If you want
# to, you must fix multidict to deal with it properly. Non sim-objects
# are ok, though
bTotal = 0
for c in bases:
if isinstance(c, MetaSimObject):
bTotal += 1
if bTotal > 1:
raise TypeError(
"SimObjects do not support multiple inheritance"
)
# If the base class is not set, we assume type `object`. This ensures
# `class Foo(object): pass` is considered equivalent to
# `class Foo: pass`.
base = bases[0] if len(bases) > 0 else object
# Set up general inheritance via multidicts. A subclass will
# inherit all its settings from the base class. The only time
# the following is not true is when we define the SimObject
# class itself (in which case the multidicts have no parent).
if isinstance(base, MetaSimObject):
cls._base = base
cls._params.parent = base._params
cls._ports.parent = base._ports
cls._deprecated_params.parent = base._deprecated_params
cls._values.parent = base._values
cls._hr_values.parent = base._hr_values
cls._children.parent = base._children
cls._port_refs.parent = base._port_refs
# mark base as having been subclassed
base._instantiated = True
else:
cls._base = None
# default keyword values
if "type" in cls._value_dict:
if "cxx_class" not in cls._value_dict:
cls._value_dict["cxx_class"] = cls._value_dict["type"]
cls._value_dict["cxx_type"] = f"{cls._value_dict['cxx_class']} *"
if "cxx_header" not in cls._value_dict:
global noCxxHeader
noCxxHeader = True
warn("No header file specified for SimObject: %s", name)
# Now process the _value_dict items. They could be defining
# new (or overriding existing) parameters or ports, setting
# class keywords (e.g., 'abstract'), or setting parameter
# values or port bindings. The first 3 can only be set when
# the class is defined, so we handle them here. The others
# can be set later too, so just emulate that by calling
# setattr().
for key, val in cls._value_dict.items():
# param descriptions
if isinstance(val, ParamDesc):
cls._new_param(key, val)
# port objects
elif isinstance(val, Port):
cls._new_port(key, val)
# Deprecated variable names
elif isinstance(val, DeprecatedParam):
new_name, new_val = cls._get_param_by_value(val.newParam)
# Note: We don't know the (string) name of this variable until
# here, so now we can finish setting up the dep_param.
val.oldName = key
val.newName = new_name
cls._deprecated_params[key] = val
# init-time-only keywords
elif key in cls.init_keywords:
cls._set_keyword(key, val, cls.init_keywords[key])
# default: use normal path (ends up in __setattr__)
else:
setattr(cls, key, val)
def _set_keyword(cls, keyword, val, kwtype):
if not isinstance(val, kwtype):
raise TypeError(
f"keyword {keyword} has bad type {type(val)} (expecting {kwtype})"
)
if isinstance(val, FunctionType):
val = classmethod(val)
type.__setattr__(cls, keyword, val)
def _new_param(cls, name, pdesc):
# each param desc should be uniquely assigned to one variable
assert not hasattr(pdesc, "name")
pdesc.name = name
cls._params[name] = pdesc
if hasattr(pdesc, "default"):
cls._set_param(name, pdesc.default, pdesc)
def _set_param(cls, name, value, param):
assert param.name == name
try:
hr_value = value
value = param.convert(value)
except Exception as e:
msg = (
f"{e}\nError setting param {cls.__name__}.{name} to {value}\n"
)
e.args = (msg,)
raise
cls._values[name] = value
# if param value is a SimObject, make it a child too, so that
# it gets cloned properly when the class is instantiated
if isSimObjectOrVector(value) and not value.has_parent():
cls._add_cls_child(name, value)
# update human-readable values of the param if it has a literal
# value and is not an object or proxy.
if not (
isSimObjectOrVector(value) or isinstance(value, m5.proxy.BaseProxy)
):
cls._hr_values[name] = hr_value
def _add_cls_child(cls, name, child):
# It's a little funky to have a class as a parent, but these
# objects should never be instantiated (only cloned, which
# clears the parent pointer), and this makes it clear that the
# object is not an orphan and can provide better error
# messages.
child.set_parent(cls, name)
if not isNullPointer(child):
cls._children[name] = child
def _new_port(cls, name, port):
# each port should be uniquely assigned to one variable
assert not hasattr(port, "name")
port.name = name
cls._ports[name] = port
# same as _get_port_ref, effectively, but for classes
def _cls_get_port_ref(cls, attr):
# Return reference that can be assigned to another port
# via __setattr__. There is only ever one reference
# object per port, but we create them lazily here.
ref = cls._port_refs.get(attr)
if not ref:
ref = cls._ports[attr].makeRef(cls)
cls._port_refs[attr] = ref
return ref
def _get_param_by_value(cls, value):
"""Given an object, value, return the name and the value from the
internal list of parameter values. If this value can't be found, raise
a runtime error. This will search both the current object and its
parents.
"""
for k, v in cls._value_dict.items():
if v == value:
return k, v
raise RuntimeError(f"Cannot find parameter {value} in parameter list")
# Set attribute (called on foo.attr = value when foo is an
# instance of class cls).
def __setattr__(cls, attr, value):
# normal processing for private attributes
if public_value(attr, value):
type.__setattr__(cls, attr, value)
return
if attr in cls.keywords:
cls._set_keyword(attr, value, cls.keywords[attr])
return
if attr in cls._ports:
cls._cls_get_port_ref(attr).connect(value)
return
if isSimObjectOrSequence(value) and cls._instantiated:
raise RuntimeError(
"cannot set SimObject parameter '%s' after\n"
" class %s has been instantiated or subclassed"
% (attr, cls.__name__)
)
# check for param
param = cls._params.get(attr)
if param:
cls._set_param(attr, value, param)
return
if isSimObjectOrSequence(value):
# If RHS is a SimObject, it's an implicit child assignment.
cls._add_cls_child(attr, coerceSimObjectOrVector(value))
return
# no valid assignment... raise exception
raise AttributeError(
f"Invalid assignment for Class {cls.__name__} with parameter {attr}"
)
def __getattr__(cls, attr):
if attr == "cxx_class_path":
return cls.cxx_class.split("::")
if attr == "cxx_class_name":
return cls.cxx_class_path[-1]
if attr == "cxx_namespaces":
return cls.cxx_class_path[:-1]
if attr == "pybind_class":
return "_COLONS_".join(cls.cxx_class_path)
if attr in cls._values:
return cls._values[attr]
if attr in cls._children:
return cls._children[attr]
try:
return getattr(cls.getCCClass(), attr)
except AttributeError:
raise AttributeError(
f"object '{cls.__name__}' has no attribute '{attr}'"
)
def __str__(cls):
return cls.__name__
def getCCClass(cls):
try:
# This function can be called from outside gem5
# during SimObject parsing.
import _m5
return getattr(_m5, cls.pybind_class)
except ImportError:
raise AttributeError("No C++ class exists, not linked to gem5")
# See ParamValue.cxx_predecls for description.
def cxx_predecls(cls, code):
code('#include "params/$cls.hh"', add_once=True)
def pybind_predecls(cls, code):
code('#include "${{cls.cxx_header}}"', add_once=True)
# This *temporary* definition is required to support calls from the
# SimObject class definition to the MetaSimObject methods (in
# particular _set_param, which gets called for parameters with default
# values defined on the SimObject class itself). It will get
# overridden by the permanent definition (which requires that
# SimObject be defined) lower in this file.
def isSimObjectOrVector(value):
return False
def cxxMethod(*args, **kwargs):
"""Decorator to export C++ functions to Python"""
def decorate(func):
name = func.__name__
override = kwargs.get("override", False)
cxx_name = kwargs.get("cxx_name", name)
return_value_policy = kwargs.get("return_value_policy", None)
static = kwargs.get("static", False)
# Create a list of tuples of (argument, default). The `PyBindMethod`
# class expects the `args` argument to be a list of either argument
# names, in the case that argument does not have a default value, and
# a tuple of (argument, default) in the casae where an argument does.
args = []
sig = inspect.signature(func)
for param_name in sig.parameters.keys():
if param_name == "self":
# We don't cound 'self' as an argument in this case.
continue
param = sig.parameters[param_name]
if param.kind in [
inspect.Parameter.VAR_POSITIONAL,
inspect.Parameter.VAR_KEYWORD,
]:
# *args and **kwargs shouldn't be in generated parameters
continue
if param.default is param.empty:
args.append(param_name)
else:
args.append((param_name, param.default))
@wraps(func)
def cxx_call(self, *args, **kwargs):
ccobj = self.getCCClass() if static else self.getCCObject()
return getattr(ccobj, name)(*args, **kwargs)
@wraps(func)
def py_call(self, *args, **kwargs):
return func(self, *args, **kwargs)
f = py_call if override else cxx_call
f.__pybind = PyBindMethod(
name,
cxx_name=cxx_name,
args=args,
return_value_policy=return_value_policy,
static=static,
)
return f
if len(args) == 0:
return decorate
elif len(args) == 1 and len(kwargs) == 0:
return decorate(*args)
else:
raise TypeError("One argument and no kwargs, or only kwargs expected")
# This class holds information about each simobject parameter
# that should be displayed on the command line for use in the
# configuration system.
class ParamInfo:
def __init__(self, type, desc, type_str, example, default_val, access_str):
self.type = type
self.desc = desc
self.type_str = type_str
self.example_str = example
self.default_val = default_val
# The string representation used to access this param through python.
# The method to access this parameter presented on the command line may
# be different, so this needs to be stored for later use.
self.access_str = access_str
self.created = True
# Make it so we can only set attributes at initialization time
# and effectively make this a const object.
def __setattr__(self, name, value):
if not "created" in self.__dict__:
self.__dict__[name] = value
class SimObjectCliWrapperException(Exception):
def __init__(self, message):
super().__init__(message)
class SimObjectCliWrapper:
"""
Wrapper class to restrict operations that may be done
from the command line on SimObjects.
Only parameters may be set, and only children may be accessed.
Slicing allows for multiple simultaneous assignment of items in
one statement.
"""
def __init__(self, sim_objects):
self.__dict__["_sim_objects"] = list(sim_objects)
def __getattr__(self, key):
return SimObjectCliWrapper(
sim_object._children[key] for sim_object in self._sim_objects
)
def __setattr__(self, key, val):
for sim_object in self._sim_objects:
if key in sim_object._params:
if sim_object._params[key].isCmdLineSettable():
setattr(sim_object, key, val)
else:
raise SimObjectCliWrapperException(
"tried to set or unsettableobject parameter: " + key
)
else:
raise SimObjectCliWrapperException(
"tried to set or access non-existent"
"object parameter: " + key
)
def __getitem__(self, idx):
"""
Extends the list() semantics to also allow tuples,
for example object[1, 3] selects items 1 and 3.
"""
out = []
if isinstance(idx, tuple):
for t in idx:
out.extend(self[t]._sim_objects)
else:
if isinstance(idx, int):
_range = range(idx, idx + 1)
elif not isinstance(idx, slice):
raise SimObjectCliWrapperException(
"invalid index type: " + repr(idx)
)
for sim_object in self._sim_objects:
if isinstance(idx, slice):
_range = range(*idx.indices(len(sim_object)))
out.extend(sim_object[i] for i in _range)
return SimObjectCliWrapper(out)
def __iter__(self):
return iter(self._sim_objects)
# The SimObject class is the root of the special hierarchy. Most of
# the code in this class deals with the configuration hierarchy itself
# (parent/child node relationships).
class SimObject(metaclass=MetaSimObject):
# Specify metaclass. Any class inheriting from SimObject will
# get this metaclass.
type = "SimObject"
abstract = True
cxx_header = "sim/sim_object.hh"
cxx_class = "gem5::SimObject"
cxx_extra_bases = ["Drainable", "Serializable", "statistics::Group"]
eventq_index = Param.UInt32(Parent.eventq_index, "Event Queue Index")
cxx_exports = [
PyBindMethod("init"),
PyBindMethod("initState"),
PyBindMethod("memInvalidate"),
PyBindMethod("memWriteback"),
PyBindMethod("regProbePoints"),
PyBindMethod("regProbeListeners"),
PyBindMethod("startup"),
]
cxx_param_exports = [PyBindProperty("name")]
@cxxMethod
def loadState(self, cp):
"""Load SimObject state from a checkpoint"""
pass
# Returns a dict of all the option strings that can be
# generated as command line options for this simobject instance
# by tracing all reachable params in the top level instance and
# any children it contains.
def enumerateParams(self, flags_dict={}, cmd_line_str="", access_str=""):
if hasattr(self, "_paramEnumed"):
print("Cycle detected enumerating params")
else:
self._paramEnumed = True
# Scan the children first to pick up all the objects in this SimObj
for keys in self._children:
child = self._children[keys]
next_cmdline_str = cmd_line_str + keys
next_access_str = access_str + keys
if not isSimObjectVector(child):
next_cmdline_str = next_cmdline_str + "."
next_access_str = next_access_str + "."
flags_dict = child.enumerateParams(
flags_dict, next_cmdline_str, next_access_str
)
# Go through the simple params in the simobject in this level
# of the simobject hierarchy and save information about the
# parameter to be used for generating and processing command line
# options to the simulator to set these parameters.
for keys, values in self._params.items():
if values.isCmdLineSettable():
type_str = ""
ex_str = values.example_str()
ptype = None
if isinstance(values, VectorParamDesc):
type_str = f"Vector_{values.ptype_str}"
ptype = values
elif isinstance(values, DictParamDesc):
type_str = f"Dict_{values.key_desc.ptype_str}_{values.val_desc.ptype_str}"
ptype = values
else:
type_str = f"{values.ptype_str}"
ptype = values.ptype
if (
keys in self._hr_values
and keys in self._values
and not isinstance(
self._values[keys], m5.proxy.BaseProxy
)
):
cmd_str = cmd_line_str + keys
acc_str = access_str + keys
flags_dict[cmd_str] = ParamInfo(
ptype,
self._params[keys].desc,
type_str,
ex_str,
values.pretty_print(self._hr_values[keys]),
acc_str,
)
elif (
not keys in self._hr_values
and not keys in self._values
):
# Empty param
cmd_str = cmd_line_str + keys
acc_str = access_str + keys
flags_dict[cmd_str] = ParamInfo(
ptype,
self._params[keys].desc,
type_str,
ex_str,
"",
acc_str,
)
return flags_dict
# Initialize new instance. For objects with SimObject-valued
# children, we need to recursively clone the classes represented
# by those param values as well in a consistent "deep copy"-style
# fashion. That is, we want to make sure that each instance is
# cloned only once, and that if there are multiple references to
# the same original object, we end up with the corresponding
# cloned references all pointing to the same cloned instance.
def __init__(self, **kwargs):
ancestor = kwargs.get("_ancestor")
memo_dict = kwargs.get("_memo")
if memo_dict is None:
# prepare to memoize any recursively instantiated objects
memo_dict = {}
elif ancestor:
# memoize me now to avoid problems with recursive calls
memo_dict[ancestor] = self
if not ancestor:
ancestor = self.__class__
ancestor._instantiated = True
# initialize required attributes
self._parent = None
self._name = None
self._ccObject = None # pointer to C++ object
self._ccParams = None
self._instantiated = False # really "cloned"
self._init_called = True # Checked so subclasses don't forget __init__
# Clone children specified at class level. No need for a
# multidict here since we will be cloning everything.
# Do children before parameter values so that children that
# are also param values get cloned properly.
self._children = {}
for key, val in ancestor._children.items():
newval = val(_memo=memo_dict)
if not newval.has_parent():
self.add_child(key, newval)
# Inherit parameter values from class using multidict so
# individual value settings can be overridden but we still
# inherit late changes to non-overridden class values.
self._values = multidict(ancestor._values)
self._hr_values = multidict(ancestor._hr_values)
# clone SimObject-valued parameters
for key, val in ancestor._values.items():
if val == []:
self._values[key] = type(val)()
continue
val = tryAsSimObjectOrVector(val)
if val is not None:
self._values[key] = val(_memo=memo_dict)
# clone port references. no need to use a multidict here
# since we will be creating new references for all ports.
self._port_refs = {}
for key, val in ancestor._port_refs.items():
self._port_refs[key] = val.clone(self, memo_dict)
# apply attribute assignments from keyword args, if any
for key, val in kwargs.items():
setattr(self, key, val)
def _check_init(self):
"""Utility function to check to make sure that all subclasses call
__init__
"""
if not self._init_called:
raise RuntimeError(
f"{str(self.__class__)} is missing a call "
"to super().__init__()"
)
# "Clone" the current instance by creating another instance of
# this instance's class, but that inherits its parameter values
# and port mappings from the current instance. If we're in a
# "deep copy" recursive clone, check the _memo dict to see if
# we've already cloned this instance.
def __call__(self, **kwargs):
memo_dict = kwargs.get("_memo")
if memo_dict is None:
# no memo_dict: must be top-level clone operation.
# this is only allowed at the root of a hierarchy
if self._parent:
raise RuntimeError(
"attempt to clone object %s "
"not at the root of a tree (parent = %s)"
% (self, self._parent)
)
# create a new dict and use that.
memo_dict = {}
kwargs["_memo"] = memo_dict
elif self in memo_dict:
# clone already done & memoized
return memo_dict[self]
return self.__class__(_ancestor=self, **kwargs)
def _get_port_ref(self, attr):
# Return reference that can be assigned to another port
# via __setattr__. There is only ever one reference
# object per port, but we create them lazily here.
ref = self._port_refs.get(attr)
if ref == None:
ref = self._ports[attr].makeRef(self)
self._port_refs[attr] = ref
return ref
def __getattr__(self, attr):
# Check for infinite recursion. If this SimObject hasn't been
# initialized with SimObject.__init__ this function will experience an
# infinite recursion checking for attributes that don't exist.
self._check_init()
if attr in self._deprecated_params:
dep_param = self._deprecated_params[attr]
dep_param.printWarning(self._name, self.__class__.__name__)
return getattr(self, self._deprecated_params[attr].newName)
if attr in self._ports:
return self._get_port_ref(attr)
if attr in self._values:
return self._values[attr]
if attr in self._children:
return self._children[attr]
# If the attribute exists on the C++ object, transparently
# forward the reference there. This is typically used for
# methods exported to Python (e.g., init(), and startup())
if self._ccObject and hasattr(self._ccObject, attr):
return getattr(self._ccObject, attr)
err_string = (
f"object '{self.__class__.__name__}' has no attribute '{attr}'"
)
if not self._ccObject:
err_string += (
"\n (C++ object is not yet constructed,"
" so wrapped C++ methods are unavailable.)"
)
raise AttributeError(err_string)
# Set attribute (called on foo.attr = value when foo is an
# instance of class cls).
def __setattr__(self, attr, value):
# normal processing for private attributes
if attr.startswith("_"):
object.__setattr__(self, attr, value)
return
if attr in self._deprecated_params:
dep_param = self._deprecated_params[attr]
dep_param.printWarning(self._name, self.__class__.__name__)
return setattr(self, self._deprecated_params[attr].newName, value)
if attr in self._ports:
# set up port connection
self._get_port_ref(attr).connect(value)
return
param = self._params.get(attr)
if param:
try:
hr_value = value
value = param.convert(value)
except Exception as e:
msg = "{}\nError setting param {}.{} to {}\n".format(
e,
self.__class__.__name__,
attr,
value,
)
e.args = (msg,)
raise
self._values[attr] = value
# If we assign NULL to an attr that is a SimObject,
# remove the corresponding children
if attr in self._children and isNullPointer(value):
self.clear_child(attr)
# implicitly parent unparented objects assigned as params
if isSimObjectOrVector(value) and not value.has_parent():
self.add_child(attr, value)
# set the human-readable value dict if this is a param
# with a literal value and is not being set as an object
# or proxy.
if not (
isSimObjectOrVector(value)
or isinstance(value, m5.proxy.BaseProxy)
):
self._hr_values[attr] = hr_value
return
# if RHS is a SimObject, it's an implicit child assignment
if isSimObjectOrSequence(value):
self.add_child(attr, value)
return
# no valid assignment... raise exception
raise AttributeError(
f"Invalid assignment for Class {self.__class__.__name__} with"
f" parameter {attr}"
)
# this hack allows tacking a '[0]' onto parameters that may or may
# not be vectors, and always getting the first element (e.g. cpus)
def __getitem__(self, key):
if key == 0:
return self
raise IndexError(f"Non-zero index '{key}' to SimObject")
# this hack allows us to iterate over a SimObject that may
# not be a vector, so we can call a loop over it and get just one
# element.
def __len__(self):
return 1
# Also implemented by SimObjectVector
def clear_parent(self, old_parent):
assert self._parent is old_parent
self._parent = None
# Also implemented by SimObjectVector
def set_parent(self, parent, name):
self._parent = parent
self._name = name
# Return parent object of this SimObject, not implemented by
# SimObjectVector because the elements in a SimObjectVector may not share
# the same parent
def get_parent(self):
return self._parent
# Also implemented by SimObjectVector
def get_name(self):
return self._name
# Also implemented by SimObjectVector
def has_parent(self):
return self._parent is not None
# clear out child with given name. This code is not likely to be exercised.
# See comment in add_child.
def clear_child(self, name):
child = self._children[name]
child.clear_parent(self)
del self._children[name]
# Add a new child to this object.
def add_child(self, name, child):
child = coerceSimObjectOrVector(child)
if child.has_parent():
warn(
f"{self}.{name} already has parent not resetting parent.\n"
f"\tNote: {name} is not a parameter of {type(self).__name__}"
)
warn(f"(Previously declared as {child._parent}.{name}")
return
if name in self._children:
# This code path had an undiscovered bug that would make it fail
# at runtime. It had been here for a long time and was only
# exposed by a buggy script. Changes here will probably not be
# exercised without specialized testing.
self.clear_child(name)
if not isNullPointer(child):
child.set_parent(self, name)