SystemC.py (13331:2e3f70431e60) SystemC.py (13722:4f0de9b591df)
1# Copyright 2018 Google, Inc.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met: redistributions of source code must retain the above copyright
6# notice, this list of conditions and the following disclaimer;
7# redistributions in binary form must reproduce the above copyright
8# notice, this list of conditions and the following disclaimer in the
9# documentation and/or other materials provided with the distribution;
10# neither the name of the copyright holders nor the names of its
11# contributors may be used to endorse or promote products derived from
12# this software without specific prior written permission.
13#
14# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25#
26# Authors: Gabe Black
27
28from m5.SimObject import SimObject
29
30# This class represents the systemc kernel. There should be exactly one in the
31# simulation. It receives gem5 SimObject lifecycle callbacks (init, regStats,
32# etc.) and manages the lifecycle of the systemc simulation accordingly.
33# It also acts as a collecting point for systemc related control functionality.
34class SystemC_Kernel(SimObject):
35 type = 'SystemC_Kernel'
36 cxx_class = 'sc_gem5::Kernel'
37 cxx_header = 'systemc/core/kernel.hh'
38
1# Copyright 2018 Google, Inc.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met: redistributions of source code must retain the above copyright
6# notice, this list of conditions and the following disclaimer;
7# redistributions in binary form must reproduce the above copyright
8# notice, this list of conditions and the following disclaimer in the
9# documentation and/or other materials provided with the distribution;
10# neither the name of the copyright holders nor the names of its
11# contributors may be used to endorse or promote products derived from
12# this software without specific prior written permission.
13#
14# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25#
26# Authors: Gabe Black
27
28from m5.SimObject import SimObject
29
30# This class represents the systemc kernel. There should be exactly one in the
31# simulation. It receives gem5 SimObject lifecycle callbacks (init, regStats,
32# etc.) and manages the lifecycle of the systemc simulation accordingly.
33# It also acts as a collecting point for systemc related control functionality.
34class SystemC_Kernel(SimObject):
35 type = 'SystemC_Kernel'
36 cxx_class = 'sc_gem5::Kernel'
37 cxx_header = 'systemc/core/kernel.hh'
38
39 # The sc_time type won't exist until some setup code runs in gem5.
40 try:
41 from _m5.systemc import sc_time
42 except:
43 pass
44
39 class ScMainResult(object):
40 def __init__(self, code, message):
41 self.code = code
42 self.message = message
43
44 def sc_main(self, *args):
45 '''Call the systemc sc_main function with the given string args'''
46 from _m5.systemc import sc_main
47 sc_main(*args)
48
49 def sc_main_result(self):
50 '''Retrieve and return the results of running sc_main'''
51 from _m5.systemc import sc_main_result_code, sc_main_result_str
52 return SystemC_Kernel.ScMainResult(
53 sc_main_result_code(), sc_main_result_str());
54
55# This class represents systemc sc_object instances in python config files. It
56# inherits from SimObject in python, but the c++ version, sc_core::sc_object,
57# doesn't inherit from gem5's c++ SimObject class.
58class SystemC_ScObject(SimObject):
59 type = 'SystemC_ScObject'
60 abstract = True
61 cxx_class = 'sc_core::sc_object'
62 cxx_header = 'systemc/ext/core/sc_object.hh'
63
64 # Clear cxx_base to stop the c++ binding code from assuming
65 # sc_core::sc_object inherits from SimObject, even though SystemC_ScObject
66 # does on the python side.
67 cxx_base = None
68
69 # Hide the cxx_exports from SimObject since we don't inherit from
70 # SimObject on the c++ side and so don't have those methods to call down
71 # into.
72 locals().update({
73 method.name: (lambda *a, **k: None) for method in SimObject.cxx_exports
74 })
75
76class SystemC_ScModule(SystemC_ScObject):
77 type = 'SystemC_ScModule'
78 abstract = True
79 cxx_class = 'sc_core::sc_module'
80 cxx_header = 'systemc/ext/core/sc_module.hh'
81
82try:
83 import _m5
84except:
85 pass
86else:
87 import _m5.systemc
88 _m5.systemc.python_ready()
45 class ScMainResult(object):
46 def __init__(self, code, message):
47 self.code = code
48 self.message = message
49
50 def sc_main(self, *args):
51 '''Call the systemc sc_main function with the given string args'''
52 from _m5.systemc import sc_main
53 sc_main(*args)
54
55 def sc_main_result(self):
56 '''Retrieve and return the results of running sc_main'''
57 from _m5.systemc import sc_main_result_code, sc_main_result_str
58 return SystemC_Kernel.ScMainResult(
59 sc_main_result_code(), sc_main_result_str());
60
61# This class represents systemc sc_object instances in python config files. It
62# inherits from SimObject in python, but the c++ version, sc_core::sc_object,
63# doesn't inherit from gem5's c++ SimObject class.
64class SystemC_ScObject(SimObject):
65 type = 'SystemC_ScObject'
66 abstract = True
67 cxx_class = 'sc_core::sc_object'
68 cxx_header = 'systemc/ext/core/sc_object.hh'
69
70 # Clear cxx_base to stop the c++ binding code from assuming
71 # sc_core::sc_object inherits from SimObject, even though SystemC_ScObject
72 # does on the python side.
73 cxx_base = None
74
75 # Hide the cxx_exports from SimObject since we don't inherit from
76 # SimObject on the c++ side and so don't have those methods to call down
77 # into.
78 locals().update({
79 method.name: (lambda *a, **k: None) for method in SimObject.cxx_exports
80 })
81
82class SystemC_ScModule(SystemC_ScObject):
83 type = 'SystemC_ScModule'
84 abstract = True
85 cxx_class = 'sc_core::sc_module'
86 cxx_header = 'systemc/ext/core/sc_module.hh'
87
88try:
89 import _m5
90except:
91 pass
92else:
93 import _m5.systemc
94 _m5.systemc.python_ready()