Interactive Console Major Update by kpgriesser · Pull Request #1452 · sstsimulator/sst-core

kpgriesser · 2025-10-21T19:34:07Z

Major Changes:

config.h, config.cc

Add support for interactive realtime action, sst.rt.interactive (Interactive console realtime action #1266)
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 File
replay option ( --replay )
from_string.h:

Full precision printing of float types. Scientific notation when value is greated than 106 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 (Add support for shutdown from interactive console #1311) Watchpoint support
Add checkpoint-enabled flag to enable in interactive console
Make sst.interactive.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 (Add support for shutdown from interactive console #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 (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.
Makesst.interactive.simpledebug the default for interactive console.
Only use --interactive-console to specify a custom IC.
watchpoint verbosity control.

github-actions · 2025-10-21T19:34:40Z

CMAKE-FORMAT TEST - PASSED

github-actions · 2025-10-21T19:34:42Z

CLANG-FORMAT TEST - FAILED (on last commit):
Run > ./scripts/clang-format-test.sh using clang-format v20 to check formatting

github-actions · 2025-10-21T19:42:47Z

CMAKE-FORMAT TEST - PASSED

github-actions · 2025-10-21T19:42:48Z

CLANG-FORMAT TEST - PASSED

sst-autotester · 2025-10-21T19:50:24Z

Status Flag 'Pre-Test Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging
NO INSPECTION HAS BEEN PERFORMED ON THIS PULL REQUEST! - This PR must be inspected by setting label 'AT: PRE-TEST INSPECTED'.

Major Changes: - config.h, config.cc Add support for interactive realtime action, sst.rt.interactive (sstsimulator#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 (sstsimulator#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 (sstsimulator#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 (sstsimulator#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

github-actions · 2025-10-21T19:51:22Z

CMAKE-FORMAT TEST - PASSED

github-actions · 2025-10-21T19:51:29Z

CLANG-FORMAT TEST - PASSED

leekillough · 2025-10-21T20:09:11Z

src/sst/core/from_string.h

+        else
+            s << std::fixed << std::setprecision(std::numeric_limits<double>::max_digits10) << input;
+        return s.str().c_str();
+    }


I would suggest:

if constexpr ( std::is_floating_point_v<T> ) { char s[32]; snprintf(s, sizeof(s), "%.*g", std::numeric_limits<T>::max_digits10, input); return s; }

printf() is much faster and more flexible than C++ <iostream> operators.

The %.*g specifier uses scientific notation for large and small exponents, otherwise not, and its precision, indicated by *, uses the next argument, which std::numeric_limits<T>::max_digits10 returns the number of digits required. This guarantees that a value written out can be read back in by scanf() and the original bits are unchanged.

If a machine is going to be reading/writing the numbers, the %a specifier is exact and prints floating-point in hexadecimal notation.

You probably should add #include <cstdio> at the top of the file. Please run scripts/test-includes.pl to check for needed #includes. It will be added later to CI and maybe pre-commit.

will get this in near-future PR

leekillough · 2025-10-21T20:32:51Z

src/sst/core/serialization/objectMap.h

        if ( op == ">=" ) return Op::GTE;
        if ( op == "==" ) return Op::EQ;
        if ( op == "!=" ) return Op::NEQ;
+        if ( op == "changed" ) return Op::CHANGED; // Could also use <>


Or the C++20ism <=>

leekillough · 2025-10-21T20:39:03Z

src/sst/core/serialization/objectMap.h

+*/
+template <typename V1>
+bool
+cmp(V1 v, ObjectMapComparison::Op op, V1 w)


I would prefer to use C++ comparison functors like std::less, std::greater, std::equal rather than creating a separate ObjectMapComparison type, but that can be at a later release.

(Rev uses those functors to implement all of the different RISC-V comparisons.)

leekillough · 2025-10-21T20:41:46Z

src/sst/core/serialization/objectMap.h

+                long double v1 = static_cast<long double>(v); // unnecessary ...
+                long double w1 = static_cast<long double>(w);
+                return cmp(v1, op, w1);
+            }


This code can perhaps be made simpler with std::common_type_t, but that's for a later release.

leekillough · 2025-10-21T20:54:50Z

src/sst/core/watchPoint.h

+    };

-    std::string getName() { return name_; }
+    // TODO can we avoid code duplication in WatchPoint and the WatchPointAction?


Perhaps, with inheritance, delegation, a special class type, etc.

leekillough

Although I prefer printf "%.17g" (abstracted as printf "%.*g" with an argument) because of its precision, I approve this, in order to get it into 15.1.

We can work out the precision and representations later.

gvoskuilen · 2025-10-22T21:34:08Z

src/sst/core/impl/interactive/simpleDebug.cc

+        }
+    }
+
+    // The business


Looks like half a comment?

gvoskuilen · 2025-10-23T14:27:06Z

src/sst/core/watchPoint.h

+
+    void     setBufferReset();
+    void     check();
+    uint32_t verbosity = 0;


Inconsistent code formatting. E.g., some vars camel case, some w/ trailing _, some elsewhere are _ separated. Should clean this up before the interactive console moves out of "experimental".

Agreed - let's review the standard and we'll clean up all the code.

github-actions · 2025-10-23T15:03:05Z

CLANG-FORMAT TEST - PASSED

github-actions · 2025-10-23T15:28:14Z

CLANG-FORMAT TEST - PASSED

kpgriesser · 2025-10-23T15:33:28Z

@gvoskuilen I pushed an update to include watchPoint.h in the distribution. This is to support work exploring an external tool using the interactive console.

sst-autotester · 2025-10-23T15:56:54Z

Status Flag 'Pre-Test Inspection' - SUCCESS: The last commit to this Pull Request has been INSPECTED by label AT: PRE-TEST INSPECTED! Autotester is Removing Label; this inspection will remain valid until a new commit to source branch is performed.

sst-autotester · 2025-10-23T15:59:57Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements

Build Num: 2304
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MR-2

Build Num: 2259
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MT-2

Build Num: 2258
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-core_Make-Dist

Build Num: 934
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Build Num: 809
Status: STARTED

Using Repos:

Repo: CORE (tactcomplabs/sst-core)

Repo: SQE (sstsimulator/sst-sqe)

Repo: ELEMENTS (sstsimulator/sst-elements)

Repo: MACRO (sstsimulator/sst-macro)

Pull Request Author: kpgriesser

sst-autotester · 2025-10-23T17:07:00Z

Status Flag 'Pull Request AutoTester' - Jenkins Testing: all Jobs PASSED

Pull Request Auto Testing has PASSED (click to expand)

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements

Build Num: 2304
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MR-2

Build Num: 2259
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MT-2

Build Num: 2258
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-core_Make-Dist

Build Num: 934
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Build Num: 809
Status: PASSED

sst-autotester · 2025-10-23T17:07:18Z

Status Flag 'Pre-Merge Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging
THE LAST COMMIT TO THIS PULL REQUEST HAS NOT BEEN REVIEWED YET!

sst-autotester · 2025-10-23T17:07:24Z

All Jobs Finished; status = PASSED, However Inspection must be performed before merge can occur...

feldergast

Looks good. We will likely want to revisit some of the ObjectMap structures as the APIs firm up.

feldergast · 2025-10-23T18:28:41Z

src/sst/core/Makefile.am

 	math/sqrt.h \
 	uninitializedQueue.h \
 	unitAlgebra.h \
+	watchPoint.h \


If watchPoint.h is added here, it should technically be removed from the sst_core_sources section.

feldergast · 2025-10-23T18:40:42Z

src/sst/core/watchPoint.cc

 // information, see the LICENSE file in the top level directory of the
 // distribution.

+//clang-format off


Why is clang-format turned of here? They seem to be in the order specified in the .clang-format file.

This is left-over from some earlier problems we had with include ordering and can be removed.

By the way, the lack of a space between // and clang-format off prevents the directive from being effective. A space must exist between // and clang-format off in order for it to be effective. So leaving the code as-is without the space between // and clang-format off is benign and will just be treated as a comment.

sst-autotester · 2025-10-23T19:49:01Z

Status Flag 'Pre-Merge Inspection' - SUCCESS: The last commit to this Pull Request has been INSPECTED AND APPROVED by [ feldergast ]!

sst-autotester · 2025-10-23T19:49:08Z

Status Flag 'Pull Request AutoTester' - Pull Request MUST BE MERGED MANUALLY BY Project Team - This Repo does not support Automerge

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) AT: CMAKE-FORMAT PASS and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels Oct 21, 2025

github-actions bot added AT: CLANG-FORMAT FAIL AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels Oct 21, 2025

kpgriesser force-pushed the iconsole-pr branch from e6df8ce to 71a2089 Compare October 21, 2025 19:42

github-actions bot added AT: CLANG-FORMAT PASS and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels Oct 21, 2025

github-actions bot removed the AT: CLANG-FORMAT FAIL label Oct 21, 2025

kpgriesser force-pushed the iconsole-pr branch from 71a2089 to 2944a01 Compare October 21, 2025 19:50

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels Oct 21, 2025

leekillough suggested changes Oct 21, 2025

View reviewed changes

leekillough reviewed Oct 21, 2025

View reviewed changes

leekillough approved these changes Oct 22, 2025

View reviewed changes

gvoskuilen reviewed Oct 23, 2025

View reviewed changes

gvoskuilen added the AT: PRE-TEST INSPECTED label Oct 23, 2025

comment update

7d146fa

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels Oct 23, 2025

Added watchPoint.h for disti. Required for use with interactiveConsole.h

9ed21b5

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels Oct 23, 2025

This was referenced Oct 23, 2025

improve iconsole variable string formatting and controls tactcomplabs/sst-core#18

Open

Improve expression handling for watchpoints tactcomplabs/sst-core#19

Open

sst-autotester removed the AT: PRE-TEST INSPECTED label Oct 23, 2025

feldergast approved these changes Oct 23, 2025

View reviewed changes

feldergast merged commit f1269c3 into sstsimulator:devel Oct 23, 2025
10 checks passed

kpgriesser deleted the iconsole-pr branch November 6, 2025 01:52

This was referenced Nov 9, 2025

Add --checkpointEnable flag skuntz/sst-core#15

Closed

Associate index with watchpoint for easy reference skuntz/sst-core#14

Closed

TraceBuffer print command skuntz/sst-core#7

Closed

Support for different actions skuntz/sst-core#2

Closed

Conversation

kpgriesser commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

sst-autotester commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leekillough left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 23, 2025

Uh oh!

github-actions bot commented Oct 23, 2025

Uh oh!

kpgriesser commented Oct 23, 2025

Uh oh!

sst-autotester commented Oct 23, 2025

Uh oh!

sst-autotester commented Oct 23, 2025

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MR-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MT-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-core_Make-Dist

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Using Repos:

Uh oh!

sst-autotester commented Oct 23, 2025

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MR-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-elements_MT-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.9_sst-core_Make-Dist

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Uh oh!

sst-autotester commented Oct 23, 2025

Uh oh!

sst-autotester commented Oct 23, 2025

Uh oh!

feldergast left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

kpgriesser commented Oct 21, 2025 •

edited

Loading