feat: Implement DAP protocol in Nargo (#3627)

# Description Implements the DAP protocol to allow a tool such as VS.Code to drive the debugger in a Noir binary project. A separate PR for the [VS.Code Noir extension](https://github.com/noir-lang/vscode-noir) will be submitted later. ## Problem Part of #3015 The beginning of this implementation was heavily inspired by @dmvict [implementation](#3094) of an alternative debugger for Noir programs. ## Summary This PR implements a new `nargo` subcommand `dap`. This starts a DAP server in single session mode through stdin/stdout and waits for a launch request. Using the arguments in the launch request (`projectFolder`, and optionally `package` and `proverName`) it compiles the Noir binary package and starts it in debug mode. Through DAP requests, a tool can then step through the program, set breakpoints and list the generated opcodes using a disassemble request. ## Additional Context ## Documentation Check one: - [ ] No documentation needed. - [ ] Documentation included in this PR. - [X] **[Exceptional Case]** Documentation to be submitted in a separate PR. # PR Checklist\* - [X] I have tested the changes locally. - [X] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings. --------- Co-authored-by: Tom French <[email protected]>
noir-lang · Dec 19, 2023 · 13834d4 · 13834d4
1 parent 1886e0f
commit 13834d4
Show file tree

Hide file tree

Showing 10 changed files with 1,017 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -93,6 +93,8 @@ gloo-utils = { version = "0.1", features = ["serde"] }
 js-sys = "0.3.62"
 getrandom = "0.2"
 
+# Debugger
+dap = "0.4.1-alpha1"
 
 cfg-if = "1.0.0"
 clap = { version = "4.3.19", features = ["derive", "env"] }

diff --git a/tooling/debugger/Cargo.toml b/tooling/debugger/Cargo.toml
@@ -13,7 +13,11 @@ acvm.workspace = true
 nargo.workspace = true
 noirc_printable_type.workspace = true
 noirc_errors.workspace = true
+noirc_driver.workspace = true
+fm.workspace = true
 thiserror.workspace = true
 codespan-reporting.workspace = true
+dap.workspace = true
 easy-repl = "0.2.1"
 owo-colors = "3"
+serde_json.workspace = true
diff --git a/tooling/debugger/src/context.rs b/tooling/debugger/src/context.rs
@@ -87,6 +87,109 @@ impl<'a, B: BlackBoxFunctionSolver> DebugContext<'a, B> {
             .and_then(|location| self.debug_artifact.debug_symbols[0].opcode_location(location))
     }
 
+    fn get_opcodes_sizes(&self) -> Vec<usize> {
+        self.get_opcodes()
+            .iter()
+            .map(|opcode| match opcode {
+                Opcode::Brillig(brillig_block) => brillig_block.bytecode.len(),
+                _ => 1,
+            })
+            .collect()
+    }
+
+    /// Offsets the given location by the given number of opcodes (including
+    /// Brillig opcodes). If the offset would move the location outside of a
+    /// valid circuit location, returns None and the number of remaining
+    /// opcodes/instructions left which span outside the valid range in the
+    /// second element of the returned tuple.
+    pub(super) fn offset_opcode_location(
+        &self,
+        location: &Option<OpcodeLocation>,
+        mut offset: i64,
+    ) -> (Option<OpcodeLocation>, i64) {
+        if offset == 0 {
+            return (*location, 0);
+        }
+        let Some(location) = location else {
+            return (None, offset);
+        };
+
+        let (mut acir_index, mut brillig_index) = match location {
+            OpcodeLocation::Acir(acir_index) => (*acir_index, 0),
+            OpcodeLocation::Brillig { acir_index, brillig_index } => (*acir_index, *brillig_index),
+        };
+        let opcode_sizes = self.get_opcodes_sizes();
+        if offset > 0 {
+            while offset > 0 {
+                let opcode_size = opcode_sizes[acir_index] as i64 - brillig_index as i64;
+                if offset >= opcode_size {
+                    acir_index += 1;
+                    offset -= opcode_size;
+                    brillig_index = 0;
+                } else {
+                    brillig_index += offset as usize;
+                    offset = 0;
+                }
+                if acir_index >= opcode_sizes.len() {
+                    return (None, offset);
+                }
+            }
+        } else {
+            while offset < 0 {
+                if brillig_index > 0 {
+                    if brillig_index > (-offset) as usize {
+                        brillig_index -= (-offset) as usize;
+                        offset = 0;
+                    } else {
+                        offset += brillig_index as i64;
+                        brillig_index = 0;
+                    }
+                } else {
+                    if acir_index == 0 {
+                        return (None, offset);
+                    }
+                    acir_index -= 1;
+                    let opcode_size = opcode_sizes[acir_index] as i64;
+                    if opcode_size <= -offset {
+                        offset += opcode_size;
+                    } else {
+                        brillig_index = (opcode_size + offset) as usize;
+                        offset = 0;
+                    }
+                }
+            }
+        }
+        if brillig_index > 0 {
+            (Some(OpcodeLocation::Brillig { acir_index, brillig_index }), 0)
+        } else {
+            (Some(OpcodeLocation::Acir(acir_index)), 0)
+        }
+    }
+
+    pub(super) fn render_opcode_at_location(&self, location: &Option<OpcodeLocation>) -> String {
+        let opcodes = self.get_opcodes();
+        match location {
+            None => String::from("invalid"),
+            Some(OpcodeLocation::Acir(acir_index)) => {
+                let opcode = &opcodes[*acir_index];
+                if let Opcode::Brillig(ref brillig) = opcode {
+                    let first_opcode = &brillig.bytecode[0];
+                    format!("BRILLIG {first_opcode:?}")
+                } else {
+                    format!("{opcode:?}")
+                }
+            }
+            Some(OpcodeLocation::Brillig { acir_index, brillig_index }) => {
+                if let Opcode::Brillig(ref brillig) = opcodes[*acir_index] {
+                    let opcode = &brillig.bytecode[*brillig_index];
+                    format!("      | {opcode:?}")
+                } else {
+                    String::from("      | invalid")
+                }
+            }
+        }
+    }
+
     fn step_brillig_opcode(&mut self) -> DebugCommandResult {
         let Some(mut solver) = self.brillig_solver.take() else {
             unreachable!("Missing Brillig solver");
@@ -311,6 +414,10 @@ impl<'a, B: BlackBoxFunctionSolver> DebugContext<'a, B> {
         self.breakpoints.iter()
     }
 
+    pub(super) fn clear_breakpoints(&mut self) {
+        self.breakpoints.clear();
+    }
+
     pub(super) fn is_solved(&self) -> bool {
         matches!(self.acvm.get_status(), ACVMStatus::Solved)
     }
@@ -327,7 +434,10 @@ mod tests {
 
     use acvm::{
         acir::{
-            circuit::brillig::{Brillig, BrilligInputs, BrilligOutputs},
+            circuit::{
+                brillig::{Brillig, BrilligInputs, BrilligOutputs},
+                opcodes::BlockId,
+            },
             native_types::Expression,
         },
         brillig_vm::brillig::{
@@ -535,4 +645,116 @@ mod tests {
         assert!(matches!(result, DebugCommandResult::Done));
         assert_eq!(context.get_current_opcode_location(), None);
     }
+
+    #[test]
+    fn test_offset_opcode_location() {
+        let blackbox_solver = &StubbedSolver;
+        let opcodes = vec![
+            Opcode::Brillig(Brillig {
+                inputs: vec![],
+                outputs: vec![],
+                bytecode: vec![BrilligOpcode::Stop, BrilligOpcode::Stop, BrilligOpcode::Stop],
+                predicate: None,
+            }),
+            Opcode::MemoryInit { block_id: BlockId(0), init: vec![] },
+            Opcode::Brillig(Brillig {
+                inputs: vec![],
+                outputs: vec![],
+                bytecode: vec![BrilligOpcode::Stop, BrilligOpcode::Stop, BrilligOpcode::Stop],
+                predicate: None,
+            }),
+            Opcode::AssertZero(Expression::default()),
+        ];
+        let circuit = Circuit { opcodes, ..Circuit::default() };
+        let debug_artifact =
+            DebugArtifact { debug_symbols: vec![], file_map: BTreeMap::new(), warnings: vec![] };
+        let context = DebugContext::new(
+            blackbox_solver,
+            &circuit,
+            &debug_artifact,
+            WitnessMap::new(),
+            Box::new(DefaultForeignCallExecutor::new(true)),
+        );
+
+        assert_eq!(context.offset_opcode_location(&None, 0), (None, 0));
+        assert_eq!(context.offset_opcode_location(&None, 2), (None, 2));
+        assert_eq!(context.offset_opcode_location(&None, -2), (None, -2));
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 0),
+            (Some(OpcodeLocation::Acir(0)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 1),
+            (Some(OpcodeLocation::Brillig { acir_index: 0, brillig_index: 1 }), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 2),
+            (Some(OpcodeLocation::Brillig { acir_index: 0, brillig_index: 2 }), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 3),
+            (Some(OpcodeLocation::Acir(1)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 4),
+            (Some(OpcodeLocation::Acir(2)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 5),
+            (Some(OpcodeLocation::Brillig { acir_index: 2, brillig_index: 1 }), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 7),
+            (Some(OpcodeLocation::Acir(3)), 0)
+        );
+        assert_eq!(context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 8), (None, 0));
+        assert_eq!(context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), 20), (None, 12));
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(1)), 2),
+            (Some(OpcodeLocation::Brillig { acir_index: 2, brillig_index: 1 }), 0)
+        );
+        assert_eq!(context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), -1), (None, -1));
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(0)), -10),
+            (None, -10)
+        );
+
+        assert_eq!(
+            context.offset_opcode_location(
+                &Some(OpcodeLocation::Brillig { acir_index: 0, brillig_index: 1 }),
+                -1
+            ),
+            (Some(OpcodeLocation::Acir(0)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(
+                &Some(OpcodeLocation::Brillig { acir_index: 0, brillig_index: 2 }),
+                -2
+            ),
+            (Some(OpcodeLocation::Acir(0)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(1)), -3),
+            (Some(OpcodeLocation::Acir(0)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(2)), -4),
+            (Some(OpcodeLocation::Acir(0)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(
+                &Some(OpcodeLocation::Brillig { acir_index: 2, brillig_index: 1 }),
+                -5
+            ),
+            (Some(OpcodeLocation::Acir(0)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(3)), -7),
+            (Some(OpcodeLocation::Acir(0)), 0)
+        );
+        assert_eq!(
+            context.offset_opcode_location(&Some(OpcodeLocation::Acir(2)), -2),
+            (Some(OpcodeLocation::Brillig { acir_index: 0, brillig_index: 2 }), 0)
+        );
+    }
 }