sim_exit.hh revision 13694
12SN/A/* 21762SN/A * Copyright (c) 2003-2005 The Regents of The University of Michigan 32SN/A * All rights reserved. 42SN/A * 52SN/A * Redistribution and use in source and binary forms, with or without 62SN/A * modification, are permitted provided that the following conditions are 72SN/A * met: redistributions of source code must retain the above copyright 82SN/A * notice, this list of conditions and the following disclaimer; 92SN/A * redistributions in binary form must reproduce the above copyright 102SN/A * notice, this list of conditions and the following disclaimer in the 112SN/A * documentation and/or other materials provided with the distribution; 122SN/A * neither the name of the copyright holders nor the names of its 132SN/A * contributors may be used to endorse or promote products derived from 142SN/A * this software without specific prior written permission. 152SN/A * 162SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665Ssaidi@eecs.umich.edu * 282665Ssaidi@eecs.umich.edu * Authors: Nathan Binkert 292665Ssaidi@eecs.umich.edu * Steve Reinhardt 302SN/A */ 312SN/A 322SN/A#ifndef __SIM_EXIT_HH__ 332SN/A#define __SIM_EXIT_HH__ 342SN/A 352SN/A#include <string> 362SN/A 376214Snate@binkert.org#include "base/types.hh" 3811800Sbrandon.potter@amd.com 3911800Sbrandon.potter@amd.comTick curTick(); 40298SN/A 412667Sstever@eecs.umich.edu// forward declaration 422SN/Aclass Callback; 432SN/A 442667Sstever@eecs.umich.edu/// Register a callback to be called when Python exits. Defined in 452667Sstever@eecs.umich.edu/// sim/main.cc. 462SN/Avoid registerExitCallback(Callback *); 472SN/A 482667Sstever@eecs.umich.edu/// Schedule an event to exit the simulation loop (returning to 497823Ssteve.reinhardt@amd.com/// Python) at the end of the current cycle (curTick()). The message 502667Sstever@eecs.umich.edu/// and exit_code parameters are saved in the SimLoopExitEvent to 512667Sstever@eecs.umich.edu/// indicate why the exit occurred. 527819Ssteve.reinhardt@amd.comvoid exitSimLoop(const std::string &message, int exit_code = 0, 539952Sdam.sunwoo@arm.com Tick when = curTick(), Tick repeat = 0, 549952Sdam.sunwoo@arm.com bool serialize = false); 5513694Sgabeblack@google.com/// Schedule an event as above, but make it high priority so it runs before 5613694Sgabeblack@google.com/// any normal events which are schedule at the current time. 5713694Sgabeblack@google.comvoid exitSimLoopNow(const std::string &message, int exit_code = 0, 5813694Sgabeblack@google.com Tick repeat = 0, bool serialize = false); 592SN/A 602SN/A#endif // __SIM_EXIT_HH__ 61