develop/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.

 */


#ifndef __SIM_EXIT_HH__

#define __SIM_EXIT_HH__


#include <functional>

#include <map>

#include <string>


#include "base/types.hh"


namespace gem5

{


Tick curTick();


void registerExitCallback(const std::function<void()> &);


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

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

                 bool serialize = false);

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

                    Tick repeat = 0, bool serialize = false);


void exitSimLoopWithHypercall(const std::string &message, int exit_code,

                              Tick when, Tick repeat,

                              std::map<std::string, std::string> payload,

                              uint64_t hypercall_id, bool serialize);


void exitSimulationLoop(uint64_t type_id,

    std::map<std::string, std::string> payload=

        std::map<std::string, std::string>(),

    Tick when=curTick());


void

exitSimulationLoopNow(uint64_t type_id,

    std::map<std::string, std::string> payload=

        std::map<std::string, std::string>());


} // namespace gem5


#endif // __SIM_EXIT_HH__

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

gem5
Copyright (c) 2024 Arm Limited All rights reserved.
Definition binary32.hh:36

gem5::curTick
Tick curTick()
The universal simulation clock.
Definition cur_tick.hh:46

gem5::exitSimLoopWithHypercall
void exitSimLoopWithHypercall(const::std::string &message, int exit_code, Tick when, Tick repeat, std::map< std::string, std::string > payload, uint64_t hypercall_id, bool serialize)
Definition sim_events.cc:130

gem5::exitSimLoop
void exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat, bool serialize)
The "old style" exitSimLoop functions.
Definition sim_events.cc:111

gem5::Tick
uint64_t Tick
Tick count type.
Definition types.hh:58

gem5::serialize
void serialize(const ThreadContext &tc, CheckpointOut &cp)
Thread context serialization helpers.
Definition thread_context.cc:195

gem5::registerExitCallback
void registerExitCallback(const std::function< void()> &callback)
Register an exit callback.
Definition core.cc:143

gem5::exitSimLoopNow
void exitSimLoopNow(const std::string &message, int exit_code, Tick repeat, bool serialize)
Schedule an event as above, but make it high priority so it runs before any normal events which are s...
Definition sim_events.cc:123

gem5::exitSimulationLoopNow
void exitSimulationLoopNow(uint64_t type_id, std::map< std::string, std::string > payload)
Definition sim_events.cc:148

gem5::exitSimulationLoop
void exitSimulationLoop(uint64_t type_id, std::map< std::string, std::string > payload, Tick when)
The "new style" exitSimLoop functions.
Definition sim_events.cc:141