1# Copyright (c) 2005 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: Nathan Binkert
28# Steve Reinhardt
29
30import atexit
31import os
32import sys
33
34# import the SWIG-wrapped main C++ functions
35import internal
36from main import options
37import SimObject
38import ticks
39import objects
40
41# The final hook to generate .ini files. Called from the user script
42# once the config is built.
43def instantiate(root):
44 # we need to fix the global frequency
45 ticks.fixGlobalFrequency()
46
47 root.unproxy_all()
48
49 ini_file = file(os.path.join(options.outdir, 'config.ini'), 'w')
50 root.print_ini(ini_file)
51 ini_file.close() # close config.ini
52
53 # Initialize the global statistics
54 internal.stats.initSimStats()
55
56 # Create the C++ sim objects and connect ports
57 root.createCCObject()
58 root.connectPorts()
59
60 # Do a second pass to finish initializing the sim objects
61 internal.core.initAll()
62
63 # Do a third pass to initialize statistics
64 internal.core.regAllStats()
65
66 # Check to make sure that the stats package is properly initialized
67 internal.stats.check()
68
69 # Reset to put the stats in a consistent state.
70 internal.stats.reset()
71
72def doDot(root):
73 dot = pydot.Dot()
74 instance.outputDot(dot)
75 dot.orientation = "portrait"
76 dot.size = "8.5,11"
77 dot.ranksep="equally"
78 dot.rank="samerank"
79 dot.write("config.dot")
80 dot.write_ps("config.ps")
81
82need_resume = []
83need_startup = True
84def simulate(*args, **kwargs):
85 global need_resume, need_startup
86
87 if need_startup:
88 internal.core.SimStartup()
89 need_startup = False
90
91 for root in need_resume:
92 resume(root)
93 need_resume = []
94
95 return internal.event.simulate(*args, **kwargs)
96
97# Export curTick to user script.
98def curTick():
99 return internal.core.cvar.curTick
100
101# Python exit handlers happen in reverse order. We want to dump stats last.
102atexit.register(internal.stats.dump)
103
104# register our C++ exit callback function with Python
105atexit.register(internal.core.doExitCleanup)
106
107# This loops until all objects have been fully drained.
108def doDrain(root):
109 all_drained = drain(root)
110 while (not all_drained):
111 all_drained = drain(root)
112
113# Tries to drain all objects. Draining might not be completed unless
114# all objects return that they are drained on the first call. This is
115# because as objects drain they may cause other objects to no longer
116# be drained.
117def drain(root):
118 all_drained = False
119 drain_event = internal.event.createCountedDrain()
120 unready_objects = root.startDrain(drain_event, True)
121 # If we've got some objects that can't drain immediately, then simulate
122 if unready_objects > 0:
123 drain_event.setCount(unready_objects)
124 simulate()
125 else:
126 all_drained = True
127 internal.event.cleanupCountedDrain(drain_event)
128 return all_drained
129
130def resume(root):
131 root.resume()
132
133def checkpoint(root, dir):
134 if not isinstance(root, objects.Root):
135 raise TypeError, "Checkpoint must be called on a root object."
136 doDrain(root)
137 print "Writing checkpoint"
138 internal.core.serializeAll(dir)
139 resume(root)
140
141def restoreCheckpoint(root, dir):
142 print "Restoring from checkpoint"
143 internal.core.unserializeAll(dir)
144 need_resume.append(root)
145
146def changeToAtomic(system):
147 if not isinstance(system, (objects.Root, objects.System)):
148 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \
149 (type(system), objects.Root, objects.System)
150 if system.getMemoryMode() != objects.params.atomic:
151 doDrain(system)
152 print "Changing memory mode to atomic"
153 system.changeTiming(objects.params.atomic)
154
155def changeToTiming(system):
156 if not isinstance(system, (objects.Root, objects.System)):
157 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \
158 (type(system), objects.Root, objects.System)
159
160 if system.getMemoryMode() != objects.params.timing:
161 doDrain(system)
162 print "Changing memory mode to timing"
163 system.changeTiming(objects.params.timing)
164
165def switchCpus(cpuList):
166 print "switching cpus"
167 if not isinstance(cpuList, list):
168 raise RuntimeError, "Must pass a list to this function"
169 for item in cpuList:
170 if not isinstance(item, tuple) or len(item) != 2:
171 raise RuntimeError, "List must have tuples of (oldCPU,newCPU)"
172
173 for old_cpu, new_cpu in cpuList:
174 if not isinstance(old_cpu, objects.BaseCPU):
175 raise TypeError, "%s is not of type BaseCPU" % old_cpu
176 if not isinstance(new_cpu, objects.BaseCPU):
177 raise TypeError, "%s is not of type BaseCPU" % new_cpu
178
179 # Now all of the CPUs are ready to be switched out
180 for old_cpu, new_cpu in cpuList:
181 old_cpu._ccObject.switchOut()
182
183 for old_cpu, new_cpu in cpuList:
184 new_cpu.takeOverFrom(old_cpu)
185
186from internal.core import disableAllListeners
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: Nathan Binkert
28# Steve Reinhardt
29
30import atexit
31import os
32import sys
33
34# import the SWIG-wrapped main C++ functions
35import internal
36from main import options
37import SimObject
38import ticks
39import objects
40
41# The final hook to generate .ini files. Called from the user script
42# once the config is built.
43def instantiate(root):
44 # we need to fix the global frequency
45 ticks.fixGlobalFrequency()
46
47 root.unproxy_all()
48
49 ini_file = file(os.path.join(options.outdir, 'config.ini'), 'w')
50 root.print_ini(ini_file)
51 ini_file.close() # close config.ini
52
53 # Initialize the global statistics
54 internal.stats.initSimStats()
55
56 # Create the C++ sim objects and connect ports
57 root.createCCObject()
58 root.connectPorts()
59
60 # Do a second pass to finish initializing the sim objects
61 internal.core.initAll()
62
63 # Do a third pass to initialize statistics
64 internal.core.regAllStats()
65
66 # Check to make sure that the stats package is properly initialized
67 internal.stats.check()
68
69 # Reset to put the stats in a consistent state.
70 internal.stats.reset()
71
72def doDot(root):
73 dot = pydot.Dot()
74 instance.outputDot(dot)
75 dot.orientation = "portrait"
76 dot.size = "8.5,11"
77 dot.ranksep="equally"
78 dot.rank="samerank"
79 dot.write("config.dot")
80 dot.write_ps("config.ps")
81
82need_resume = []
83need_startup = True
84def simulate(*args, **kwargs):
85 global need_resume, need_startup
86
87 if need_startup:
88 internal.core.SimStartup()
89 need_startup = False
90
91 for root in need_resume:
92 resume(root)
93 need_resume = []
94
95 return internal.event.simulate(*args, **kwargs)
96
97# Export curTick to user script.
98def curTick():
99 return internal.core.cvar.curTick
100
101# Python exit handlers happen in reverse order. We want to dump stats last.
102atexit.register(internal.stats.dump)
103
104# register our C++ exit callback function with Python
105atexit.register(internal.core.doExitCleanup)
106
107# This loops until all objects have been fully drained.
108def doDrain(root):
109 all_drained = drain(root)
110 while (not all_drained):
111 all_drained = drain(root)
112
113# Tries to drain all objects. Draining might not be completed unless
114# all objects return that they are drained on the first call. This is
115# because as objects drain they may cause other objects to no longer
116# be drained.
117def drain(root):
118 all_drained = False
119 drain_event = internal.event.createCountedDrain()
120 unready_objects = root.startDrain(drain_event, True)
121 # If we've got some objects that can't drain immediately, then simulate
122 if unready_objects > 0:
123 drain_event.setCount(unready_objects)
124 simulate()
125 else:
126 all_drained = True
127 internal.event.cleanupCountedDrain(drain_event)
128 return all_drained
129
130def resume(root):
131 root.resume()
132
133def checkpoint(root, dir):
134 if not isinstance(root, objects.Root):
135 raise TypeError, "Checkpoint must be called on a root object."
136 doDrain(root)
137 print "Writing checkpoint"
138 internal.core.serializeAll(dir)
139 resume(root)
140
141def restoreCheckpoint(root, dir):
142 print "Restoring from checkpoint"
143 internal.core.unserializeAll(dir)
144 need_resume.append(root)
145
146def changeToAtomic(system):
147 if not isinstance(system, (objects.Root, objects.System)):
148 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \
149 (type(system), objects.Root, objects.System)
150 if system.getMemoryMode() != objects.params.atomic:
151 doDrain(system)
152 print "Changing memory mode to atomic"
153 system.changeTiming(objects.params.atomic)
154
155def changeToTiming(system):
156 if not isinstance(system, (objects.Root, objects.System)):
157 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \
158 (type(system), objects.Root, objects.System)
159
160 if system.getMemoryMode() != objects.params.timing:
161 doDrain(system)
162 print "Changing memory mode to timing"
163 system.changeTiming(objects.params.timing)
164
165def switchCpus(cpuList):
166 print "switching cpus"
167 if not isinstance(cpuList, list):
168 raise RuntimeError, "Must pass a list to this function"
169 for item in cpuList:
170 if not isinstance(item, tuple) or len(item) != 2:
171 raise RuntimeError, "List must have tuples of (oldCPU,newCPU)"
172
173 for old_cpu, new_cpu in cpuList:
174 if not isinstance(old_cpu, objects.BaseCPU):
175 raise TypeError, "%s is not of type BaseCPU" % old_cpu
176 if not isinstance(new_cpu, objects.BaseCPU):
177 raise TypeError, "%s is not of type BaseCPU" % new_cpu
178
179 # Now all of the CPUs are ready to be switched out
180 for old_cpu, new_cpu in cpuList:
181 old_cpu._ccObject.switchOut()
182
183 for old_cpu, new_cpu in cpuList:
184 new_cpu.takeOverFrom(old_cpu)
185
186from internal.core import disableAllListeners