sim_exit.hh revision 13694:51669166f428 
111219Snilay@cs.wisc.edu/*
211219Snilay@cs.wisc.edu * Copyright (c) 2003-2005 The Regents of The University of Michigan
38348SN/A * All rights reserved.
48348SN/A *
54304SN/A * Redistribution and use in source and binary forms, with or without
611219Snilay@cs.wisc.edu * modification, are permitted provided that the following conditions are
711219Snilay@cs.wisc.edu * met: redistributions of source code must retain the above copyright
811219Snilay@cs.wisc.edu * notice, this list of conditions and the following disclaimer;
911219Snilay@cs.wisc.edu * redistributions in binary form must reproduce the above copyright
1011219Snilay@cs.wisc.edu * notice, this list of conditions and the following disclaimer in the
114304SN/A * documentation and/or other materials provided with the distribution;
125723SN/A * neither the name of the copyright holders nor the names of its
135876SN/A * contributors may be used to endorse or promote products derived from
1411219Snilay@cs.wisc.edu * 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 "base/types.hh"
38
39Tick curTick();
40
41// forward declaration
42class Callback;
43
44/// Register a callback to be called when Python exits.  Defined in
45/// sim/main.cc.
46void registerExitCallback(Callback *);
47
48/// Schedule an event to exit the simulation loop (returning to
49/// Python) at the end of the current cycle (curTick()).  The message
50/// and exit_code parameters are saved in the SimLoopExitEvent to
51/// indicate why the exit occurred.
52void exitSimLoop(const std::string &message, int exit_code = 0,
53                 Tick when = curTick(), Tick repeat = 0,
54                 bool serialize = false);
55/// Schedule an event as above, but make it high priority so it runs before
56/// any normal events which are schedule at the current time.
57void exitSimLoopNow(const std::string &message, int exit_code = 0,
58                    Tick repeat = 0, bool serialize = false);
59
60#endif // __SIM_EXIT_HH__
61