Plugging a few holes with Sim Control Panel's Step function

CMakeLists.txt

@@ -146,7 +146,6 @@ set( IO_SRC
   ${CMAKE_BINARY_DIR}/temp_src/io_src/io_DRHDF5.cpp
   ${CMAKE_BINARY_DIR}/temp_src/io_src/io_DataRecordDispatcher.cpp
   ${CMAKE_BINARY_DIR}/temp_src/io_src/io_DataRecordGroup.cpp
-  ${CMAKE_BINARY_DIR}/temp_src/io_src/io_DebugPause.cpp
   ${CMAKE_BINARY_DIR}/temp_src/io_src/io_EchoJobs.cpp
   ${CMAKE_BINARY_DIR}/temp_src/io_src/io_EnumAttributesMap.cpp
   ${CMAKE_BINARY_DIR}/temp_src/io_src/io_Environment.cpp

Makefile

@@ -28,7 +28,6 @@ SIM_SERV_DIRS = \
 	${TRICK_HOME}/trick_source/sim_services/Collect \
 	${TRICK_HOME}/trick_source/sim_services/CommandLineArguments \
 	${TRICK_HOME}/trick_source/sim_services/DataRecord \
-	${TRICK_HOME}/trick_source/sim_services/DebugPause \
 	${TRICK_HOME}/trick_source/sim_services/EchoJobs \
 	${TRICK_HOME}/trick_source/sim_services/Environment \
 	${TRICK_HOME}/trick_source/sim_services/EventManager \

docs/howto_guides/Realtime-Best-Practices.md

@@ -274,7 +274,6 @@ Inserting one or more of the ```#define``` statements listed below to the top of
 #define TRICK_NO_REALTIME
 #define TRICK_NO_FRAMELOG
 #define TRICK_NO_MASTERSLAVE
-#define TRICK_NO_INSTRUMENTATION
 #define TRICK_NO_INTEGRATE
 #define TRICK_NO_REALTIMEINJECTOR
 #define TRICK_NO_ZEROCONF
@@ -292,7 +291,6 @@ LIBRARY DEPENDENCIES:
 *************************************************************/
 #define TRICK_NO_MONTE_CARLO
 #define TRICK_NO_MASTERSLAVE
-#define TRICK_NO_INSTRUMENTATION
 #define TRICK_NO_REALTIMEINJECTOR
 #define TRICK_NO_ZEROCONF
 #define TRICK_NO_UNITTEST

include/trick/Executive.hh

@@ -47,6 +47,9 @@ namespace Trick {
             /** gets #except_return */
             virtual int get_except_return() const;
 
+            /** Set to true to pause before every job call during sim execution.\n */
+            bool debug_pause_flag ;               /**< trick_units(--) */
+
         protected:
             /** Attempts to attach a debugger in the event a signal shuts down the simulation.\n */
             bool attach_debugger;            /**< trick_units(--) */
@@ -174,6 +177,12 @@ namespace Trick {
             /** Next scheduled jobs call time.\n */
             long long job_call_time_tics;   /**< trick_units(--) */
 
+            /** Semaphore used to control pausing.\n */
+            sem_t * debug_sem ;                   /**< trick_io(**) trick_units(--) */
+
+            /** Semaphore name for debug_sem.\n */
+            std::string debug_sem_name ;                /**< trick_io(**) trick_units(--) */
+
             /** stream to record elapsed time of default_data, 
                 input_processor, and initialization queues \n */
             std::ofstream init_log_stream; /**< trick_units(--) */
@@ -1221,6 +1230,14 @@ namespace Trick {
             */
             virtual int run() ;
 
+            /**
+             @userdesc Command to step the simulation, pausing after each job. Set exec_command to StepCmd.
+             @par Python Usage:
+             @code trick.step() @endcode
+             @return always 0
+            */
+            virtual int step() ;
+
             /**
              @userdesc Command to freeze the simulation now. Set exec_command to FreezeCmd.
              @par Python Usage:
@@ -1330,6 +1347,34 @@ namespace Trick {
              @return always 0
             */
             virtual int exec_terminate(const char *file_name, const char *error);
+
+            /**
+             @brief Instrumentation class job that pauses before each job when debug_pause is on.
+             Waits on a semapahore before execution continues.
+             @param curr_job - pointer to current instrument job that points to the job to pause at
+             @return always 0
+             */
+            int debug_pause(Trick::JobData * curr_job) ;
+
+            /**
+             @brief Command to post the semaphore so that execution continues after pause.
+             @return always 0
+             */
+            int debug_signal() ;
+
+            /**
+             @brief Command to set debug_pause_flag to true which turns on the debug pausing.
+             Calls Trick::Executive::instrument_job_before to insert the debug_pause routine before every job to pause at.
+             @return always 0
+             */
+            int debug_pause_on() ;
+
+            /**
+             @brief Command to set debug_pause_flag to false which turns off the debug pausing.
+             Calls Trick::Executive::instrument_job_remove to remove the debug_pause routine from all job queues that it was inserted in.
+             @return always 0
+             */
+            int debug_pause_off() ;
 
             /* deleted functions  */
       private:

include/trick/exec_proto.h

@@ -77,6 +77,7 @@ extern "C" {
 
     int exec_freeze(void) ;
     int exec_run(void) ;
+    int exec_step(void) ;
 
     void exec_signal_terminate(void) ;
     int exec_terminate(const char *, const char *) ;
@@ -89,6 +90,10 @@ extern "C" {
     int exec_add_scheduled_job_class(const char * in_name) ;
     int exec_add_depends_on_job( const char * target_job_string , unsigned int t_instance , const char * depend_job_string , unsigned int d_instance ) ;
 
+    int debug_pause_on(void) ;
+    int debug_pause_off(void) ;
+    int debug_signal(void) ;
+
 #ifdef __cplusplus
 }
 #endif

include/trick/files_to_ICG.hh

@@ -81,7 +81,6 @@
 #include "trick/DRAscii.hh"
 #include "trick/DRBinary.hh"
 #include "trick/DRHDF5.hh"
-#include "trick/DebugPause.hh"
 #include "trick/EchoJobs.hh"
 #include "trick/FrameLog.hh"
 #include "trick/UnitTest.hh"

include/trick/sim_mode.h

@@ -19,6 +19,7 @@ typedef enum {
     NoCmd = 0 ,         /* NoCmd */
     FreezeCmd = 2 ,     /* freeze */
     RunCmd = 3 ,        /* run */
+    StepCmd = 4,        /* step */
     ExitCmd = 10 ,      /* exit */
 
 } SIM_COMMAND;

share/trick/sim_objects/default_trick_sys.sm

@@ -72,7 +72,6 @@ a replacement SimObject will create an uncompilable sim.
 ##include "trick/JSONVariableServer.hh"
 ##include "trick/data_record_proto.h"
 ##include "trick/DataRecordDispatcher.hh"
-##include "trick/DebugPause.hh"
 ##include "trick/EchoJobs.hh"
 ##include "trick/FrameLog.hh"
 ##include "trick/UnitTest.hh"
@@ -157,6 +156,8 @@ class SysSimObject : public Trick::SimObject {
             {TRK} ("system_advance_sim_time") sched.advance_sim_time() ;
 
             {TRK} ("system_thread_sync") sched.thread_sync() ;
+
+            {TRK} ("instrumentation") sched.debug_pause(curr_job) ;
         }
 
     private:
@@ -665,12 +666,10 @@ class InstrumentationSimObject : public Trick::SimObject {
 
     public:
         Trick::EchoJobs echo_jobs ;
-        Trick::DebugPause debug_pause ;
 
         InstrumentationSimObject() {
             // Instrumentation class jobs.  Not scheduled by default
             {TRK} ("instrumentation") echo_jobs.echo_job(curr_job) ;
-            {TRK} ("instrumentation") debug_pause.debug_pause(curr_job) ;
         }
 }
 

trick_source/java/src/main/java/trick/simcontrol/SimControlApplication.java

@@ -527,7 +527,7 @@ public void getInitializationPacket() {
             	simRunDirField[i].setText("Slave " + i);
             }
 
-            commandSimcom.put("trick.var_exists(\"trick_instruments.debug_pause.debug_pause_flag\")\n") ;
+            commandSimcom.put("trick.var_exists(\"trick_sys.sched.debug_pause_flag\")\n") ;
             results = commandSimcom.get().split("\t");
             debug_present = Integer.parseInt(results[1]);
 
@@ -832,7 +832,7 @@ private void scheduleGetSimState() {
                           "trick.var_add(\"trick_real_time.rt_sync.active\") \n";
 
             if ( debug_present != 0 ) {
-                status_vars += "trick.var_add(\"trick_instruments.debug_pause.debug_pause_flag\")\n" ;
+                status_vars += "trick.var_add(\"trick_sys.sched.debug_pause_flag\")\n" ;
             }
             if ( overrun_present != 0 ) {
                 status_vars += "trick.var_add(\"trick_real_time.rt_sync.total_overrun\")\n" ;
@@ -1319,7 +1319,7 @@ private void updateGUI() {
                     disableAllCommands();
                     setActionsEnabled("freezeSim,lite", true);
                     if (debug_flag != 0) {
-                        setActionsEnabled("stepSim,dumpChkpntASCII", true);
+                        getAction("stepSim").setEnabled(true);
                     }
                     logoImagePanel.resume();
                     break;
@@ -1334,6 +1334,11 @@ private void updateGUI() {
                     break;
             }
 
+            // Disable the step button if instrumentation jobs are off.
+            if (debug_present == 0) {
+        		getAction("stepSim").setEnabled(false);
+            }
+
             runtimeStatePanel.setTitle(newStatusDesc);
             currentSimStatusDesc = runtimeStatePanel.getTitle();
         }

trick_source/java/src/main/java/trick/simcontrol/utils/SimControlActionController.java

@@ -244,15 +244,8 @@ public void actionPerformed(ActionEvent e) {
 	 */
     public void handleStep( int debug_flag ) {
         try {
-            if ( debug_flag == 0 ) {
-                simcom.put("trick.debug_pause_on()\n" +
-                           "trick.exec_run()\n") ;
-            } else {
-                simcom.put("trick.debug_signal()\n") ;
-            }
-        } catch (IOException e) {
-
-        }
+            simcom.put("trick.exec_step()\n") ;
+        } catch (IOException e) {}
     }
 
     /**

trick_source/sim_services/CMakeLists.txt

@@ -23,8 +23,6 @@ set( SS_SRC
   DataRecord/DataRecordDispatcher
   DataRecord/DataRecordGroup
   DataRecord/data_record_utilities
-  DebugPause/DebugPause
-  DebugPause/DebugPause_c_intf
   EchoJobs/EchoJobs
   EchoJobs/EchoJobs_c_intf
   Environment/Environment