tests/configs/checkpoint.py

   1 # Copyright (c) 2015, 2020 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 # 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.
  23 #
  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.
  35
  36 from __future__ import print_function
  37
  38 from multiprocessing import Process
  39 import sys
  40 import os
  41
  42 import m5
  43
  44 _exit_normal = (
  45     "target called exit()",
  46     "m5_exit instruction encountered",
  47     )
  48
  49 _exit_limit = (
  50     "simulate() limit reached",
  51     )
  52
  53 _exitcode_done = 0
  54 _exitcode_fail = 1
  55 _exitcode_checkpoint = 42
  56
  57
  58 def _run_step(name, restore=None, interval=0.5):
  59     """
  60     Instantiate (optionally from a checkpoint if restore is set to the
  61     checkpoitn name) the system and run for interval seconds of
  62     simulated time. At the end of the simulation interval, create a
  63     checkpoint and exit.
  64
  65     As this function is intended to run in its own process using the
  66     multiprocessing framework, the exit is a true call to exit which
  67     terminates the process. Exit codes are used to pass information to
  68     the parent.
  69     """
  70     if restore is not None:
  71         m5.instantiate(restore)
  72     else:
  73         m5.instantiate()
  74
  75     e = m5.simulate(m5.ticks.fromSeconds(interval))
  76     cause = e.getCause()
  77     if cause in _exit_limit:
  78         m5.checkpoint(name)
  79         sys.exit(_exitcode_checkpoint)
  80     elif cause in _exit_normal:
  81         sys.exit(_exitcode_done)
  82     else:
  83         print("Test failed: Unknown exit cause: %s" % cause)
  84         sys.exit(_exitcode_fail)
  85
  86 def run_test(root, interval=0.5, max_checkpoints=5):
  87     """
  88     Run the simulated system for a fixed amount of time and take a
  89     checkpoint, then restore from the same checkpoint and run until
  90     the system calls m5 exit.
  91     """
  92
  93     cpt_name = os.path.join(m5.options.outdir, "test.cpt")
  94     restore = None
  95     checkpointed = False
  96
  97     for cpt_no in range(max_checkpoints):
  98         # Create a checkpoint from a separate child process. This enables
  99         # us to get back to a (mostly) pristine state and restart
 100         # simulation from the checkpoint.
 101         p = Process(target=_run_step,
 102                     args=(cpt_name, ),
 103                     kwargs={
 104                 "restore" : restore,
 105                 "interval" : interval,
 106                 })
 107         p.start()
 108
 109         # Wait for the child to return
 110         p.join()
 111
 112         # Restore from the checkpoint next iteration
 113         restore = cpt_name
 114
 115         if p.exitcode == _exitcode_done:
 116             if checkpointed:
 117                 print("Test done.", file=sys.stderr)
 118                 sys.exit(0)
 119             else:
 120                 print("Test done, but no checkpoint was created.",
 121                     file=sys.stderr)
 122                 sys.exit(1)
 123         elif p.exitcode == _exitcode_checkpoint:
 124             checkpointed = True
 125         else:
 126             print("Test failed.", file=sys.stderr)
 127             sys.exit(1)
 128
 129     # Maximum number of checkpoints reached. Just run full-speed from
 130     # now on.
 131     m5.instantiate()
 132     e = m5.simulate()
 133     cause = e.getCause()
 134     if cause in _exit_normal:
 135         sys.exit(0)
 136     else:
 137         print("Test failed: Unknown exit cause: %s" % cause)
 138         sys.exit(1)