1 # Copyright (c) 2005 The Regents of The University of Michigan
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.
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.
27 # Authors: Nathan Binkert
30 import atexit
, os
, sys
32 # import the SWIG-wrapped main C++ functions
34 # import a few SWIG-wrapped items (those that are likely to be used
35 # directly by user scripts) completely into this module for
37 from cc_main
import simulate
, SimLoopExitEvent
39 # import the m5 compile options
42 # define this here so we can use it right away if necessary
44 print >>sys
.stderr
, 'panic:', string
47 # Prepend given directory to system module search path. We may not
48 # need this anymore if we can structure our config library more like a
51 # if it's a relative path and we know what directory the current
52 # python script is in, make the path relative to that directory.
53 if not os
.path
.isabs(path
) and sys
.path
[0]:
54 path
= os
.path
.join(sys
.path
[0], path
)
55 path
= os
.path
.realpath(path
)
56 # sys.path[0] should always refer to the current script's directory,
57 # so place the new dir right after that.
58 sys
.path
.insert(1, path
)
60 # make a SmartDict out of the build options for our local use
62 build_env
= smartdict
.SmartDict()
63 build_env
.update(defines
.m5_build_env
)
65 # make a SmartDict out of the OS environment too
66 env
= smartdict
.SmartDict()
67 env
.update(os
.environ
)
69 # Function to provide to C++ so it can look up instances based on paths
70 def resolveSimObject(name
):
71 obj
= config
.instanceDict
[name
]
72 return obj
.getCCObject()
74 from main
import options
, arguments
, main
76 # The final hook to generate .ini files. Called from the user script
77 # once the config is built.
78 def instantiate(root
):
79 config
.ticks_per_sec
= float(root
.clock
.frequency
)
80 # ugly temporary hack to get output to config.ini
81 sys
.stdout
= file(os
.path
.join(options
.outdir
, 'config.ini'), 'w')
83 sys
.stdout
.close() # close config.ini
84 sys
.stdout
= sys
.__stdout
__ # restore to original
85 cc_main
.loadIniFile(resolveSimObject
) # load config.ini into C++
89 noDot
= True # temporary until we fix dot
92 instance
.outputDot(dot
)
93 dot
.orientation
= "portrait"
97 dot
.write("config.dot")
98 dot
.write_ps("config.ps")
100 # Export curTick to user script.
102 return cc_main
.cvar
.curTick
104 # register our C++ exit callback function with Python
105 atexit
.register(cc_main
.doExitCleanup
)
107 # This import allows user scripts to reference 'm5.objects.Foo' after
108 # just doing an 'import m5' (without an 'import m5.objects'). May not
109 # matter since most scripts will probably 'from m5.objects import *'.
112 # This loops until all objects have been fully drained.
114 all_drained
= drain(root
)
115 while (not all_drained
):
116 all_drained
= drain(root
)
118 # Tries to drain all objects. Draining might not be completed unless
119 # all objects return that they are drained on the first call. This is
120 # because as objects drain they may cause other objects to no longer
124 drain_event
= cc_main
.createCountedDrain()
125 unready_objects
= root
.startDrain(drain_event
, True)
126 # If we've got some objects that can't drain immediately, then simulate
127 if unready_objects
> 0:
128 drain_event
.setCount(unready_objects
)
132 cc_main
.cleanupCountedDrain(drain_event
)
138 def checkpoint(root
, dir):
139 if not isinstance(root
, objects
.Root
):
140 raise TypeError, "Object is not a root object. Checkpoint must be called on a root object."
142 print "Writing checkpoint"
143 cc_main
.serializeAll(dir)
146 def restoreCheckpoint(root
, dir):
147 print "Restoring from checkpoint"
148 cc_main
.unserializeAll(dir)
151 def changeToAtomic(system
):
152 if not isinstance(system
, objects
.Root
) and not isinstance(system
, System
):
153 raise TypeError, "Object is not a root or system object. Checkpoint must be "
154 "called on a root object."
156 print "Changing memory mode to atomic"
157 system
.changeTiming(cc_main
.SimObject
.Atomic
)
160 def changeToTiming(system
):
161 if not isinstance(system
, objects
.Root
) and not isinstance(system
, System
):
162 raise TypeError, "Object is not a root or system object. Checkpoint must be "
163 "called on a root object."
165 print "Changing memory mode to timing"
166 system
.changeTiming(cc_main
.SimObject
.Timing
)
169 def switchCpus(cpuList
):
170 if not isinstance(cpuList
, list):
171 raise RuntimeError, "Must pass a list to this function"
173 if not isinstance(i
, tuple):
174 raise RuntimeError, "List must have tuples of (oldCPU,newCPU)"
176 [old_cpus
, new_cpus
] = zip(*cpuList
)
179 if not isinstance(cpu
, objects
.BaseCPU
):
180 raise TypeError, "%s is not of type BaseCPU", cpu
182 if not isinstance(cpu
, objects
.BaseCPU
):
183 raise TypeError, "%s is not of type BaseCPU", cpu
185 # Drain all of the individual CPUs
186 drain_event
= cc_main
.createCountedDrain()
188 for old_cpu
in old_cpus
:
189 unready_cpus
+= old_cpu
.startDrain(drain_event
, False)
190 # If we've got some objects that can't drain immediately, then simulate
192 drain_event
.setCount(unready_cpus
)
194 cc_main
.cleanupCountedDrain(drain_event
)
195 # Now all of the CPUs are ready to be switched out
196 for old_cpu
in old_cpus
:
197 old_cpu
._ccObject
.switchOut()
199 print "Switching CPUs"
200 for new_cpu
in new_cpus
:
201 new_cpu
.takeOverFrom(old_cpus
[index
])
202 new_cpu
._ccObject
.resume()