gem5  v20.1.0.0
sim_exit.hh
Go to the documentation of this file.
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 
29 #ifndef __SIM_EXIT_HH__
30 #define __SIM_EXIT_HH__
31 
32 #include <string>
33 
34 #include "base/types.hh"
35 
36 Tick curTick();
37 
40 void registerExitCallback(const std::function<void()> &);
41 
46 void exitSimLoop(const std::string &message, int exit_code = 0,
47  Tick when = curTick(), Tick repeat = 0,
48  bool serialize = false);
51 void exitSimLoopNow(const std::string &message, int exit_code = 0,
52  Tick repeat = 0, bool serialize = false);
53 
54 #endif // __SIM_EXIT_HH__
curTick
Tick curTick()
The universal simulation clock.
Definition: core.hh:45
Tick
uint64_t Tick
Tick count type.
Definition: types.hh:63
serialize
void serialize(const ThreadContext &tc, CheckpointOut &cp)
Thread context serialization helpers.
Definition: thread_context.cc:142
exitSimLoop
void exitSimLoop(const std::string &message, int exit_code=0, Tick when=curTick(), Tick repeat=0, bool serialize=false)
Schedule an event to exit the simulation loop (returning to Python) at the end of the current cycle (...
Definition: sim_events.cc:88
exitSimLoopNow
void exitSimLoopNow(const std::string &message, int exit_code=0, Tick repeat=0, bool serialize=false)
Schedule an event as above, but make it high priority so it runs before any normal events which are s...
Definition: sim_events.cc:99
types.hh
registerExitCallback
void registerExitCallback(const std::function< void()> &)
Register a callback to be called when Python exits.
Definition: core.cc:140

Generated on Wed Sep 30 2020 14:02:14 for gem5 by doxygen 1.8.17