src/python/swig/event.i

   1 /*
   2  * Copyright (c) 2006 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  * Authors: Nathan Binkert
  29  */
  30
  31 %module event
  32
  33 %{
  34 #include "python/swig/pyevent.hh"
  35
  36 #include "sim/sim_events.hh"
  37 #include "sim/sim_exit.hh"
  38 #include "sim/simulate.hh"
  39 %}
  40
  41 %include "stdint.i"
  42 %include "std_string.i"
  43 %include "sim/host.hh"
  44
  45 void create(PyObject *object, Tick when);
  46
  47 class CountedDrainEvent
  48 {
  49   public:
  50     void setCount(int _count);
  51 };
  52
  53 CountedDrainEvent *createCountedDrain();
  54 void cleanupCountedDrain(Event *drain_event);
  55
  56 // minimal definition of SimExitEvent interface to wrap
  57 class SimLoopExitEvent {
  58   public:
  59     std::string getCause();
  60     int getCode();
  61     SimLoopExitEvent(EventQueue *q, Tick _when, Tick _repeat,
  62                      const std::string &_cause, int c = 0);
  63 };
  64
  65 %exception simulate {
  66     $action
  67     if (!result) {
  68         return NULL;
  69     }
  70 }
  71 SimLoopExitEvent *simulate(Tick num_cycles = MaxTick);
  72 void exitSimLoop(const std::string &message, int exit_code);
  73
  74 %wrapper %{
  75 // fix up module name to reflect the fact that it's inside the m5 package
  76 #undef SWIG_name
  77 #define SWIG_name "m5.internal._event"
  78 %}