1 # Copyright (c) 2015 ARM Limited
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.
13 # Redistribution and use in source and binary forms, with or without
14 # modification, are permitted provided that the following conditions are
15 # met: redistributions of source code must retain the above copyright
16 # notice, this list of conditions and the following disclaimer;
17 # redistributions in binary form must reproduce the above copyright
18 # notice, this list of conditions and the following disclaimer in the
19 # documentation and/or other materials provided with the distribution;
20 # neither the name of the copyright holders nor the names of its
21 # contributors may be used to endorse or promote products derived from
22 # this software without specific prior written permission.
24 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 # Authors: Andreas Sandberg
38 from __future__
import print_function
40 from multiprocessing
import Process
47 "target called exit()",
48 "m5_exit instruction encountered",
52 "simulate() limit reached",
57 _exitcode_checkpoint
= 42
60 def _run_step(name
, restore
=None, interval
=0.5):
62 Instantiate (optionally from a checkpoint if restore is set to the
63 checkpoitn name) the system and run for interval seconds of
64 simulated time. At the end of the simulation interval, create a
67 As this function is intended to run in its own process using the
68 multiprocessing framework, the exit is a true call to exit which
69 terminates the process. Exit codes are used to pass information to
72 if restore
is not None:
73 m5
.instantiate(restore
)
77 e
= m5
.simulate(m5
.ticks
.fromSeconds(interval
))
79 if cause
in _exit_limit
:
81 sys
.exit(_exitcode_checkpoint
)
82 elif cause
in _exit_normal
:
83 sys
.exit(_exitcode_done
)
85 print("Test failed: Unknown exit cause: %s" % cause
)
86 sys
.exit(_exitcode_fail
)
88 def run_test(root
, interval
=0.5, max_checkpoints
=5):
90 Run the simulated system for a fixed amount of time and take a
91 checkpoint, then restore from the same checkpoint and run until
92 the system calls m5 exit.
95 cpt_name
= os
.path
.join(m5
.options
.outdir
, "test.cpt")
98 for cpt_no
in range(max_checkpoints
):
99 # Create a checkpoint from a separate child process. This enables
100 # us to get back to a (mostly) pristine state and restart
101 # simulation from the checkpoint.
102 p
= Process(target
=_run_step
,
106 "interval" : interval
,
110 # Wait for the child to return
113 # Restore from the checkpoint next iteration
116 if p
.exitcode
== _exitcode_done
:
117 print("Test done.", file=sys
.stderr
)
119 elif p
.exitcode
== _exitcode_checkpoint
:
122 print("Test failed.", file=sys
.stderr
)
125 # Maximum number of checkpoints reached. Just run full-speed from
130 if cause
in _exit_normal
:
133 print("Test failed: Unknown exit cause: %s" % cause
)