~swilson/gem5-docs/sim__exit_8hh_source.html

 /*

  * Copyright (c) 2003-2005 The Regents of The University of Michigan

  * All rights reserved.

  *

  * Redistribution and use in source and binary forms, with or without

  * modification, are permitted provided that the following conditions are

  * met: redistributions of source code must retain the above copyright

  * notice, this list of conditions and the following disclaimer;

  * redistributions in binary form must reproduce the above copyright

  * notice, this list of conditions and the following disclaimer in the

  * documentation and/or other materials provided with the distribution;

  * neither the name of the copyright holders nor the names of its

  * contributors may be used to endorse or promote products derived from

  * this software without specific prior written permission.

  *

  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  *

  * Authors: Nathan Binkert

  *          Steve Reinhardt

  */


 #ifndef __SIM_EXIT_HH__

 #define __SIM_EXIT_HH__


 #include <string>


 #include "base/types.hh"


 Tick curTick();


 // forward declaration

 class Callback;


 void registerExitCallback(Callback *);


 void exitSimLoop(const std::string &message, int exit_code = 0,

                  Tick when = curTick(), Tick repeat = 0,

                  bool serialize = false);


 #endif // __SIM_EXIT_HH__

Callback
Generic callback class.
Definition: callback.hh:41

registerExitCallback
void registerExitCallback(Callback *)
Register a callback to be called when Python exits.
Definition: core.cc:116

curTick
Tick curTick()
The universal simulation clock.
Definition: core.hh:47

Tick
uint64_t Tick
Tick count type.
Definition: types.hh:63

types.hh
Defines global host-dependent types: Counter, Tick, and (indirectly) {int,uint}{8,16,32,64}_t.

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:83

X86ISA::serialize
void serialize(CheckpointOut &cp) const override