add proof mode (#61)

* add program segment to relocation * display op0 and op1 values * compute and display trace flags and offset * deal with columns above Z (AA, AB...) * add proof mode, layout and execution to next power of two * do not relocate empty segments * optimization of repetition of last step * added proof-mode compiled program and added loop verification in proof-mode * fixed typo to get trace flags * added all layouts to the menu * reverse array in trace flags * fixed all cairo builtin loading * execute last step as many times as required and clear last new registers * fix computation of trace flags Co-authored-by: Clément Walter <[email protected]> --------- Co-authored-by: Clément Walter <[email protected]>
ClementWalter · Oct 23, 2024 · 6074a23 · 6074a23
1 parent 8ddaf65
commit 6074a23
Show file tree

Hide file tree

Showing 9 changed files with 1,775 additions and 93 deletions.
diff --git a/cairo0/main_compiled_proof_mode.json b/cairo0/main_compiled_proof_mode.json
diff --git a/src/ui/Code.ts b/src/ui/Code.ts
@@ -178,3 +178,15 @@ function ADD_FELT(a: number | string, b: number | string): number | string {
 function MUL_FELT(a: number | string, b: number | string): number | string {
   return modMul(BigInt(a), BigInt(b)).toString(10);
 }
+
+function GET_FLAGS_AND_OFFSETS(encodedInstruction: string): number[][] {
+  const { dstOffset, op0Offset, op1Offset, flags } = getTraceInfo(
+    BigInt(encodedInstruction),
+  );
+
+  let traceFlags: number[] = flags.map((f, i, arr) =>
+    parseInt(arr.slice(i).reverse().join(""), 2),
+  );
+
+  return [[dstOffset, op0Offset, op1Offset, ...traceFlags]];
+}
diff --git a/src/ui/dialog.html b/src/ui/dialog.html
@@ -9,18 +9,29 @@
       function closeDialog() {
         google.script.host.close();
       }
+
       function onFileLoad(event) {
         var compiledJson = JSON.parse(event.target.result);
+        var selectedRunnerMode = document.querySelector(
+          'input[name="runnerMode"]:checked',
+        ).value;
+        var selectedLayout = document.getElementById("layoutPicker").value;
         google.script.run
           .withSuccessHandler(closeDialog)
           .withFailureHandler(closeDialog)
-          .loadProgram(compiledJson);
+          .loadProgram(
+            JSON.stringify(compiledJson, null, 2),
+            selectedRunnerMode,
+            selectedLayout,
+          );
       }
+
       function onFileChange(event) {
         var fileReader = new FileReader();
         fileReader.onload = onFileLoad;
         fileReader.readAsText(event.target.files[0]);
       }
+
       function onApiLoad() {
         document
           .getElementById("program")
@@ -31,7 +42,42 @@
   <body>
     <div>
       <input id="program" type="file" accept="application/json" />
+
+      <div>
+        <p>Select the runner configuration :</p>
+        <label
+          ><input
+            type="radio"
+            name="runnerMode"
+            value="execution"
+            checked
+          />Execution mode</label
+        ><br />
+        <label
+          ><input type="radio" name="runnerMode" value="proof" />Proof
+          mode</label
+        ><br />
+      </div>
+
+      <div>
+        <p>Pick a layout :</p>
+        <select id="layoutPicker">
+          <option value="plain">Plain</option>
+          <option value="small">Small</option>
+          <option value="dex">Dex</option>
+          <option value="recursive">Recursive</option>
+          <option value="starknet_with_keccak">Starknet with Keccak</option>
+          <option value="recursive_large_output">Recursive large output</option>
+          <option value="recursive_with_poseidon">
+            Recursive with Poseidon
+          </option>
+          <option value="all_cairo">All Cairo</option>
+          <option value="all_solidity">All Solidity</option>
+          <option value="dynamic">Dynamic</option>
+        </select>
+      </div>
     </div>
+
     <script src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
   </body>
 </html>
diff --git a/src/ui/ui.ts b/src/ui/ui.ts
@@ -10,21 +10,69 @@ function onOpen(): void {
 }
 
 function menuStep(): void {
-  step(getLastActiveRowNumber("A", runSheet) - 2);
+  step(getLastActiveRowNumber(`${pcColumn}`, runSheet) - 2);
 }
 
 function menuRun(): void {
-  runUntilPc();
+  let lastStepNumber: number = runUntilPc();
+  if (isProofMode()) {
+    step(lastStepNumber - 1);
+    step(lastStepNumber - 1 + 1);
+    let lastRegisters = runSheet
+      .getRange(
+        `${pcColumn}${lastStepNumber + 1}:${apColumn}${lastStepNumber + 1}`,
+      )
+      .getValues();
+    let firstOfLoopRegister = runSheet
+      .getRange(
+        `${pcColumn}${lastStepNumber + 2}:${apColumn}${lastStepNumber + 2}`,
+      )
+      .getValues();
+    if (
+      Number(lastRegisters[0][0]) != Number(firstOfLoopRegister[0][0]) &&
+      Number(lastRegisters[0][1]) != Number(firstOfLoopRegister[0][1]) &&
+      Number(lastRegisters[0][2]) != Number(firstOfLoopRegister[0][2])
+    ) {
+      Logger.log("Make sure the program is compiled and loaded in proof mode.");
+      throw new InvalidLoopRegisters();
+    }
+    for (
+      let stepNum = lastStepNumber + 3;
+      stepNum <= nextPowerOfTwo(lastStepNumber) + 1;
+      stepNum++
+    ) {
+      step(stepNum - 2);
+    }
+
+    //Clear new registers for proper relocation purposes
+    let registerRowToClear: number = nextPowerOfTwo(lastStepNumber) + 2;
+    runSheet
+      .getRange(
+        `${pcColumn}${registerRowToClear}:${apColumn}${registerRowToClear}`,
+      )
+      .clearContent();
+  }
 }
 
 function clear(): void {
   const stackLength: number = Number(
     runSheet.getRange(`${apColumn}2`).getValue(),
   );
-  runSheet.getRange(`A3:C`).clearContent();
-  runSheet.getRange("D2:F").clearContent();
-  runSheet.getRange(`G${stackLength + 2}:G`).clearContent();
-  runSheet.getRange(`H2:Q`).clearContent();
+  runSheet.getRange(`${pcColumn}3:${apColumn}`).clearContent();
+  runSheet.getRange(`${opcodeColumn}2:${runOp1Column}`).clearContent();
+  runSheet
+    .getRange(`${executionColumn}${stackLength + 2}:${executionColumn}`)
+    .clearContent();
+  runSheet
+    .getRange(
+      `${firstBuiltinColumn}2:${indexToColumn(columnToIndex(firstBuiltinColumn) + stackLength + 2)}`,
+    )
+    .clearContent();
+  proverSheet
+    .getRange(
+      `${provSegmentsColumn}3:${indexToColumn(getLastActiveColumnNumber(2, proverSheet) - 1)}`,
+    )
+    .clearContent();
 }
 
 function showPicker() {
@@ -40,55 +88,134 @@ function showPicker() {
   }
 }
 
-function loadProgram(program: any) {
-  programSheet.getRange("A2:G").clearContent();
-  proverSheet.getRange("A3:G").clearContent();
+function loadProgram(
+  programStringified: any,
+  selectedRunnerMode: string,
+  selectedLayout: string,
+) {
+  let program = JSON.parse(programStringified);
+  let isProofMode: boolean = selectedRunnerMode == "proof";
+  let layout: Layout = layouts[selectedLayout];
+
+  proverSheet
+    .getRange(
+      `${provSegmentsColumn}3:${indexToColumn(getLastActiveColumnNumber(2, proverSheet) - 1)}`,
+    )
+    .clearContent();
+
+  //Program sheet
+  programSheet
+    .getRange(
+      `${progBytecodeColumn}2:${indexToColumn(getLastActiveColumnNumber(1, programSheet) - 1)}`,
+    )
+    .clearContent();
+
+  programSheet
+    .getRange(`${progDecInstructionColumn}1`)
+    .setValue("Decimal instruction");
+  programSheet
+    .getRange(`${progDstOffsetColumn}1:${progOp1OffsetColumn}1`)
+    .setValues([["Dst Offset", "Op0 Offset", "Op1 Offset"]]);
+  for (let flagIndex = 0; flagIndex < 16; flagIndex++) {
+    programSheet
+      .getRange(
+        `${indexToColumn(columnToIndex(progOp1OffsetColumn) + flagIndex + 1)}1`,
+      )
+      .setValue(`f_${flagIndex}`);
+  }
+
   const bytecode: string[] = program.data;
   let isConstant: boolean = false;
   for (var i = 0; i < bytecode.length; i++) {
     programSheet
-      .getRange(`A${i + 2}:B${i + 2}`)
+      .getRange(`${progBytecodeColumn}${i + 2}:${progOpcodeColumn}${i + 2}`)
       .setValues([
         [
           bytecode[i],
           isConstant
-            ? `=TO_SIGNED_INTEGER(A${i + 2})`
-            : `=DECODE_INSTRUCTION(A${i + 2})`,
+            ? `=TO_SIGNED_INTEGER(${progBytecodeColumn}${i + 2})`
+            : `=DECODE_INSTRUCTION(${progBytecodeColumn}${i + 2})`,
         ],
       ]);
+    programSheet
+      .getRange(`${progDstOffsetColumn}${i + 2}`)
+      .setFormula(`=GET_FLAGS_AND_OFFSETS(${progBytecodeColumn}${i + 2})`);
+    programSheet
+      .getRange(`${progDecInstructionColumn}${i + 2}`)
+      .setValue(BigInt(bytecode[i]).toString(10));
     if (!isConstant) {
       isConstant = size(decodeInstruction(BigInt(bytecode[i]))) == 2;
     } else {
       isConstant = false;
     }
   }
 
-  runSheet.getRange("A1:O").clearContent();
-  runSheet
-    .getRange(`${pcColumn}1:${executionColumn}1`)
-    .setValues([["PC", "FP", "AP", "Opcode", "Dst", "Src", "Execution"]]);
-  const builtinsList: string[] = program.builtins;
-  const segmentAddresses: string[] = initializeSegments(builtinsList);
-  const mainOffset: string | number =
-    program["identifiers"]["__main__.main"]["pc"];
-  runSheet.getRange(`${pcColumn}2`).setValue(mainOffset);
-  runSheet.getRange(`${apColumn}2`).setValue(segmentAddresses.length);
-  runSheet.getRange(`${fpColumn}2`).setFormula(`=${apColumn}2`);
+  //Store complementary data (builtins, initial and final pc, proofMode, layout)
+  //to avoid loosing it when reloading the page for instance.
+  let lastActiveRowProgram: number = getLastActiveRowNumber(
+    progBytecodeColumn,
+    programSheet,
+  );
+  let rowOffset: number = lastActiveRowProgram + 3; //3 offset is arbitrary
+  programSheet.getRange(rowOffset, 1).setValue("Complementary information");
+  //programSheet.getRange(rowOffset,1,rowOffset,2).mergeAcross();
+  rowOffset++;
+  programSheet.getRange(rowOffset, 1).setValue("proof_mode");
+  programSheet.getRange(rowOffset, 2).setValue(isProofMode ? 1 : 0);
+  rowOffset++;
+  programSheet.getRange(rowOffset, 1).setValue("used_builtins");
+  programSheet
+    .getRange(rowOffset, 2, program.builtins.length)
+    .setValues(program.builtins.map((builtin) => [builtin]));
+  rowOffset += program.builtins.length;
+  programSheet.getRange(rowOffset, 1).setValue("initial_pc");
+  programSheet
+    .getRange(rowOffset, 2)
+    .setValue(
+      program["identifiers"][`__main__.${isProofMode ? "__start__" : "main"}`][
+        "pc"
+      ],
+    );
+  rowOffset++;
+  programSheet.getRange(rowOffset, 1).setValue(FINAL_PC);
+  rowOffset++;
+  programSheet.getRange(rowOffset, 1).setValue("initial_ap");
+  rowOffset++;
+  programSheet.getRange(rowOffset, 1).setValue("layout");
+  programSheet.getRange(rowOffset, 2).setValue(selectedLayout);
+  rowOffset++;
+
+  //Run sheet
   runSheet
     .getRange(
-      `${executionColumn}2:${executionColumn}${segmentAddresses.length + 1}`,
+      `${pcColumn}1:${indexToColumn(getLastActiveColumnNumber(1, runSheet) - 1)}`,
     )
-    .setValues(segmentAddresses.map((address) => [address]));
+    .clearContent();
+  runSheet
+    .getRange(`${pcColumn}1:${executionColumn}1`)
+    .setValues([
+      ["PC", "FP", "AP", "Opcode", "Dst", "Res", "Op0", "Op1", "Execution"],
+    ]);
+
+  initializeProgram(program, isProofMode, layout);
 }
 
 function relocate() {
-  proverSheet.getRange(`A3:${columns[k]}`).clearContent();
+  proverSheet
+    .getRange(
+      `${provSegmentsColumn}3:${indexToColumn(getLastActiveColumnNumber(2, proverSheet) - 1)}`,
+    )
+    .clearContent();
 
-  proverSheet.getRange("A1").setValue("Memory");
-  proverSheet.getRange(`A1:D1`).mergeAcross();
+  proverSheet.getRange(`${provSegmentsColumn}1`).setValue("Memory");
+  proverSheet
+    .getRange(`${provSegmentsColumn}1:${provMemoryRelocatedColumn}1`)
+    .mergeAcross();
 
-  proverSheet.getRange(`E1`).setValue("Relocated Trace");
-  proverSheet.getRange(`E1:G1`).mergeAcross();
+  proverSheet.getRange(`${provRelocatedPcColumn}1`).setValue("Relocated Trace");
+  proverSheet
+    .getRange(`${provRelocatedPcColumn}1:${provRelocatedApColumn}1`)
+    .mergeAcross();
 
   proverSheet
     .getRange(`${provSegmentsColumn}2:${provRelocatedApColumn}2`)