Latest TCL code for interactive console.

Major Changes:

- config.h, config.cc

  Add support for interactive realtime action, sst.rt.interactive (#1266)
  Add checkpoint-enable flag to enable checkpointing in interactive console.
  Make sst.interactive.simpledebug the default for interactive console and only
  use --interactive-console to specify a custom IC
  File replay option ( --replay )

- from_string.h:

  Full precision printing of float types. Scientific notation when value
  is greated than 10**6 or less than 10**-6

- impl/interactive/Makefile.inc

  Included cmdLineEditor files for build

- impl/interactive/cmdLineEditor.h, impl/interactive/cmdLineEditor.cc

  In-line command editing support

- impl/interactive/simpleDebug.h, impl/interactive/simpleDebug.cc

  Shutdown support (#1311)
  Watchpoint support
  Add checkpoint-enabled flag to enable in interactive console.
  Make sst.rtl.simpledebug the default of interactive console.
  Only use --interactive-console to specify custom IC.
  Allow for empty command and other minor whitespace annoyances.
  Console command logging and replay.
  Support commented lines for replay scripts.
  Consolidated commands into a command funtion table.
  Standardized specifying commands, help text, and command groups
  Provided auto-completion support for commands and object names
  Various nullptr checks and fixes to avoid segmentation faults.

- interactiveConsole.h

  Add support for shutdown (#1311)

- serialization/objectMap.cc, serialization/objectMap.h

  Support for trace buffers and watchpoint actions
  Circular buffer and trigger recording
  Add ability to check/sample before and after both clock and event handlers.
  Watchpoint support for adding set var val action.
  Extended trigger tests functionality: support for logic operators (e.g. v1 < 10 && v2 > 5)  and comparisons between two variables
  Support for trigger comparison between two variables.
  All set string to handle spaces.
  watchpoint verbosity control
  Various bug fixes for command line editing
  Fixes for nullptr checks and address sanitizer issues causing seg faults.

- simulation.cc

  Interactive console realtime action (#1266)
  Addition of checkpoint-enable flag to enable checkpoint in IC.
  Make sst.interactive.simpledebug the default for IC
  replay option for IC

- watchPoint.h, watchPoint.cc

  Circular buffer, trigger record.
  Add ability to check/sample before and after both clock and event handlers
  Add watchpoint action class and add set var val action
  Add support for trigger comparison between two variables
  Update watchpoint handling
  Allow set string to handle spaces
  Add shutdown as trigger action
  Add watchpoint index to watchpoint class
  Add checkpoint-enable flag to enable checkpointing in interactive console.
  Make sst.interactive.simpledebug the default for interactive console.
  Only use --interactive-console to specify a custom IC.
  watchpoint verbosity control

Author: Kenneth Griesser

src/sst/core/config.cc

@@ -526,16 +526,18 @@ Config::insertOptions()
     DEF_SECTION_HEADING("Advanced Options - Debug");
     DEF_ARG("run-mode", 0, "MODE", "Set run mode [ init | run | both (default)]", runMode_, true, false, true);
     DEF_ARG("interactive-console", 0, "ACTION",
-        "[EXPERIMENTAL] Set console to use for interactive mode. NOTE: This currently only works for serial jobs and "
-        "this option will be ignored for parallel runs.",
+        "[EXPERIMENTAL] Set console to use for interactive mode (overrides default console: "
+        "sst.interactive.simpledebug). "
+        "NOTE: This currently only works for serial jobs and will be ignored for parallel runs.",
         interactive_console_, true, false, false);
     DEF_ARG_OPTVAL("interactive-start", 0, "TIME",
         "[EXPERIMENTAL] Drop into interactive mode at specified simulated time.  If no time is specified, or the time "
-        "is 0, then it will "
-        "drop into interactive mode before any events are processed in the main run loop. This option is ignored if no "
-        "interactive console was set. NOTE: This currently only works for serial jobs and this option will be ignored "
+        "is 0, then it will drop into interactive mode before any events are processed in the main run loop. "
+        "NOTE: This currently only works for serial jobs and this option will be ignored "
         "for parallel runs.",
         interactive_start_time_, true, false, false);
+    DEF_ARG("replay-file", 0, "FILE", "Specify file for replaying an interactive debug console session.", replay_file_,
+        false);
 #ifdef USE_MEMPOOL
     DEF_ARG("output-undeleted-events", 0, "FILE",
         "file to write information about all undeleted events at the end of simulation (STDOUT and STDERR can be used "
@@ -561,6 +563,10 @@ Config::insertOptions()
 
     /* Advanced Features - Checkpoint */
     DEF_SECTION_HEADING("Advanced Options - Checkpointing (EXPERIMENTAL)");
+    DEF_FLAG("checkpoint-enable", 0,
+        "Allows checkpoints to be triggered from the interactive debug console. "
+        "This option is not needed if checkpoint-wall-period, checkpoint-period, or checkpoint-sim-period are used.",
+        checkpoint_enable_, false, false, false);
     DEF_ARG("checkpoint-wall-period", 0, "PERIOD",
         "Set approximate frequency for checkpoints to be generated in terms of wall (real) time. PERIOD can be "
         "specified in hours, minutes, and seconds with "
@@ -651,6 +657,7 @@ Config::setOptionFromModel(const std::string& entryName, const std::string& valu
 bool
 Config::canInitiateCheckpoint()
 {
+    if ( checkpoint_enable_.value == true ) return true;
     if ( checkpoint_wall_period_.value != 0 ) return true;
     if ( checkpoint_sim_period_.value != "" ) return true;
     return false;

src/sst/core/config.h

@@ -512,6 +512,10 @@ class Config : public ConfigShared, public SST::Core::Serialization::serializabl
         std::bind(&StandardConfigParsers::from_string_default<std::string>, std::placeholders::_1,
             std::placeholders::_2, "0"));
 
+    /**
+       File to replay an interactive console script
+    */
+    SST_CONFIG_DECLARE_OPTION(std::string, replay_file, "", &StandardConfigParsers::from_string<std::string>);
 
 #ifdef USE_MEMPOOL
     /**
@@ -577,6 +581,11 @@ class Config : public ConfigShared, public SST::Core::Serialization::serializabl
 
     /**** Advanced options - Checkpointing ****/
 
+    /**
+     * Enable checkpointing for interactive debug
+     */
+    SST_CONFIG_DECLARE_OPTION(bool, checkpoint_enable, 0, &StandardConfigParsers::flag_set_true);
+
     /**
      * Interval at which to create a checkpoint in wall time
      */

src/sst/core/from_string.h

@@ -12,6 +12,9 @@
 #ifndef SST_CORE_FROM_STRING_H
 #define SST_CORE_FROM_STRING_H
 
+#include <iomanip>
+#include <limits>
+#include <sstream>
 #include <stdexcept>
 #include <string>
 #include <type_traits>
@@ -107,7 +110,16 @@ template <class T>
 std::enable_if_t<!std::is_enum_v<T>, std::string>
 to_string(const T& input)
 {
-    if constexpr ( std::is_arithmetic_v<T> )
+    if constexpr ( std::is_floating_point_v<T> ) {
+        std::stringstream s;
+        T                 abs_val = input < 0 ? -input : input;
+        if ( abs_val > (T)10e6 || abs_val < (T)10e-6 )
+            s << std::scientific << std::setprecision(std::numeric_limits<double>::max_digits10) << input;
+        else
+            s << std::fixed << std::setprecision(std::numeric_limits<double>::max_digits10) << input;
+        return s.str().c_str();
+    }
+    else if constexpr ( std::is_arithmetic_v<T> )
         return std::to_string(input);
     else
         return typeid(T).name(); // For now, return a string if the type isn't handled elsewhere

src/sst/core/impl/interactive/Makefile.inc

@@ -5,5 +5,7 @@
 
 sst_core_sources += \
 	impl/interactive/simpleDebug.cc \
-	impl/interactive/simpleDebug.h
+	impl/interactive/simpleDebug.h \
+	impl/interactive/cmdLineEditor.cc \
+	impl/interactive/cmdLineEditor.h