1# Copyright (c) 2012 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder. You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Copyright (c) 2005 The Regents of The University of Michigan
14# Copyright (c) 2010 Advanced Micro Devices, Inc.
15# All rights reserved.
16#
17# Redistribution and use in source and binary forms, with or without
18# modification, are permitted provided that the following conditions are
19# met: redistributions of source code must retain the above copyright
20# notice, this list of conditions and the following disclaimer;
21# redistributions in binary form must reproduce the above copyright
22# notice, this list of conditions and the following disclaimer in the
23# documentation and/or other materials provided with the distribution;
24# neither the name of the copyright holders nor the names of its
25# contributors may be used to endorse or promote products derived from
26# this software without specific prior written permission.
27#
28# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39#
40# Authors: Nathan Binkert
41# Steve Reinhardt
42
43import atexit
44import os
45import sys
46
47# import the SWIG-wrapped main C++ functions
48import internal
49import core
50import stats
51import SimObject
52import ticks
53import objects
54from m5.util.dot_writer import do_dot
55from m5.internal.stats import updateEvents as updateStatEvents
56
57from util import fatal
58from util import attrdict
59
60# define a MaxTick parameter
61MaxTick = 2**63 - 1
62
63# The final hook to generate .ini files. Called from the user script
64# once the config is built.
65def instantiate(ckpt_dir=None):
66 from m5 import options
67
68 root = objects.Root.getInstance()
69
70 if not root:
71 fatal("Need to instantiate Root() before calling instantiate()")
72
73 # we need to fix the global frequency
74 ticks.fixGlobalFrequency()
75
76 # Make sure SimObject-valued params are in the configuration
77 # hierarchy so we catch them with future descendants() walks
78 for obj in root.descendants(): obj.adoptOrphanParams()
79
80 # Unproxy in sorted order for determinism
81 for obj in root.descendants(): obj.unproxyParams()
82
83 if options.dump_config:
84 ini_file = file(os.path.join(options.outdir, options.dump_config), 'w')
85 # Print ini sections in sorted order for easier diffing
86 for obj in sorted(root.descendants(), key=lambda o: o.path()):
87 obj.print_ini(ini_file)
88 ini_file.close()
89
90 if options.json_config:
91 try:
92 import json
93 json_file = file(os.path.join(options.outdir, options.json_config), 'w')
94 d = root.get_config_as_dict()
95 json.dump(d, json_file, indent=4)
96 json_file.close()
97 except ImportError:
98 pass
99
100 do_dot(root, options.outdir, options.dot_config)
101
102 # Initialize the global statistics
103 stats.initSimStats()
104
105 # Create the C++ sim objects and connect ports
106 for obj in root.descendants(): obj.createCCObject()
107 for obj in root.descendants(): obj.connectPorts()
108
109 # Do a second pass to finish initializing the sim objects
110 for obj in root.descendants(): obj.init()
111
112 # Do a third pass to initialize statistics
113 for obj in root.descendants(): obj.regStats()
114
115 # We're done registering statistics. Enable the stats package now.
116 stats.enable()
117
118 # Restore checkpoint (if any)
119 if ckpt_dir:
120 ckpt = internal.core.getCheckpoint(ckpt_dir)
121 internal.core.unserializeGlobals(ckpt);
122 for obj in root.descendants(): obj.loadState(ckpt)
123 need_resume.append(root)
124 else:
125 for obj in root.descendants(): obj.initState()
126
127 # Check to see if any of the stat events are in the past after resuming from
128 # a checkpoint, If so, this call will shift them to be at a valid time.
129 updateStatEvents()
130
131 # Reset to put the stats in a consistent state.
132 stats.reset()
133
134need_resume = []
135need_startup = True
136def simulate(*args, **kwargs):
137 global need_resume, need_startup
138
139 if need_startup:
140 root = objects.Root.getInstance()
141 for obj in root.descendants(): obj.startup()
142 need_startup = False
143
144 for root in need_resume:
145 resume(root)
146 need_resume = []
147
148 return internal.event.simulate(*args, **kwargs)
149
150# Export curTick to user script.
151def curTick():
152 return internal.core.curTick()
153
154# Python exit handlers happen in reverse order. We want to dump stats last.
155atexit.register(stats.dump)
156
157# register our C++ exit callback function with Python
158atexit.register(internal.core.doExitCleanup)
159
160# Drain the system in preparation of a checkpoint or memory mode
161# switch.
162def drain(root):
163 # Try to drain all objects. Draining might not be completed unless
164 # all objects return that they are drained on the first call. This
165 # is because as objects drain they may cause other objects to no
166 # longer be drained.
167 def _drain():
168 all_drained = False
169 dm = internal.drain.createDrainManager()
170 unready_objs = sum(obj.drain(dm) for obj in root.descendants())
171 # If we've got some objects that can't drain immediately, then simulate
172 if unready_objs > 0:
173 dm.setCount(unready_objs)
174 simulate()
175 else:
176 all_drained = True
177 internal.drain.cleanupDrainManager(dm)
178 return all_drained
179
180 all_drained = _drain()
181 while (not all_drained):
182 all_drained = _drain()
183
184def memWriteback(root):
185 for obj in root.descendants():
186 obj.memWriteback()
187
188def memInvalidate(root):
189 for obj in root.descendants():
190 obj.memInvalidate()
191
192def resume(root):
193 for obj in root.descendants(): obj.drainResume()
194
195def checkpoint(dir):
196 root = objects.Root.getInstance()
197 if not isinstance(root, objects.Root):
198 raise TypeError, "Checkpoint must be called on a root object."
199 drain(root)
200 memWriteback(root)
201 print "Writing checkpoint"
202 internal.core.serializeAll(dir)
203 resume(root)
204
205def changeMemoryMode(system, mode):
206 if not isinstance(system, (objects.Root, objects.System)):
207 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \
208 (type(system), objects.Root, objects.System)
209 if system.getMemoryMode() != mode:
210 drain(system)
211 system.setMemoryMode(mode)
212 else:
213 print "System already in target mode. Memory mode unchanged."
214
215def changeToAtomic(system, **kwargs):
216 print "Changing memory mode to atomic"
217 changeMemoryMode(system, objects.params.atomic, **kwargs)
218
219def changeToTiming(system, **kwargs):
220 print "Changing memory mode to timing"
221 changeMemoryMode(system, objects.params.timing, **kwargs)
222
223def switchCpus(cpuList):
224 print "switching cpus"
225 if not isinstance(cpuList, list):
226 raise RuntimeError, "Must pass a list to this function"
227 for item in cpuList:
228 if not isinstance(item, tuple) or len(item) != 2:
229 raise RuntimeError, "List must have tuples of (oldCPU,newCPU)"
230
| 1# Copyright (c) 2012 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder. You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Copyright (c) 2005 The Regents of The University of Michigan
14# Copyright (c) 2010 Advanced Micro Devices, Inc.
15# All rights reserved.
16#
17# Redistribution and use in source and binary forms, with or without
18# modification, are permitted provided that the following conditions are
19# met: redistributions of source code must retain the above copyright
20# notice, this list of conditions and the following disclaimer;
21# redistributions in binary form must reproduce the above copyright
22# notice, this list of conditions and the following disclaimer in the
23# documentation and/or other materials provided with the distribution;
24# neither the name of the copyright holders nor the names of its
25# contributors may be used to endorse or promote products derived from
26# this software without specific prior written permission.
27#
28# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39#
40# Authors: Nathan Binkert
41# Steve Reinhardt
42
43import atexit
44import os
45import sys
46
47# import the SWIG-wrapped main C++ functions
48import internal
49import core
50import stats
51import SimObject
52import ticks
53import objects
54from m5.util.dot_writer import do_dot
55from m5.internal.stats import updateEvents as updateStatEvents
56
57from util import fatal
58from util import attrdict
59
60# define a MaxTick parameter
61MaxTick = 2**63 - 1
62
63# The final hook to generate .ini files. Called from the user script
64# once the config is built.
65def instantiate(ckpt_dir=None):
66 from m5 import options
67
68 root = objects.Root.getInstance()
69
70 if not root:
71 fatal("Need to instantiate Root() before calling instantiate()")
72
73 # we need to fix the global frequency
74 ticks.fixGlobalFrequency()
75
76 # Make sure SimObject-valued params are in the configuration
77 # hierarchy so we catch them with future descendants() walks
78 for obj in root.descendants(): obj.adoptOrphanParams()
79
80 # Unproxy in sorted order for determinism
81 for obj in root.descendants(): obj.unproxyParams()
82
83 if options.dump_config:
84 ini_file = file(os.path.join(options.outdir, options.dump_config), 'w')
85 # Print ini sections in sorted order for easier diffing
86 for obj in sorted(root.descendants(), key=lambda o: o.path()):
87 obj.print_ini(ini_file)
88 ini_file.close()
89
90 if options.json_config:
91 try:
92 import json
93 json_file = file(os.path.join(options.outdir, options.json_config), 'w')
94 d = root.get_config_as_dict()
95 json.dump(d, json_file, indent=4)
96 json_file.close()
97 except ImportError:
98 pass
99
100 do_dot(root, options.outdir, options.dot_config)
101
102 # Initialize the global statistics
103 stats.initSimStats()
104
105 # Create the C++ sim objects and connect ports
106 for obj in root.descendants(): obj.createCCObject()
107 for obj in root.descendants(): obj.connectPorts()
108
109 # Do a second pass to finish initializing the sim objects
110 for obj in root.descendants(): obj.init()
111
112 # Do a third pass to initialize statistics
113 for obj in root.descendants(): obj.regStats()
114
115 # We're done registering statistics. Enable the stats package now.
116 stats.enable()
117
118 # Restore checkpoint (if any)
119 if ckpt_dir:
120 ckpt = internal.core.getCheckpoint(ckpt_dir)
121 internal.core.unserializeGlobals(ckpt);
122 for obj in root.descendants(): obj.loadState(ckpt)
123 need_resume.append(root)
124 else:
125 for obj in root.descendants(): obj.initState()
126
127 # Check to see if any of the stat events are in the past after resuming from
128 # a checkpoint, If so, this call will shift them to be at a valid time.
129 updateStatEvents()
130
131 # Reset to put the stats in a consistent state.
132 stats.reset()
133
134need_resume = []
135need_startup = True
136def simulate(*args, **kwargs):
137 global need_resume, need_startup
138
139 if need_startup:
140 root = objects.Root.getInstance()
141 for obj in root.descendants(): obj.startup()
142 need_startup = False
143
144 for root in need_resume:
145 resume(root)
146 need_resume = []
147
148 return internal.event.simulate(*args, **kwargs)
149
150# Export curTick to user script.
151def curTick():
152 return internal.core.curTick()
153
154# Python exit handlers happen in reverse order. We want to dump stats last.
155atexit.register(stats.dump)
156
157# register our C++ exit callback function with Python
158atexit.register(internal.core.doExitCleanup)
159
160# Drain the system in preparation of a checkpoint or memory mode
161# switch.
162def drain(root):
163 # Try to drain all objects. Draining might not be completed unless
164 # all objects return that they are drained on the first call. This
165 # is because as objects drain they may cause other objects to no
166 # longer be drained.
167 def _drain():
168 all_drained = False
169 dm = internal.drain.createDrainManager()
170 unready_objs = sum(obj.drain(dm) for obj in root.descendants())
171 # If we've got some objects that can't drain immediately, then simulate
172 if unready_objs > 0:
173 dm.setCount(unready_objs)
174 simulate()
175 else:
176 all_drained = True
177 internal.drain.cleanupDrainManager(dm)
178 return all_drained
179
180 all_drained = _drain()
181 while (not all_drained):
182 all_drained = _drain()
183
184def memWriteback(root):
185 for obj in root.descendants():
186 obj.memWriteback()
187
188def memInvalidate(root):
189 for obj in root.descendants():
190 obj.memInvalidate()
191
192def resume(root):
193 for obj in root.descendants(): obj.drainResume()
194
195def checkpoint(dir):
196 root = objects.Root.getInstance()
197 if not isinstance(root, objects.Root):
198 raise TypeError, "Checkpoint must be called on a root object."
199 drain(root)
200 memWriteback(root)
201 print "Writing checkpoint"
202 internal.core.serializeAll(dir)
203 resume(root)
204
205def changeMemoryMode(system, mode):
206 if not isinstance(system, (objects.Root, objects.System)):
207 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \
208 (type(system), objects.Root, objects.System)
209 if system.getMemoryMode() != mode:
210 drain(system)
211 system.setMemoryMode(mode)
212 else:
213 print "System already in target mode. Memory mode unchanged."
214
215def changeToAtomic(system, **kwargs):
216 print "Changing memory mode to atomic"
217 changeMemoryMode(system, objects.params.atomic, **kwargs)
218
219def changeToTiming(system, **kwargs):
220 print "Changing memory mode to timing"
221 changeMemoryMode(system, objects.params.timing, **kwargs)
222
223def switchCpus(cpuList):
224 print "switching cpus"
225 if not isinstance(cpuList, list):
226 raise RuntimeError, "Must pass a list to this function"
227 for item in cpuList:
228 if not isinstance(item, tuple) or len(item) != 2:
229 raise RuntimeError, "List must have tuples of (oldCPU,newCPU)"
230
|