Pickles/cache: dump circuit data

Author: dannywillems

src/lib/pickles/cache.ml

@@ -1,5 +1,13 @@
 open Core_kernel
 
+(* Check if circuit data dumping is enabled via environment variable *)
+let should_dump_circuit_data () =
+  match Sys.getenv_opt "MINA_DUMP_CIRCUIT_DATA" with
+  | Some "true" | Some "1" | Some "yes" ->
+      true
+  | _ ->
+      false
+
 module Step = struct
   module Key = struct
     module Proving = struct
@@ -53,7 +61,14 @@ module Step = struct
             [%test_eq: string] header.constraint_system_hash
               header_read.constraint_system_hash ;
             { Backend.Tick.Keypair.index; cs } ) )
-      (fun (_, header, _, _) t path ->
+      (fun (_, header, _, cs) t path ->
+        (* Conditionally dump extra circuit data based on environment variable *)
+        if should_dump_circuit_data () then (
+          let logger = Logger.create () in
+          Logger.info logger ~module_:__MODULE__ ~location:__LOC__
+            "Dumping Step circuit data to %s" path ;
+          Kimchi_pasta_constraint_system.Vesta_constraint_system
+          .dump_extra_circuit_data cs path ) ;
         Or_error.try_with (fun () ->
             Snark_keys_header.write_with_header
               ~expected_max_size_log2:33 (* 8 GB should be enough *)
@@ -185,7 +200,14 @@ module Wrap = struct
             [%test_eq: string] header.constraint_system_hash
               header_read.constraint_system_hash ;
             { Backend.Tock.Keypair.index; cs } ) )
-      (fun (_, header, _) t path ->
+      (fun (_, header, cs) t path ->
+        (* Conditionally dump extra circuit data based on environment variable *)
+        if should_dump_circuit_data () then (
+          let logger = Logger.create () in
+          Logger.info logger ~module_:__MODULE__ ~location:__LOC__
+            "Dumping Wrap circuit data to %s" path ;
+          Kimchi_pasta_constraint_system.Pallas_constraint_system
+          .dump_extra_circuit_data cs path ) ;
         Or_error.try_with (fun () ->
             Snark_keys_header.write_with_header
               ~expected_max_size_log2:33 (* 8 GB should be enough *)

src/lib/pickles/cache.mli

@@ -62,7 +62,12 @@ module Step : sig
     , Kimchi_bindings.Protocol.VerifierIndex.Fp.t )
     Key_cache.Sync.Disk_storable.t
 
-  (** Default disk storage handler for proving keys. *)
+  (** Default disk storage handler for proving keys.
+
+      When writing keys to disk, this storage handler will optionally dump
+      extra circuit data (constraint system details) based on the
+      MINA_DUMP_CIRCUIT_DATA environment variable. The dumping is disabled
+      by default. Set MINA_DUMP_CIRCUIT_DATA to "true", "1", or "yes" to enable. *)
   val storable : storable
 
   (** Default disk storage handler for verification keys. *)
@@ -160,7 +165,12 @@ module Wrap : sig
   type vk_storable =
     (Key.Verification.t, Verification_key.t) Key_cache.Sync.Disk_storable.t
 
-  (** Default disk storage handler for wrap proving keys. *)
+  (** Default disk storage handler for wrap proving keys.
+
+      When writing keys to disk, this storage handler will optionally dump
+      extra circuit data (constraint system details) based on the
+      MINA_DUMP_CIRCUIT_DATA environment variable. The dumping is disabled
+      by default. Set MINA_DUMP_CIRCUIT_DATA to "true", "1", or "yes" to enable. *)
   val storable : storable
 
   (** Default disk storage handler for wrap verification keys. *)