cudaq::save_state, and error propagation #3408

kvmto · 2025-09-02T14:27:22Z

Summary
This PR introduces cudaq::save_state along with the necessary infrastructure changes to ExecutionContext and simulators.

Motivation
The new functionality provides a way to debug the execution of kernels and to collect data from their runs. These improvements are also foundational to supporting upcoming AI projects.

schweitzpgi · 2025-09-15T15:01:57Z

runtime/nvqir/stim/StimState.h

@@ -0,0 +1,267 @@
+/*************************************************************** -*- C++ -*- ***


Suggested change

/*************************************************************** -*- C++ -*- ***

/****************************************************************-*- C++ -*-****

nit: consistency

schweitzpgi · 2025-09-15T15:03:08Z

include/cudaq/Optimizer/CodeGen/QIRFunctionNames.h

    "__quantum__rt__array_record_output";

-/// Used to specify the type of the data elements in the `QISApplyKrausChannel`
+/// Used to specify the type of the datxa elements in the `QISApplyKrausChannel`


schweitzpgi · 2025-09-15T15:06:20Z

include/cudaq/Optimizer/Dialect/Quake/QuakeOps.td

  }];
 }

+def quake_SaveStateOp : QuakeOp<"save_state"> {


I don't think there are any optimizations planned for this and therefore it shouldn't be added to the IR. It should suffice to lower this directly to a CallOp to a runtime library function that is a common decl across all simulators.

schweitzpgi · 2025-09-15T15:07:11Z

lib/Frontend/nvqpp/ConvertExpr.cpp

    }

+
+


nit: clang-format? Shouldn't have 3 blank lines here.

schweitzpgi · 2025-09-15T15:07:39Z

lib/Frontend/nvqpp/ConvertExpr.cpp

+
+
+    if (funcName == "save_state") {
+      builder.create<quake::SaveStateOp>(loc, TypeRange{}, ValueRange{});


Just generate a func::CallOp.

schweitzpgi · 2025-09-15T15:11:19Z

lib/Optimizer/Builder/Intrinsics.cpp

  func.func private @__quantum__qis__convert_array_to_stdvector(!qir_array) -> !qir_array
  func.func private @__quantum__qis__free_converted_stdvector(!qir_array)

+  func.func private @__quantum__qis__save_state()


Does this really require QIR in the loop? It is only available in simulation, no? It would be clearer, if it is not a QIS function, that it will never be a part of a hardware profile and, as a bonus, the QIR verifier will fail to let it slip past as something valid for hardware.

schweitzpgi · 2025-09-15T15:12:24Z

lib/Optimizer/Transforms/EraseSaveState.cpp

+
+

Suggested change

schweitzpgi · 2025-09-15T15:15:13Z

runtime/common/SimulationState.h

+/// 3: x_output array, size = x_output_size (X stabilizers + destabilisers + phase bits)
+/// 4: z_output array, size = z_output_size (Z stabilizers + destabilisers + phase bits)
+/// 5: frame array (Pauli frame), size = 2*num_qubits
+using StimData = std::vector<std::pair<void*, std::size_t>>;


The above description is convoluted enough to merit making this a class instead of a vector with special conventions.

schweitzpgi · 2025-09-15T15:16:44Z

runtime/nvqir/NVQIR.cpp


+
+static void
+__quantum__qis__save_state() {


Suggested change

__quantum__qis__save_state() {

get_simulation_state() {

schweitzpgi · 2025-09-15T15:18:14Z

lib/Optimizer/Transforms/EraseSaveState.cpp

@@ -0,0 +1,43 @@
+/*******************************************************************************


Not sure how you got this to compile without adding this pass to the Passes.td file.

Signed-off-by: Kevin Mato <[email protected]>

copy-pr-bot · 2025-09-19T14:28:11Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Signed-off-by: Kevin Mato <[email protected]>

- added erase pass - fixed bug on platforms - serialization and deserialization of simulation state - training mode, for error log collection and further propagation - semplifications Signed-off-by: Kevin Mato <[email protected]>

Signed-off-by: Kevin Mato <[email protected]>

kvmto · 2025-10-21T12:29:36Z

/ok to test 6c05744

Command Bot: Processing...

Signed-off-by: Kevin Mato <[email protected]>

- added erase pass - fixed bug on platforms - serialization and deserialization of simulation state - training mode, for error log collection and further propagation - semplifications Signed-off-by: Kevin Mato <[email protected]>

Signed-off-by: Kevin Mato <[email protected]>

bmhowe23 · 2025-10-21T21:12:28Z

/ok to test 6c05744

Command Bot: Processing...

copy-pr-bot · 2025-10-21T21:12:31Z

/ok to test 6c05744

@bmhowe23, there was an error processing your request: E2

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/2/

bmhowe23 · 2025-10-21T21:13:33Z

/ok to test 727a9fb

Command Bot: Processing...

schweitzpgi reviewed Sep 15, 2025

View reviewed changes

kvmto added 5 commits September 18, 2025 12:42

introduced new operation cudaq::save_state and support

1596156

Signed-off-by: Kevin Mato <[email protected]>

wip, I need to make a flattened stim_data type

5c5f684

Signed-off-by: Kevin Mato <[email protected]>

wip, flattened type introduced

f84fe67

Signed-off-by: Kevin Mato <[email protected]>

wip, hooked up nvqir

d7f1551

Signed-off-by: Kevin Mato <[email protected]>

wip, save_state lowered. need for library mode and llvm translate

b873525

Signed-off-by: Kevin Mato <[email protected]>

kvmto force-pushed the record_in_sim branch from bfd9c68 to b873525 Compare September 19, 2025 14:28

kvmto added 5 commits September 22, 2025 20:05

save_state hooked correctly hooked. next steps collect stim states.

89524bf

Signed-off-by: Kevin Mato <[email protected]>

serialization of pauli frame. first check of dumping

d974054

Signed-off-by: Kevin Mato <[email protected]>

switching to sample based save_state. todo fix getCurrentSimulationState

d3b366a

Signed-off-by: Kevin Mato <[email protected]>

introduced:

fe3f849

- added erase pass - fixed bug on platforms - serialization and deserialization of simulation state - training mode, for error log collection and further propagation - semplifications Signed-off-by: Kevin Mato <[email protected]>

added replay errors

fecfa56

Signed-off-by: Kevin Mato <[email protected]>

kvmto changed the title ~~DRAFT: cudaq::save_state, and simulation support~~ cudaq::save_state, and error propagation Oct 21, 2025

linting

6c05744

Signed-off-by: Kevin Mato <[email protected]>

kvmto added 14 commits October 21, 2025 13:27

Better Logging

eb9afd8

Signed-off-by: Kevin Mato <[email protected]>

introduced new operation cudaq::save_state and support

f16be81

Signed-off-by: Kevin Mato <[email protected]>

wip, I need to make a flattened stim_data type

a3d5b48

Signed-off-by: Kevin Mato <[email protected]>

wip, flattened type introduced

32f01f2

Signed-off-by: Kevin Mato <[email protected]>

wip, hooked up nvqir

76ad125

Signed-off-by: Kevin Mato <[email protected]>

wip, save_state lowered. need for library mode and llvm translate

82675d7

Signed-off-by: Kevin Mato <[email protected]>

save_state hooked correctly hooked. next steps collect stim states.

010dd80

Signed-off-by: Kevin Mato <[email protected]>

serialization of pauli frame. first check of dumping

38ab16f

Signed-off-by: Kevin Mato <[email protected]>

switching to sample based save_state. todo fix getCurrentSimulationState

b716a74

Signed-off-by: Kevin Mato <[email protected]>

introduced:

55500d1

- added erase pass - fixed bug on platforms - serialization and deserialization of simulation state - training mode, for error log collection and further propagation - semplifications Signed-off-by: Kevin Mato <[email protected]>

added replay errors

00f352f

Signed-off-by: Kevin Mato <[email protected]>

linting

0e55dc7

Signed-off-by: Kevin Mato <[email protected]>

Better Logging

03122ac

Signed-off-by: Kevin Mato <[email protected]>

solved conflicts

4d5e963

Signed-off-by: Kevin Mato <[email protected]>

kvmto added 2 commits October 21, 2025 13:57

Merge branch 'record_in_sim_recover' into record_in_sim

c10743b

full cleanup

727a9fb

Signed-off-by: Kevin Mato <[email protected]>

		@@ -0,0 +1,267 @@
		/*************************************************************** -- C++ -- ***



		if (funcName == "save_state") {
		builder.create<quake::SaveStateOp>(loc, TypeRange{}, ValueRange{});

		@@ -0,0 +1,43 @@
		/*******************************************************************************

cudaq::save_state, and error propagation #3408

Are you sure you want to change the base?

cudaq::save_state, and error propagation #3408

Uh oh!

Conversation

kvmto commented Sep 2, 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!

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!

copy-pr-bot bot commented Sep 19, 2025

Uh oh!

kvmto commented Oct 21, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bmhowe23 commented Oct 21, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

copy-pr-bot bot commented Oct 21, 2025

Uh oh!

bmhowe23 commented Oct 21, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kvmto commented Oct 21, 2025 •

edited by github-actions bot

Loading

bmhowe23 commented Oct 21, 2025 •

edited by github-actions bot

Loading

bmhowe23 commented Oct 21, 2025 •

edited by github-actions bot

Loading