src/sim/sim_exit.hh

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  *          Steve Reinhardt
  30  */
  31
  32 #ifndef __SIM_EXIT_HH__
  33 #define __SIM_EXIT_HH__
  34
  35 #include <string>
  36
  37 #include "sim/host.hh"
  38
  39 // forward declaration
  40 class Callback;
  41 class EventQueue;
  42 class SimLoopExitEvent;
  43
  44 /// Register a callback to be called when Python exits.  Defined in
  45 /// sim/main.cc.
  46 void registerExitCallback(Callback *);
  47
  48 /// Schedule an event to exit the simulation loop (returning to
  49 /// Python) at the indicated tick.  The message and exit_code
  50 /// parameters are saved in the SimLoopExitEvent to indicate why the
  51 /// exit occurred.
  52 SimLoopExitEvent *schedExitSimLoop(const std::string &message, Tick when,
  53                                    Tick repeat = 0, EventQueue *q = NULL,
  54                                    int exit_code = 0);
  55
  56 /// Schedule an event to exit the simulation loop (returning to
  57 /// Python) at the end of the current cycle (curTick).  The message
  58 /// and exit_code parameters are saved in the SimLoopExitEvent to
  59 /// indicate why the exit occurred.
  60 void exitSimLoop(const std::string &message, int exit_code = 0);
  61
  62 #endif // __SIM_EXIT_HH__