Debug: Add a function to cause the simulator to create a checkpoint from GDB.

1 files changed, 18 insertions, 0 deletions

diff --git a/src/sim/debug.hh b/src/sim/debug.hh
index ca7a606c6..0bec5ecf3 100644
--- a/src/sim/debug.hh
+++ b/src/sim/debug.hh
@@ -33,8 +33,26 @@
 
 #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 cycle to break
+ */
 void schedBreakCycle(Tick when);
 
+/** 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();
+
 int getRemoteGDBPort();
 // Remote gdb base port.  0 disables remote gdb.
 void setRemoteGDBPort(int port);