sim,misc: Rename M5OP_ANNOTATE to M5OP_RESERVED1.

[gem5.git] / src / sim / debug.hh

diff --git a/src/sim/debug.hh b/src/sim/debug.hh
index 79792234be579e89616617fbb277bb09a905ba6d..d2659141de374473670f23b83b5be5d9d8b16012 100644 (file)
--- a/src/sim/debug.hh
+++ b/src/sim/debug.hh
@@ -24,13 +24,42 @@
  * 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
  */
 
-#ifndef __DEBUG_HH__
-#define __DEBUG_HH__
+#ifndef __SIM_DEBUG_HH__
+#define __SIM_DEBUG_HH__
+
+#include "base/types.hh"
+
+/** @file This file provides the definitions for some useful debugging
+ * functions. These are intended to be called from a debugger such as
+ * gdb.
+ */
+
+
+/** Cause the simulator to execute a breakpoint
+ * @param when the tick to break
+ */
+void schedBreak(Tick when);
+
+/**
+ * Cause the simulator to execute a breakpoint
+ * relative to the current tick.
+ * @param delta the number of ticks to execute until breaking
+ */
+void schedRelBreak(Tick delta);
+
+/** Cause the simulator to return to python to create a checkpoint
+ * @param when the cycle to break
+ */
+void takeCheckpoint(Tick when);
+
+/** Dump all the events currently on the event queue
+ */
+void eventqDump();
 
-void debug_break();
+int getRemoteGDBPort();
+// Remote gdb base port.  0 disables remote gdb.
+void setRemoteGDBPort(int port);
 
-#endif // __DEBUG_HH__
+#endif // __SIM_DEBUG_HH__